OBD:File types/Interface: Difference between revisions

From OniGalore
Jump to navigation Jump to search
(forgot about IGHH and KeyI; added a little more explanation)
(added List section; broke out hierarchies into more distinct trees)
 
Line 1: Line 1:
These are the files that Oni uses to present content in either the in-game user interface ([[Data Comlink]] and text consoles) or out-of-game user interface (windows and dialogs). These interfaces are sometimes called IGUI and OGUI for short.
These are the files that Oni uses to present content in either the in-game user interface ([[Data Comlink]] and text consoles) or out-of-game user interface (windows and dialogs). These interfaces are sometimes called IGUI and OGUI for short.


==Comlink, console pages==
==Hierarchy==
This section shows the interface-related resources as a hierarchy of linked resources. These trees do show some file types that are technically [[OBD:File types/General|General]] files, not Interface files; see the {{SectionLink||List}} for a stricter list of types classified as Interface.
 
===Comlink, console pages===
{{Tree list}}
{{Tree list}}
*[[OBD:DPge]] (Diary page)
*[[OBD:DPge]] (Diary page)
**IGPG (broken down in next section)
**IGPG (broken down in {{SectionLink||IGPG}})
**[[OBD:KeyI|KeyI]] (indirectly; optional, never used)
**[[OBD:KeyI|KeyI]] (indirectly; optional, never used)
***[[OBD:TXMP|TXMP]]
***[[OBD:TXMP|TXMP]]
{{Tree list/end}}
{{Tree list}}
*[[OBD:HPge]] (Help page; only one instance of this type, shown under the Help tab of the Data Comlink)
*[[OBD:HPge]] (Help page; only one instance of this type, shown under the Help tab of the Data Comlink)
**IGPG
**IGPG
{{Tree list/end}}
{{Tree list}}
*[[OBD:IGHH|IGHH]] (IGUI HUD) (only one instance of this type, used to provide the labels on the HUD when viewing the Help page)
*[[OBD:IGHH|IGHH]] (IGUI HUD) (only one instance of this type, used to provide the labels on the HUD when viewing the Help page)
**TXMP
**TXMP
{{Tree list/end}}
{{Tree list}}
*[[OBD:IPge]] (Item page)
*[[OBD:IPge]] (Item page)
**IGPG
**IGPG
{{Tree list/end}}
{{Tree list}}
*[[OBD:OPge]] (Objective page)
*[[OBD:OPge]] (Objective page)
**[[OBD:IGPA|IGPA]] (Page Array)
**[[OBD:IGPA|IGPA]] (Page Array)
***IGPG
***IGPG
{{Tree list}}
*[[OBD:WPge]] (Weapon page)
*[[OBD:WPge]] (Weapon page)
**IGPG
**IGPG
{{Tree list/end}}
{{Tree list}}
*[[OBD:TxtC]] (Text console)
*[[OBD:TxtC]] (Text console)
**IGPA (Page Array)
**IGPA (Page Array)
Line 23: Line 49:
{{Tree list/end}}
{{Tree list/end}}


==IGPG==
===IGPG===
{{Tree list}}
{{Tree list}}
*[[OBD:IGPG|IGPG]] (IGUI Page)
*[[OBD:IGPG|IGPG]] (IGUI Page)
Line 38: Line 64:
{{Tree list/end}}
{{Tree list/end}}


==TSFF==
===TSFF===
{{Tree list}}
{{Tree list}}
*[[OBD:TSFF|TSFF]] (Font Family)
*[[OBD:TSFF|TSFF]] (Font Family)
Line 46: Line 72:
{{Tree list/end}}
{{Tree list/end}}


==WMDD==
===WMDD===
{{Tree list}}
{{Tree list}}
*[[OBD:WMDD|WMDD]] (Dialog Data)
*[[OBD:WMDD|WMDD]] (Dialog Data)
Line 60: Line 86:
{{Tree list/end}}
{{Tree list/end}}


==PSUI==
===PSUI===
PSUI stands for Part Specification User Interface. There are two in the game data, and only one is used by the regular game (the other was used in [[Tool mode]]). No file type links to PSUI; it is only called upon by the game code.
PSUI stands for Part Specification User Interface. There are two in the game data, and only one is used by the regular game (the other was used in [[Tool mode]]). No file type links to PSUI; it is only called upon by the game code.
PSpL stands for Part Specification List. There are two in the game data, one for the out-of-game UI and one for the in-game UI. Effectively, they are only used for painting background colors behind the UIs. No file type links to PSpL; it is only called upon by the game code.


{{Tree list}}
{{Tree list}}
Line 69: Line 93:
**[[OBD:PSpc|PSpc]]
**[[OBD:PSpc|PSpc]]
***[[OBD:TXMP|TXMP]]
***[[OBD:TXMP|TXMP]]
{{Tree list/end}}
PSpL stands for Part Specification List. There are two in the game data, one for the out-of-game UI and one for the in-game UI. Effectively, they are only used for painting background colors behind the UIs. No file type links to PSpL; it is only called upon by the game code.
{{Tree list}}
*[[OBD:PSpL|PSpL]]
*[[OBD:PSpL|PSpL]]
**PSPc
**PSPc
***TXMP
***TXMP
{{Tree list/end}}
{{Tree list/end}}
==List==
A stricter list of only what we have grouped under the Interface family of file types.
{|
|
{| class="wikitable"
|-
!Type
!Description
|-
|[[OBD:DPge|DPge]]
|Diary Page
|-
|[[OBD:HPge|HPge]]
|Help Page
|-
|[[OBD:IGHH|IGHH]]
|IGUI HUD Help
|-
|[[OBD:IGPA|IGPA]]
|IGUI Page Array
|-
|[[OBD:IGPG|IGPG]]
|IGUI Page
|-
|[[OBD:IGSA|IGSA]]
|IGUI String Array
|-
|[[OBD:IGSt|IGSt]]
|IGUI String
|-
|[[OBD:IPge|IPge]]
|Item Page
|-
|[[OBD:KeyI|KeyI]]
|Key Icons
|-
|[[OBD:OPge|OPge]]
|Objective Page
|-
|[[OBD:PSpc|PSpc]]
|Part Specification
|-
|[[OBD:PSpL|PSpL]]
|Part Specification List
|}
|
{| class="wikitable"
|-
!Type
!Description
|-
|[[OBD:PSUI|PSUI]]
|Part Specifications UI
|-
|[[OBD:SUBT|SUBT]]
|Subtitle Array
|-
|[[OBD:TSFF|TSFF]]
|Font Family
|-
|[[OBD:TSFL|TSFL]]
|Font Language
|-
|[[OBD:TSFT|TSFT]]
|Font
|-
|[[OBD:TSGA|TSGA]]
|Glyph Array
|-
|[[OBD:TxtC|TxtC]]
|Text Console
|-
|[[OBD:WMCL|WMCL]]
|WM Cursor List
|-
|[[OBD:WMDD|WMDD]]
|WM Dialog Data
|-
|[[OBD:WMM|WMM_]]
|WM Menu
|-
|[[OBD:WMMB|WMMB]]
|WM Menu Bar
|-
|[[OBD:WPge|WPge]]
|Weapon Page
|}


{{OBD}}
{{OBD}}

Latest revision as of 20:13, 9 December 2023

These are the files that Oni uses to present content in either the in-game user interface (Data Comlink and text consoles) or out-of-game user interface (windows and dialogs). These interfaces are sometimes called IGUI and OGUI for short.

Hierarchy

This section shows the interface-related resources as a hierarchy of linked resources. These trees do show some file types that are technically General files, not Interface files; see the § List for a stricter list of types classified as Interface.

Comlink, console pages


  • OBD:HPge (Help page; only one instance of this type, shown under the Help tab of the Data Comlink)
    • IGPG


  • IGHH (IGUI HUD) (only one instance of this type, used to provide the labels on the HUD when viewing the Help page)
    • TXMP





  • OBD:TxtC (Text console)
    • IGPA (Page Array)
      • IGPG

IGPG

  • IGPG (IGUI Page)
    • TSFF (broken down in next section)
    • PSpc
    • or TXMP
    • IGSA (main content)
    • IGSA (hint/notes)
      • IGSt
        • TSFF

TSFF

  • TSFF (Font Family)
    • TSFL (Font Language)
    • TSFT (Font) (contains actual glyph data)
      • TSGA (Glyph Array) (lists glyph data offsets)

WMDD

  • WMDD (Dialog Data)
    • for Picture elements:
    • TXMP
    • or TXMB
      • TXMP
    • or PSpc
      • TXMP
    • for Popup menu elements:
    • WMM_
    • TSFF (broken down in previous section)

PSUI

PSUI stands for Part Specification User Interface. There are two in the game data, and only one is used by the regular game (the other was used in Tool mode). No file type links to PSUI; it is only called upon by the game code.


PSpL stands for Part Specification List. There are two in the game data, one for the out-of-game UI and one for the in-game UI. Effectively, they are only used for painting background colors behind the UIs. No file type links to PSpL; it is only called upon by the game code.

List

A stricter list of only what we have grouped under the Interface family of file types.

Type Description
DPge Diary Page
HPge Help Page
IGHH IGUI HUD Help
IGPA IGUI Page Array
IGPG IGUI Page
IGSA IGUI String Array
IGSt IGUI String
IPge Item Page
KeyI Key Icons
OPge Objective Page
PSpc Part Specification
PSpL Part Specification List
Type Description
PSUI Part Specifications UI
SUBT Subtitle Array
TSFF Font Family
TSFL Font Language
TSFT Font
TSGA Glyph Array
TxtC Text Console
WMCL WM Cursor List
WMDD WM Dialog Data
WMM_ WM Menu
WMMB WM Menu Bar
WPge Weapon Page