This wiki is archived from 2021-09-05
User Interface Modding: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Modding]] | [[Category:Modding]] | ||
= | = Planetary Annihilation User Interface Modding = | ||
{{User Interface Technologies}} | {{User Interface Technologies}} | ||
== | == PA User Interface Scenes and Panels == | ||
The PA user interface is web based using an in-game browser provided by Coherent UI 2 that interacts with the PA engine. | The PA user interface is web based using an in-game browser provided by Coherent UI 2 that interacts with the PA engine. | ||
| Line 29: | Line 29: | ||
* [[guide user interface scene|guide]] | * [[guide user interface scene|guide]] | ||
* [[leaderboard user interface scene|leaderboard]] | * [[leaderboard user interface scene|leaderboard]] | ||
** [[shared_build|shared_build]] | |||
* [[live_game user interface scene|live_game]] | * [[live_game user interface scene|live_game]] | ||
* [[load_planet user interface scene|load_planet]] | * [[load_planet user interface scene|load_planet]] | ||
| Line 48: | Line 49: | ||
* [[special_icon_atlas scene|special_icon_atlas]] | * [[special_icon_atlas scene|special_icon_atlas]] | ||
== | == PA User Interface Modding Guidelines == | ||
* no remote loading (no longer needed now that we have auto updating) | * no remote loading (no longer needed now that we have auto updating) | ||
* do not use global scenes unless absolutely needed (avoid loading unneeded code into every UI scene) | * do not use global scenes unless absolutely needed (avoid loading unneeded code into every UI scene) | ||
Latest revision as of 11:25, 9 September 2021
Planetary Annihilation User Interface Modding
The Planetary Annihilation User Interface (UI) is based on the following technologies:
- Javascript
- HTML5
- Coherent UI 2.x by Coherent Labs
- Chromium by Google
- Planetary Annihilation engine
PA User Interface Scenes and Panels
The PA user interface is web based using an in-game browser provided by Coherent UI 2 that interacts with the PA engine.
Each HTML page is loaded as a scene under the following fixed hierarchy:
- main
- game > start, server_browser, etc
- uberbar
Each scene can also load other scenes as panels (similar to an iFrame as they do not share session storage).
eg the game and uberbar scenes are loaded as panels by main.
The game scene defaults to the start scene and this changes as the user navigates between the following: (listed in alphabetical order)
- armory
- planets
- community_mods (NEW)
- connect_to_game
- galactic_war
- game_over (loaded by live_game so technically should be under live_game)
- gamestats (loaded by live_game so technically should be under live_game)
- guide
- leaderboard
- live_game
- load_planet
- match_making
- new_game
- replay_browser
- replay_loading
- save_game_browser
- server_browser
- settings
- social (unused)
- start
- system_editor
- transit
There are also two special hidden atlas scenes:
PA User Interface Modding Guidelines
- no remote loading (no longer needed now that we have auto updating)
- do not use global scenes unless absolutely needed (avoid loading unneeded code into every UI scene)