Difference between revisions of "%character%.CharacterProperName function"
From ADRIFT 5 Manual Wiki
| Line 1: | Line 1: | ||
This function returns the contents of the "Proper Name" field at the top of the description page for the indicated character. | This function returns the contents of the "Proper Name" field at the top of the description page for the indicated character. | ||
| + | |||
| + | For the following character it will return "John Smith". | ||
[[File:CharacterDescription.jpg]] | [[File:CharacterDescription.jpg]] | ||
| Line 7: | Line 9: | ||
*Character12.CharacterProperName = name of character with the [[key]] "Character12" | *Character12.CharacterProperName = name of character with the [[key]] "Character12" | ||
*%Player%.CharOnWho.CharacterProperName = name of character the player is sitting on top of | *%Player%.CharOnWho.CharacterProperName = name of character the player is sitting on top of | ||
| − | + | :You should use a restriction to check, or otherwise ensure that the player is actually sitting on another character, or an error message will be displayed. | |
*%AloneWithChar%.CharacterProperName = name of the only character that is currently in the same location as the player. | *%AloneWithChar%.CharacterProperName = name of the only character that is currently in the same location as the player. | ||
| − | + | :You must test the restriction [The Player Character][must][be alone with][Any Character] prior to using this function otherwise an error will occur if there is not exactly one other character at the players location. | |
*%ConvCharacter%.CharacterProperName = name of the character that is currently in conversation with the player. | *%ConvCharacter%.CharacterProperName = name of the character that is currently in conversation with the player. | ||
| + | :You must ensure that the player is in conversation before using this function. | ||
see also the [[%character%.Name function]] which will return the proper name of the character if its "Known" property is set, or the descriptor (article-adjective-noun fields) if not set. | see also the [[%character%.Name function]] which will return the proper name of the character if its "Known" property is set, or the descriptor (article-adjective-noun fields) if not set. | ||
Revision as of 02:58, 23 November 2012
This function returns the contents of the "Proper Name" field at the top of the description page for the indicated character.
For the following character it will return "John Smith".
Examples:
- %character%.CharacterProperName = name of the character referenced in a task.
- Character12.CharacterProperName = name of character with the key "Character12"
- %Player%.CharOnWho.CharacterProperName = name of character the player is sitting on top of
- You should use a restriction to check, or otherwise ensure that the player is actually sitting on another character, or an error message will be displayed.
- %AloneWithChar%.CharacterProperName = name of the only character that is currently in the same location as the player.
- You must test the restriction [The Player Character][must][be alone with][Any Character] prior to using this function otherwise an error will occur if there is not exactly one other character at the players location.
- %ConvCharacter%.CharacterProperName = name of the character that is currently in conversation with the player.
- You must ensure that the player is in conversation before using this function.
see also the %character%.Name function which will return the proper name of the character if its "Known" property is set, or the descriptor (article-adjective-noun fields) if not set.
| <<< CharacterPosition | Character Functions | Description >>> |
