Difference between revisions of "Character Functions"

Revision as of 03:58, 27 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.

Most of the listed functions simply return the current value of one of the properties on the character property tab:

Location properties

• At which location

%character%.CharacterAtLocation - Displays the KEY of the characters current location. Entering another dot after this will access the properties of that location.

Character properties

• On which character?

%character%.CharOnWho - Key of character that this character is sitting on.

Text properties

• Character Name

%character%.Name - If "Known" property selected then print proper name, otherwise print the characters descriptor.

• Character Position

%character%.CharacterPosition - Standing, sitting or lying

• Character Proper name

%character%.CharacterProperName

• Description

%character%.Description

• Description when enters the location

%character%.CharEnters

• Description when exits the location

%character%.CharExits

• Descriptor

%character%.Descriptor - Article, adjective and noun of character descriptor.

• Gender

%character%.Gender - Male, female or unknown

• Location of the character

%character%.CharacterLocation - Name (short descripton) of the current location of the character.

• Proper Name

%character%.ProperName

• What to show when the character is at the location

%character%.CharHereDesc

Integer properties

• Maximum size of held items

%character%.MaxBulk - The max. number of tiny objects that this character can carry (If set for this character)

• Maximum weight of held items

%character%.MaxWeight - Where a tiny object has weight = 1.

Group properties

• Held

%character%.Held - A list of all objects held by the character

• Worn

%character%.Worn - A list of all objects worn by the character

• WornAndHeld

%character%.WornAndHeld - A list of all objects being worn and held by the character

Group Filters

• Is this character known to the player

%object%.Contents(Characters).Known - Filter a character group so it only includes characters that are known to the player.

• Show character entering/exiting the location

%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.

Object properties

• Inside which object?

%character%.CharInsideWhat - The key of the container object that the character is inside of

• On which object?

%character%.CharOnWhat - The key of the supporter object that the character is on top of

Item properties

• Parent

%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.
• If the player is at the same location as exactly one other character, use the %AloneWithChar% function to get the key of that character.
• If the player has started a conversation with another character, use the %ConvCharacter% function to get the key of that character.