Difference between revisions of "Spec equipped token"

From The Final Challenge Wiki
Jump to navigation Jump to search
(Created page with "''Not yet ready for use -- draft'' spec_equipped_token is a Mob Extended Function. It provides for special behavior when a PC has equipped/worn the object specified with...")
 
Line 1: Line 1:
''Not yet ready for use -- draft''
spec_equipped_token is a [[Mob Extended Function]].  It provides for special behavior when a PC has equipped/worn the object specified with the special function.
spec_equipped_token is a [[Mob Extended Function]].  It provides for special behavior when a PC has equipped/worn the object specified with the special function.


Usage:
Usage:


N <mob vnum> spec_equipped_token <token object vnum equipped> <token type> <match value or '''-1'''> <match type or '''-1'''> <string vnum or '''-1'''>
N <mob vnum> spec_equipped_token <token (object) vnum equipped> <token type> <match type or '''-1'''> <match value or '''-1'''> <string vnum or '''-1'''>


{| class="wikitable"
{| class="wikitable"
Line 19: Line 17:
|-
|-
|token type
|token type
|Indicates when a PC will be checked for equipped object (token).<br />'''-1''' causes any subsequent special functions on the mob to be bypassed.<br />'''1''' also causes any subsequent special functions on the mob to be bypassed.<br />'''2''' causes next special function on the mob to run.<br />'''3''' causes an aggressive mob to no longer be aggressive to the PC wearing the token.
|Indicates when a PC will be checked for equipped object (token).<br />'''1''' causes an aggressive mob to no longer be aggressive to the PC wearing the token.
|-
| match type
|If desired, the successful use of the token can be based on ''one'' of the following criteria:<br />'''-1''' Disable secondary match<br />'''1'''Race of wearer<br />'''2''' Class of wearer (in any position)<br />'''3''' Specified effective level of wearer or higher<br /> '''4''' Specified effective level of wearer or lower<br />'''5''' Primary (1st position) level of wearer or higher<br />'''6''' Primary (1st position) level of wearer or lower<br />'''7''' Sex of wearer
|-
|-
|match value
|match value
|Causes the token to match only if target PC meets the specified additional criteria, provided in ''match type'''''-1''' if not being used.
|Numeric value that corresponds with the match type chosen, or '''-1''' if token can be used by any PC
|-
|string vnum
|As this is often not useful with mob special functions, you would usually specify '''-1'''
|}
|}


Example:<br /><br />
Example:<br /><br />
'''N 1200 spec_equipped_token 20'''
'''N 1200 spec_equipped_token 20 1 2 0 -1'''<br />
This would attach the special function to mob matching vnum 1200.  If the PC was wearing the object with vnum 20 AND s/he had a MAGE class, the mob would not aggressively attack the PC.


[[Category:Area Development]]
[[Category:Area Development]]

Revision as of 19:47, 7 June 2016

spec_equipped_token is a Mob Extended Function. It provides for special behavior when a PC has equipped/worn the object specified with the special function.

Usage:

N <mob vnum> spec_equipped_token <token (object) vnum equipped> <token type> <match type or -1> <match value or -1> <string vnum or -1>

Field Description
mob vnum The vnum of the mob that this special function is attached to
token object vnum equipped The vnum of the token object that will trigger the special function when the object is equipped by a PC
token type Indicates when a PC will be checked for equipped object (token).
1 causes an aggressive mob to no longer be aggressive to the PC wearing the token.
match type If desired, the successful use of the token can be based on one of the following criteria:
-1 Disable secondary match
1Race of wearer
2 Class of wearer (in any position)
3 Specified effective level of wearer or higher
4 Specified effective level of wearer or lower
5 Primary (1st position) level of wearer or higher
6 Primary (1st position) level of wearer or lower
7 Sex of wearer
match value Numeric value that corresponds with the match type chosen, or -1 if token can be used by any PC
string vnum As this is often not useful with mob special functions, you would usually specify -1

Example:

N 1200 spec_equipped_token 20 1 2 0 -1
This would attach the special function to mob matching vnum 1200. If the PC was wearing the object with vnum 20 AND s/he had a MAGE class, the mob would not aggressively attack the PC.