TitleBar Script: Difference between revisions
No edit summary |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 12: | Line 12: | ||
|Fields Finalized? | |Fields Finalized? | ||
|Yes | |Yes | ||
|- | |||
|Where Used: | |||
|[[Portal Element (Data)|Portals]] | |||
|- | |||
|Procedure Use: | |||
|"titlebar" type, "entity" context, "container" context | |||
|- | |- | ||
|} | |} | ||
| Line 19: | Line 25: | ||
:{| class="infotable" | :{| class="infotable" | ||
|class="leftnormal"|text | |class="leftnormal"|text | ||
|Entry: Contains the default text to display ("Choose an Item from the List Below").<br> | |(String) Entry: Contains the default text to display ("Choose an Item from the List Below").<br> | ||
Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text|encoding]]. | Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain [[Encoded Text|encoding]]. | ||
|- | |- | ||
Latest revision as of 08:56, 20 February 2009
Context: HL Kit … Kit Reference … Script Types
Technical Details
Initial Context: Container Alternate Context: None Fields Finalized? Yes Where Used: Portals Procedure Use: "titlebar" type, "entity" context, "container" context
The TitleBar script utilizes the following special symbols:
text (String) Entry: Contains the default text to display ("Choose an Item from the List Below").
Exit: Contains the text to be displayed to the user to prompt selection. The final text may contain encoding.
Description
The TitleBar script is only used within portals that display a choose form where the user can select an item. At the top of the choose form is a title bar that contains a prompt, directing the user to select an item from the list presented. This script allows an author to specify the exact text to be displayed at the top of the selection table, making it possible to remind the user of the context being selected or how many selections remain.
NOTE! The TitleBar script is read-only. Within this script, virtually all aspects of the structural hierarchy can be accessed, but nothing can be changed.
Example
When displaying selections where the user can select multiple items, it's helpful to inform the user how many choices remain. This can be easily achieved by a script like the one below.
@text = "Add a Special Ablity - " & hero.child[resAbility].field[resSummary].text
