MouseInfo Script - Revision history

Rob: /* Technical Details */

2009-02-20T08:48:58Z

Technical Details

← Older revision		Revision as of 08:48, 20 February 2009
Line 15:		Line 15:
	\|Where Used:		\|Where Used:
	\|[[Portal Element (Data)\|Portals]]		\|[[Portal Element (Data)\|Portals]]
			\|-
			\|Procedure Use:
			\|"mouseinfo" type, "info" context, "pick" context
	\|-		\|-
	\|}		\|}

Rob at 00:14, 16 December 2008

2008-12-16T00:14:42Z

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

Rob at 12:23, 15 December 2008

2008-12-15T12:23:31Z

← Older revision		Revision as of 12:23, 15 December 2008
Line 19:		Line 19:
	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|text		\|class="leftnormal"\|text
	\|Entry: Contains the default mouse-info for the object, which consists of the basic description text assigned to the object and any failed pre-requisites.<br>		\|(String) Entry: Contains the default mouse-info for the object, which consists of the basic description text assigned to the object and any failed pre-requisites.<br>
	Exit: Contains the text to be displayed to the user as the mouse-info text. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user as the mouse-info text. The final text may contain [[Encoded Text\|encoding]].
	\|-		\|-
	\|ispick		\|ispick
	\|Entry: Indicates whether the text is being rendered for a thing (zero) or a pick (non-zero), allowing different handling to be performed for the two separate cases.		\|(Number) Entry: Indicates whether the text is being rendered for a thing (zero) or a pick (non-zero), allowing different handling to be performed for the two separate cases.
	Exit: Ignored.		Exit: Ignored.
	\|-		\|-

Rob at 14:00, 12 December 2008

2008-12-12T14:00:13Z

← Older revision		Revision as of 14:00, 12 December 2008
Line 18:		Line 18:

	:{\| class="infotable"		:{\| class="infotable"
	\|class="leftnormal"\|~~Text~~		\|class="leftnormal"\|text
	\|Entry: Contains the default mouse-info for the object, which consists of the basic description text assigned to the object and any failed pre-requisites.<br>		\|Entry: Contains the default mouse-info for the object, which consists of the basic description text assigned to the object and any failed pre-requisites.<br>
	Exit: Contains the text to be displayed to the user as the mouse-info text. The final text may contain [[Encoded Text\|encoding]].		Exit: Contains the text to be displayed to the user as the mouse-info text. The final text may contain [[Encoded Text\|encoding]].

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

2008-12-12T10:47:49Z

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

New page

{{context|Kit Reference|Script Types}}

==Technical Details==

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

The MouseInfo script utilizes the following special symbols:

:{| class="infotable"
|class="leftnormal"|Text
|Entry: Contains the default mouse-info for the object, which consists of the basic description text assigned to the object and any failed pre-requisites.<br>
Exit: Contains the text to be displayed to the user as the mouse-info text. The final text may contain [[Encoded Text|encoding]].
|-
|ispick
|Entry: Indicates whether the text is being rendered for a thing (zero) or a pick (non-zero), allowing different handling to be performed for the two separate cases.
Exit: Ignored.
|-
|}

==Description==

HL makes extensive use of visual elements that the user can move the mouse over to obtain further details about an object. This is generally referred to as mouse-over highlighting, or simply ''mouse info'', and it is accomplished via the MouseInfo script on various portals. The purpose of the MouseInfo script is to synthesize the actual text to be displayed for the pick/thing that the user is inquiring about.

{{note}} The MouseInfo 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 weapons, it's useful to show the damage and range. This can be easily appended to the default text for display.

<pre>
@text &= "\n"
@text &= "Damage: " & field[wpDamage}.text & "\n"
@text &= "Range: " & field[wpRange].text & "\n"
</pre>