Difference between revisions of "%character%.CharacterProperName function"
From ADRIFT 5 Manual Wiki
(Created page with " <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER><<< CharacterPosition</TD><TD WIDTH="34%" ALIGN=CENT...") |
m (→Examples) |
||
| (5 intermediate revisions by the same user not shown) | |||
| 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. | ||
| + | For the following character it will return "John Smith". | ||
| + | [[File:CharacterDescription.jpg]] | ||
| + | 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. | ||
| + | == Examples == | ||
| + | * <span style="color:green">%character%</span>.CharacterProperName | ||
| + | : Name of the character referenced in a task. | ||
| + | * <span style="color:red">Character12</span>.CharacterProperName | ||
| + | : Name of character with the [[key]] "Character12" | ||
| + | * <span style="color:blue">%Player%</span>.CharOnWho.CharacterProperName | ||
| + | : Name of the character the player is sitting on top of. | ||
| + | : You should ensure that the player is actually sitting on another character, or use a restriction to check they are, otherwise an error message will be displayed. | ||
| − | + | * <span style="color:blue">%AloneWithChar%</span>.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. | |
| − | + | ||
| + | * <span style="color:blue">%ConvCharacter%</span>.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. | ||
<TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%character%.CharacterPosition function|<<< CharacterPosition]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Character Functions]]</TD><TD ALIGN=CENTER>[[%character%.Description function|Description >>>]]</TD></TABLE> | <TABLE ALIGN=CENTER BORDER=1 WIDTH="50%"><TD WIDTH="33%" ALIGN=CENTER>[[%character%.CharacterPosition function|<<< CharacterPosition]]</TD><TD WIDTH="34%" ALIGN=CENTER>[[Character Functions]]</TD><TD ALIGN=CENTER>[[%character%.Description function|Description >>>]]</TD></TABLE> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
Latest revision as of 04:18, 11 December 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".
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.
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 the character the player is sitting on top of.
- You should ensure that the player is actually sitting on another character, or use a restriction to check they are, otherwise 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.
| <<< CharacterPosition | Character Functions | Description >>> |
