modding:xml:dockscreen
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
modding:xml:dockscreen [2012/06/30 17:46] – rpc | modding:xml:dockscreen [2017/10/24 06:48] (current) – nms | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | [[DockScreen Talk Page|Discuss this page]]. | ||
+ | =====Summary===== | ||
+ | * < | ||
+ | * **unid=** | ||
+ | * **name=** | ||
+ | * " | ||
+ | * **desc=** | ||
+ | * **type=** | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **inherit=** | ||
+ | * **backgroundID=** | ||
+ | * UNID | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **nestedScreen=** | ||
+ | * Zero or one < | ||
+ | * **dataFrom=** | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **criteria=** | ||
+ | * **list=** | ||
+ | * **initialItem=** | ||
+ | * index of an item as it appears in the list | ||
+ | * " | ||
+ | * **rowHeight=** | ||
+ | * **noArmorSpeedDisplay=** | ||
+ | * **slotName=** | ||
+ | * **noEmptySlots=** | ||
+ | * **posX=** | ||
+ | * **posY=** | ||
+ | * **width=** | ||
+ | * **height=** | ||
+ | * Code: Returns a list of entries, each with the following elements | ||
+ | * Title | ||
+ | * Icon | ||
+ | * Description | ||
+ | * [Extra] | ||
+ | * Zero or one < | ||
+ | * **gScreen** | ||
+ | * **gSource** | ||
+ | * **gData** | ||
+ | * Zero or one < | ||
+ | * **gScreen** | ||
+ | * **gSource** | ||
+ | * **gData** | ||
+ | * Zero or one < | ||
+ | * Zero or one < | ||
+ | * **display=** | ||
+ | * **animate=** | ||
+ | * **type=** Same as < | ||
+ | * **dataFrom=** | ||
+ | * Zero or one < | ||
+ | * Zero or more < | ||
+ | * **left=** | ||
+ | * **top=** | ||
+ | * **width=** | ||
+ | * **height=** | ||
+ | * **center=** | ||
+ | * **vcenter=** | ||
+ | * Zero or more < | ||
+ | * **id=** | ||
+ | * **left=** | ||
+ | * **right=** | ||
+ | * **top=** | ||
+ | * **bottom=** | ||
+ | * **font=** | ||
+ | * **color=** | ||
+ | * **align=** | ||
+ | * Zero or more < | ||
+ | * **left=** | ||
+ | * **right=** | ||
+ | * **top=** | ||
+ | * **bottom=** | ||
+ | * **align=** Horizontal alignment. Defaults to the left | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **valign=** Vertical alignment. Defaults to the top | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **transparent=** | ||
+ | * Returns: An image desc | ||
+ | * < | ||
+ | * **left=** | ||
+ | * **right=** | ||
+ | * **top=** | ||
+ | * **bottom=** | ||
+ | * One < | ||
+ | * One < | ||
+ | * **layout=** | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **desc=** | ||
+ | * **noListNavigation=** | ||
+ | * **showCounter=** | ||
+ | * " | ||
+ | * **showTextInput=** | ||
+ | * " | ||
+ | * Zero or one < | ||
+ | * < | ||
+ | * < | ||
+ | * **id=** | ||
+ | * **style=** | ||
+ | * " | ||
+ | * " | ||
+ | * < | ||
+ | * **id=** | ||
+ | * **style=** | ||
+ | * < | ||
+ | * **id=** | ||
+ | * **style=** | ||
+ | * < | ||
+ | * **id=** | ||
+ | * **style=** | ||
+ | * < | ||
+ | * **id=** | ||
+ | * **style=** | ||
+ | * < | ||
+ | * One or more < | ||
+ | * **name=** | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * "> | ||
+ | * "< | ||
+ | * **id=** The **id** of the < | ||
+ | * **descID=** | ||
+ | * **prevKey=** Binds Up/Left arrow keys | ||
+ | * " | ||
+ | * " | ||
+ | * **nextKey=** Binds Down/Right arrow keys | ||
+ | * " | ||
+ | * " | ||
+ | * **default=** Binds the Enter key. Same as **key=" | ||
+ | * " | ||
+ | * " | ||
+ | * **cancel=** Binds the Escape key. Same as **key=" | ||
+ | * " | ||
+ | * " | ||
+ | * **key=** Binds the specified key to the action | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
+ | * **minor=** | ||
+ | * Zero or one < | ||
+ | * Zero or one < | ||
+ | * **screen=** | ||
+ | * Zero or one < | ||
+ | * **pane=** | ||
+ | * Code | ||
+ | * Zero or more additional panes | ||
+ | [[https:// | ||
+ | [[https:// | ||
+ | ====Rich Text Formatting==== | ||
+ | |||
+ | |||
+ | FIXME Please correct any inaccuracies. | ||
+ | |||
+ | ===< | ||
+ | |||
+ | Dockscreens are powerful tools which can be used to display information to the player. When you dock with a station or wreck, what you are seeing is a dockscreen. Dockscreens can be used to play out a story, show data, and allow the player to trigger scripted events. | ||
+ | |||
+ | From the [[http:// | ||
+ | <code XML> | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | <* Attributes=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | A dockscreen' | ||
+ | <code XML> | ||
+ | < | ||
+ | |||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | That code is from [[..: | ||
+ | |||
+ | [[modding: | ||
+ | |||
+ | The < | ||
+ | 1. Whenever the pane is displayed (e.g., ([[..: | ||
+ | 2. Whenever the player moves the cursor in the list. | ||
+ | |||
+ | ===Sub elements, attributes and globals=== | ||
+ | |||
+ | The following are temporary [[..: | ||
+ | |||
+ | * gBuyCriteria | ||
+ | * gCost | ||
+ | * gItem | ||
+ | * gMargin | ||
+ | |||
+ | Example | ||
+ | |||
+ | Here we see gMargin used within the ListOptions element in the dockscreen dsExchangeBuy from Transcendence.xml | ||
+ | |||
+ | <code xml> | ||
+ | dataFrom= | ||
+ | list= " | ||
+ | > | ||
+ | | ||
+ | (not gMargin) | ||
+ | | ||
+ | |||
+ | (isfunction gMargin) | ||
+ | | ||
+ | |||
+ | (scrSetListFilter gScreen " | ||
+ | ) | ||
+ | </ | ||
+ | |||
+ | * gPrevScreen | ||
+ | * gPrevPane | ||
+ | * gBonus | ||
+ | === List Options === | ||
+ | [[modding/ | ||
+ | Go back to list of [[..: |