Difference between revisions of "Character Functions"
From ADRIFT 5 Manual Wiki
(3 character functions added in 5.0.26) |
(fixed example) |
||
Line 62: | Line 62: | ||
[[File:IconGroup.jpg]] Group Filters | [[File:IconGroup.jpg]] Group Filters | ||
*[[%character%.Known function|Is this character known to the player]] | *[[%character%.Known function|Is this character known to the player]] | ||
− | :<font color="green">% | + | :<font color="green">%object%</font>.Contents(Characters).Known - Filter a character group so it only includes characters that are known to the player. |
*[[%character%.ShowEnterExit function|Show character entering/exiting the location]] | *[[%character%.ShowEnterExit function|Show character entering/exiting the location]] | ||
− | :<font color="green">% | + | :<font color="green">%object%</font>.Contents(Characters).ShowEnterExit - Filter a character group so it only includes characters that generate a message when they enter or leave the players location. |
[[File:IconDynamicObject.jpg]] Object properties | [[File:IconDynamicObject.jpg]] Object properties |
Revision as of 13:15, 20 November 2012
The object-oriented functions for characters can be listed by typing a dot (full-stop ".") immediately after the character reference "%character%", a character key, or the player-character function %Player%, in either a text box or an expression.
These names are CASE SENSITIVE. "%Character%." wont work, you must type "%character%."
This allows direct access to the property values of any character, location or object without having to use the %PropertyValue[]% function
Scroll down to the wanted property and click on it to insert the property key into the function.
- Note that properties that are not relevant to a particular character will be ommited from the list.
- Properties that you create and add to the characters will be added to this list.
- If you type part of the name of the property then the list will be reduced to show only those that match.
- Instead of clicking with the mouse you can type enough of the properties name to bring it to the top of the list and press enter or tab.
- %character%.CharacterAtLocation - Displays the KEY of the characters current location. Entering another dot after this will access the properties of that location.
- %character%.CharOnWho - Key of character that this character is sitting on.
- %character%.Name - If "Known" property selected then print proper name, otherwise print the characters descriptor.
- %character%.CharacterPosition - Standing, sitting or lying
- %character%.CharacterProperName
- %character%.Description
- %character%.CharEnters
- %character%.CharExits
- %character%.Descriptor - Article, adjective and noun of character descriptor.
- %character%.Gender - Male, female or unknown
- %character%.CharacterLocation - Name (short descripton) of the current location of the character.
- %character%.ProperName
- %character%.CharHereDesc
- %character%.MaxBulk - The max. number of tiny objects that this character can carry (If set for this character)
- %character%.MaxWeight - Where a tiny object has weight = 1.
- %character%.Held - A list of all objects held by the character
- %character%.Worn - A list of all objects worn by the character
- %character%.WornAndHeld - A list of all objects being worn and held by the character
- %object%.Contents(Characters).Known - Filter a character group so it only includes characters that are known to the player.
- %object%.Contents(Characters).ShowEnterExit - Filter a character group so it only includes characters that generate a message when they enter or leave the players location.
- %character%.CharInsideWhat - The key of the container object that the character is inside of
- %character%.CharOnWhat - The key of the supporter object that the character is on top of
- %character%.Parent - The key of the location or object that immediately contains the character
Useage
These functions can be used with a specific character, or with any function or reference that returns a character key:
- In a task containing a %character% reference, using the reference will apply the character function to the character that the player entered in the command.
- A specific character can be selected by using its key. eg. "Character12.Name"
- A location or object function can be used to obtain a character key, and the character function appended to it. eg "Object3.HeldByWho.Name" will print the name of the character that is holding Object3.
<<< Object-oriented functions | Main Page | Object Functions >>> |