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

Latest revision as of 04:34, 11 December 2012

This function returns the contents of the "Description when exits the location" property.

This is a text box, so the returned text can span multiple lines.

Requirements

This function can only be used with a character that has both the "Show character entering/exiting the location" property and the "Description when exits the location" property selected.

You can test this using the character restrictions:

[character] [must] [have property] [Show character entering/exiting the location ]

[character] [must] [have property] [Description when exits the location]

Properties

When the "Show character entering/exiting the location" property is selected, the "Description when exits the location" property becomes available. If this is also selected then you can enter a description that is to be printed whenever the character leaves the location the player is in. This property can have Alternate Descriptions, in which case those descriptions that pass restrictions will be composited and the final result printed.

How to use

This function simply returns the contents of the "Description when exits the location" text box as one or more lines of text. No further functions can be appended to this function.