This wiki is archived from 2021-09-05

User Interface Modding: Difference between revisions

From Planetary Annihilation: TITANS and Classic PA Wiki
Jump to navigation Jump to search
(Created page with "Category:Modding = 50px Planetary Annihilation User Interface Modding = {{User Interface Technologies}}")
 
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Modding]]
[[Category:Modding]]
= [[File:Titans-icon.png|50px]] Planetary Annihilation User Interface 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.
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 user interface scene|armory]]
* [[building_planets user interface scene|planets]]
* [[community_mods user interface scene|community_mods]] (NEW)
* [[connect_to_game user interface scene|connect_to_game]]
* [[galactic_war user interface scene|galactic_war]]
* [[game_over user interface scene|game_over]] (loaded by live_game so technically should be under live_game)
* [[gamestats user interface scene|gamestats]] (loaded by live_game so technically should be under live_game)
* [[guide user interface scene|guide]]
* [[leaderboard user interface scene|leaderboard]]
** [[shared_build|shared_build]]
* [[live_game user interface scene|live_game]]
* [[load_planet user interface scene|load_planet]]
* [[match_making user interface scene|match_making]]
* [[new_game user interface scene|new_game]]
* [[replay_browser user interface scene|replay_browser]]
* [[replay_loading user interface scene|replay_loading]]
* [[save_game_browser user interface scene|save_game_browser]]
* [[server_browser user interface scene|server_browser]]
* [[settings user interface scene|settings]]
* [[social user interface scene|social]] (unused)
* [[start user interface scene|start]]
* [[system_editor user interface scene|system_editor]]
* [[transit user interface scene|transit]]
There are also two special hidden atlas scenes:
* [[icon_atlas scene|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)
* 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:

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)

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)
Retrieved from "https://wiki.palobby.com/w/index.php?title=User_Interface_Modding&oldid=3532"