Chosen Script - Revision history

Rob: /* Technical Details */

2009-02-20T08:54:35Z

Technical Details

← Older revision		Revision as of 08:54, 20 February 2009
Line 15:		Line 15:
	\|Where Used:		\|Where Used:
	\|[[Portal Element (Data)\|Portals]]		\|[[Portal Element (Data)\|Portals]]
			\|-
			\|Procedure Use:
			\|None
	\|-		\|-
	\|}		\|}

Rob at 00:16, 16 December 2008

2008-12-16T00:16:50Z

← Older revision		Revision as of 00:16, 16 December 2008
Line 12:		Line 12:
	\|Fields Finalized?		\|Fields Finalized?
	\|Yes		\|Yes
			\|-
			\|Where Used:
			\|[[Portal Element (Data)\|Portals]]
	\|-		\|-
	\|}		\|}

Rob at 12:25, 15 December 2008

2008-12-15T12:25:59Z

← Older revision		Revision as of 12:25, 15 December 2008
Line 19:		Line 19:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|text		\|class="leftnormal"\|text
	\|Entry: Contains the default text to display ("-Please Select-").<br>		\|(String) Entry: Contains the default text to display ("-Please Select-").<br>
	Exit: Contains the text to be displayed to the user as the chosen selection. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user as the chosen selection. The final text may contain [[Encoded Text\|encoding]].
	\|-		\|-
	\|ispick		\|ispick
	\|Entry: Indicates whether the chooser contains a selection or not.<br>		\|(Number) Entry: Indicates whether the chooser contains a selection or not.<br>
	Exit: Ignored.		Exit: Ignored.
	\|}		\|}

Rob: New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

2008-12-12T13:59:12Z

New page: {{context|Kit Reference|Script Types}} ==Technical Details== :{| class="scripttable" |class="leftnormal"|Initial Context: |Pick |- |Alternate Context: |None |- |Fields F...

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

:{| class="scripttable"
|class="leftnormal"|Initial Context:
|[[Pick Context|Pick]]
|-
|Alternate Context:
|None
|-
|Fields Finalized?
|Yes
|-
|}

The Chosen script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|text
|Entry: Contains the default text to display ("-Please Select-").<br>
Exit: Contains the text to be displayed to the user as the chosen selection. The final text may contain [[Encoded Text|encoding]].
|-
|ispick
|Entry: Indicates whether the chooser contains a selection or not.<br>
Exit: Ignored.
|}

==Description==

The Chosen script is essentially a special-purpose [[Label Script|Label script]] used in conjunction with choosers. This script allows you to synthesize the text to be displayed as the current selection within a chooser. If nothing has been selected yet, you can prompt the user to do so, and you can use color-coding to indicate errors with the current selection.

The initial context for the script is the currently selected item. If nothing is selected, the initial context with be invalid, so you're limited to displaying something simple. Aside from that, the Chosen script is a standard Label script.

{{note}} The Chosen script is read-only. Within this script, virtually all aspects of the structural hierarchy can be accessed, but nothing can be changed.

==Example==

Choosers provide an excellent solution when the user must choose exactly one option from an assortment. An excellent example is race, where a character must be assigned a single race. The code below shows the Chosen script for the race chooser within the Skeleton files, including color highlighting when no selection has yet been made.

<pre>
if (@ispick = 0) then
@text = "{text ff0000}Select Race"
else
@text = "Race: " & field[name].text
endif
</pre>