mirror of
https://github.com/bilawalsidhu/gods-eye-view.git
synced 2026-11-18 09:12:18 +00:00
docs(application): the locale and rail path exports and the Rail and Transit read APIs are experimental
Says so where the cockpit subject section names them, together with path.line, and that a snapshot read again while nothing changed is the one read before, so a provider may read one on every update.
This commit is contained in:
1 parent
a17346be6f
commit
557fe7169a
1 file changed
+7
-1
+7
-1
@@ -306,7 +306,13 @@ Rail layer's pure path module (`createRailPath`, `pointAtS`, `projectOnPath`)
|
|||||||
for a provider placing a train along its line. The frame, HUD view and
|
for a provider placing a train along its line. The frame, HUD view and
|
||||||
candidate fields are documented in `src/cockpitSubjectProviders.js`; the Rail
|
candidate fields are documented in `src/cockpitSubjectProviders.js`; the Rail
|
||||||
and Transit read APIs in `src/layers/rail/cockpitSubject.js` and
|
and Transit read APIs in `src/layers/rail/cockpitSubject.js` and
|
||||||
`src/layers/transit/cockpitSubject.js`.
|
`src/layers/transit/cockpitSubject.js`. A snapshot read again while nothing in
|
||||||
|
it changed is the one read before, so `read` may take one on every update; a
|
||||||
|
train's `path.line` is a frozen copy of its line, for `pointAtS` and
|
||||||
|
`projectOnPath`. The `i18n/locale` and `layers/rail/paths` exports and the
|
||||||
|
Rail and Transit read APIs (`getSelectedTrain`, `getSelectedVehicle`,
|
||||||
|
`getCockpitSubject` and the snapshots they return, `path.line` among them)
|
||||||
|
are experimental and may change without notice.
|
||||||
|
|
||||||
A candidate's `selectedAt` is a token that changes each time the user selects
|
A candidate's `selectedAt` is a token that changes each time the user selects
|
||||||
the subject, even the same one again, so entry takes it first. The Rail and
|
the subject, even the same one again, so entry takes it first. The Rail and
|
||||||
|
|||||||
Reference in new issue
Block a user