Difference between revisions of "%character%.CharacterAtLocation function"

From ADRIFT 5 Manual Wiki
Jump to: navigation, search
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< Object-oriented functions</TD><TD WIDTH="34%" ALIGN=CENTER>...")
 
(CharacterAtLocation)
Line 1: Line 1:
 +
This function returns the [[key]] of the [[Locations|location]] at which the selected character is currently located.
  
 +
*This function will not work if the character is on or inside an object, on another character, or is hidden.
 +
:If you cannot be certain that the character is at a location, then you must use the following restriction in the [[Tasks|task]] or an [[Alternate Descriptions|alternate description]] to ensure that it is.
 +
[[File:RestrictionLocationOfChar.jpg]]
 +
*When the "Location of the character" property is selected, the "AtWhichLocation" property of the character displays the name of the location:
 +
[[File:PropertyAtLocation.jpg]]
 +
*You can use the [[%location%.Name function|"Name" function]] to get the short description of the location. ie. "%character%.CharacterAtLocation.Name".
 +
*Any of the [[Location Functions]] can be appended to the CharacterAtLocation function to display a property of the location of a character.
  
 
+
As well as the %character% reference, you can use the key of a character or any function that returns the key of a character with this function.
 
+
<pre>Character4.CharacterAtLocation
 
+
%AloneWithChar%.CharacterAtLocation
 
+
%ConvCharacter%.CharacterAtLocation
 
+
%object%.Contents(Characters).CharacterAtLocation
 
+
</pre>
 
+
 
+
 
+
 
+
 
+
  
  
 
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[Object-oriented functions|<<< Object-oriented functions]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Character Functions]]</TD><TD ALIGN=CENTER>[[%character%.CharOnWho function|CharOnWho >>>]]</TD></TABLE>
 
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[Object-oriented functions|<<< Object-oriented functions]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Character Functions]]</TD><TD ALIGN=CENTER>[[%character%.CharOnWho function|CharOnWho >>>]]</TD></TABLE>
 
[[Category:Functions]]
 
[[Category:Functions]]

Revision as of 00:53, 24 November 2012

This function returns the key of the location at which the selected character is currently located.

  • This function will not work if the character is on or inside an object, on another character, or is hidden.
If you cannot be certain that the character is at a location, then you must use the following restriction in the task or an alternate description to ensure that it is.

RestrictionLocationOfChar.jpg

  • When the "Location of the character" property is selected, the "AtWhichLocation" property of the character displays the name of the location:

PropertyAtLocation.jpg

  • You can use the "Name" function to get the short description of the location. ie. "%character%.CharacterAtLocation.Name".
  • Any of the Location Functions can be appended to the CharacterAtLocation function to display a property of the location of a character.

As well as the %character% reference, you can use the key of a character or any function that returns the key of a character with this function.

Character4.CharacterAtLocation
%AloneWithChar%.CharacterAtLocation
%ConvCharacter%.CharacterAtLocation
%object%.Contents(Characters).CharacterAtLocation


<<< Object-oriented functionsCharacter FunctionsCharOnWho >>>