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

From ADRIFT 5 Manual Wiki
Jump to: navigation, search
(CharacterAtLocation)
Line 4: Line 4:
 
: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.
 
: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]]
 
[[File:RestrictionLocationOfChar.jpg]]
*When the "Location of the character" property is selected, the "AtWhichLocation" property of the character displays the name of the location:
+
*When the "Location of the character" property is selected, the "AtWhichLocation" property of the character displays the name (short description) of the location:
 +
:Append the [[%location%.Name function|"Name" function]] to display this name. ie. "%character%.CharacterAtLocation.Name".
 
[[File:PropertyAtLocation.jpg]]
 
[[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.
 
*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.
 
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.

Revision as of 02:00, 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 (short description) of the location:
Append the "Name" function to display this name. ie. "%character%.CharacterAtLocation.Name".

PropertyAtLocation.jpg

  • 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 >>>