Data-driven Windows
Open Rails has multiple in-game windows:
F1 F4 F5 F8 F10 F9 0 Alt+F9 Shift+F9
Some of these (F4 F5 Shift+F9) have been re-created on a browser using the web-server API.
This proposal is to specify the design of the window and, separately, the data to be displayed in each window. The aim is that any change to a window is available straight away in-game and on the browser.
The in-game window takes the data specifying the design of the window and the values to be displayed in it and presents the window in-game.
From 2 APIs, the browser takes the same data and a script in the browser lays out the window and populates it. The script is common to all the windows.
Blueprint information
- Status:
- Not started
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- cjakeman
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- New
- Series goal:
- None
- Implementation:
-
Unknown
- Milestone target:
- None
- Started by
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
Work Items
Work items:
Refactoring - The data values shown in the in-game windows should be assembled independently and then provided to the in-game window or to a Web API: TODO
Design Specification - The design of the windows is to be specified in a data structure which can provide the elements already in use in-game: TODO
Scripting - A JavaScript method to take any design specification and populate an HTML page with the element of the design: TODO
Scripting - A JavaScript method to take any data values and populate the fields of the design: TODO
