https://wiki.spherecommunity.net/api.php?action=feedcontributions&feedformat=atom&user=GorgoSphereWiki - User contributions [en]2026-04-10T05:43:24ZUser contributionsMediaWiki 1.28.0https://wiki.spherecommunity.net/index.php?title=ITEMDEF&diff=8074ITEMDEF2023-01-15T21:02:09Z<p>Gorgo: /* Properties */</p>
<hr />
<div>{{Languages|ITEMDEF}}<br />
<br />
__FORCETOC__<br />
<br />
An ITEMDEF block defines the basic properties of an [[Items|item]].<br />
<br />
==Properties==<br />
Here is a list of all item definition properties.<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.<br />
|-<br />
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.<br />
|-<br />
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.<br />
|-<br />
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.<br />
|-<br />
| [[BONUSSTR]] | [[BONUSDEX]] | [[BONUSINT]] | [[BONUSHITS]] | [[BONUSSTAM]] | [[BONUSMANA]] | [[BONUSSKILLx]] | [[BONUSSKILLxAMT]] (X branch only) || RW || Increases (or decreases) the applicable Stat. Positive or negative integer.<br />
For BonusSkill, x is the number of the Skill and BonusSkillxAMT is the amount<br />
|-<br />
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.<br />
|-<br />
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.<br />
|-<br />
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.<br />
|-<br />
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets defname of the item<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.<br />
|-<br />
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).<br />
|-<br />
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.<br />
|-<br />
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).<br />
|-<br />
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.<br />
|-<br />
| [[HEIGHT]] || RW || Gets or sets the height of the item.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.<br />
|-<br />
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.<br />
|-<br />
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.<br />
|-<br />
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the item.<br />
|-<br />
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.<br />
|-<br />
| [[RANGEH]] || R || Gets the maximum range of the weapon.<br />
|-<br />
| [[RANGEL]] || R || Gets the minimum range of the weapon.<br />
|-<br />
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).<br />
|-<br />
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.<br />
|-<br />
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.<br />
|-<br />
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.<br />
|-<br />
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.<br />
|-<br />
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.<br />
|-<br />
| [[SPEED]] || RW || Gets or sets the speed of the weapon.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.<br />
|-<br />
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.<br />
|-<br />
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.<br />
|-<br />
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.<br />
|-<br />
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.<br />
|-<br />
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.<br />
|-<br />
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)<br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item's type.<br />
|-<br />
| [[VALUE]] || RW || Gets or sets the base value of the item.<br />
|-<br />
| [[WEIGHT]] || RW || Gets or sets the weight of the item.<br />
|-<br />
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.<br />
|}<br />
<br />
==Multi Definitions==<br />
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.<br />
<br />
===Properties===<br />
Here is a list of all multi definition properties.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''<br />
|-<br />
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.<br />
|-<br />
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)<br />
|-<br />
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.<br />
|-<br />
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)<br />
|-<br />
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)<br />
|-<br />
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).<br />
|-<br />
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.<br />
|-<br />
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)<br />
|-<br />
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.<br />
|}<br />
<br />
'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.<br />
<br />
==Examples==<br />
<spherescript>//<br />
// Blue Gold<br />
//<br />
[ITEMDEF i_gold_blue]<br />
ID=i_gold // inherits from i_gold<br />
NAME=Blue Gold // named Blue Gold<br />
TYPE=t_gold // is type t_gold<br />
VALUE=10 // valued at gold<br />
<br />
ON=@Create<br />
COLOR = colors_blue<br />
<br />
<br />
//<br />
// Small Stone and Plaster House (from default script pack)<br />
//<br />
[ITEMDEF 04064] // item ID 0x4064 (in mul files)<br />
DEFNAME=i_multi_house_stone_plaster_small<br />
NAME=Small Stone and Plaster House<br />
TYPE=t_multi<br />
VALUE=43800 // valued at 43800 gold<br />
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item<br />
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)<br />
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=ITEMDEF&diff=8073ITEMDEF2023-01-15T20:38:37Z<p>Gorgo: /* Properties */</p>
<hr />
<div>{{Languages|ITEMDEF}}<br />
<br />
__FORCETOC__<br />
<br />
An ITEMDEF block defines the basic properties of an [[Items|item]].<br />
<br />
==Properties==<br />
Here is a list of all item definition properties.<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.<br />
|-<br />
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.<br />
|-<br />
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.<br />
|-<br />
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.<br />
|-<br />
| [[BONUSSTR]] | [[BONUSDEX]] | [[BONUSINT]] | [[BONUSHITS]] | [[BONUSSTAM]] | [[BONUSMANA]] (X branch only) || RW || Increases (or decreases) the applicable Stat. Positive or negative integer.<br />
|-<br />
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.<br />
|-<br />
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.<br />
|-<br />
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.<br />
|-<br />
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets defname of the item<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.<br />
|-<br />
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).<br />
|-<br />
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.<br />
|-<br />
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).<br />
|-<br />
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.<br />
|-<br />
| [[HEIGHT]] || RW || Gets or sets the height of the item.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.<br />
|-<br />
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.<br />
|-<br />
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.<br />
|-<br />
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the item.<br />
|-<br />
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.<br />
|-<br />
| [[RANGEH]] || R || Gets the maximum range of the weapon.<br />
|-<br />
| [[RANGEL]] || R || Gets the minimum range of the weapon.<br />
|-<br />
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).<br />
|-<br />
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.<br />
|-<br />
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.<br />
|-<br />
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.<br />
|-<br />
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.<br />
|-<br />
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.<br />
|-<br />
| [[SPEED]] || RW || Gets or sets the speed of the weapon.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.<br />
|-<br />
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.<br />
|-<br />
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.<br />
|-<br />
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.<br />
|-<br />
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.<br />
|-<br />
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.<br />
|-<br />
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)<br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item's type.<br />
|-<br />
| [[VALUE]] || RW || Gets or sets the base value of the item.<br />
|-<br />
| [[WEIGHT]] || RW || Gets or sets the weight of the item.<br />
|-<br />
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.<br />
|}<br />
<br />
==Multi Definitions==<br />
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.<br />
<br />
===Properties===<br />
Here is a list of all multi definition properties.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''<br />
|-<br />
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.<br />
|-<br />
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)<br />
|-<br />
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.<br />
|-<br />
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)<br />
|-<br />
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)<br />
|-<br />
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).<br />
|-<br />
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.<br />
|-<br />
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)<br />
|-<br />
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.<br />
|}<br />
<br />
'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.<br />
<br />
==Examples==<br />
<spherescript>//<br />
// Blue Gold<br />
//<br />
[ITEMDEF i_gold_blue]<br />
ID=i_gold // inherits from i_gold<br />
NAME=Blue Gold // named Blue Gold<br />
TYPE=t_gold // is type t_gold<br />
VALUE=10 // valued at gold<br />
<br />
ON=@Create<br />
COLOR = colors_blue<br />
<br />
<br />
//<br />
// Small Stone and Plaster House (from default script pack)<br />
//<br />
[ITEMDEF 04064] // item ID 0x4064 (in mul files)<br />
DEFNAME=i_multi_house_stone_plaster_small<br />
NAME=Small Stone and Plaster House<br />
TYPE=t_multi<br />
VALUE=43800 // valued at 43800 gold<br />
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item<br />
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)<br />
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=ITEMDEF&diff=8072ITEMDEF2023-01-15T20:03:02Z<p>Gorgo: /* Properties */</p>
<hr />
<div>{{Languages|ITEMDEF}}<br />
<br />
__FORCETOC__<br />
<br />
An ITEMDEF block defines the basic properties of an [[Items|item]].<br />
<br />
==Properties==<br />
Here is a list of all item definition properties.<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.<br />
|-<br />
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.<br />
|-<br />
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.<br />
|-<br />
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.<br />
|-<br />
| [[BONUSSTR]] | [[BONUSDEX]] | [[BONUSINT]] | [[BONUSHITS]] | [[BONUSSTAM]] | [[BONUSMANA]] (X branch only) || RW || Increases (or decreases) the applicable Stat. Positive or negative integer.<br />
Effect: these bonus are implemented inside the ei_equipitem TYPEDEF and does not rely on other TYPEDEFs or EVENTs.<br />
|-<br />
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.<br />
|-<br />
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.<br />
|-<br />
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.<br />
|-<br />
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets defname of the item<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.<br />
|-<br />
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).<br />
|-<br />
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.<br />
|-<br />
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).<br />
|-<br />
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.<br />
|-<br />
| [[HEIGHT]] || RW || Gets or sets the height of the item.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.<br />
|-<br />
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.<br />
|-<br />
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.<br />
|-<br />
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the item.<br />
|-<br />
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.<br />
|-<br />
| [[RANGEH]] || R || Gets the maximum range of the weapon.<br />
|-<br />
| [[RANGEL]] || R || Gets the minimum range of the weapon.<br />
|-<br />
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).<br />
|-<br />
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.<br />
|-<br />
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.<br />
|-<br />
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.<br />
|-<br />
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.<br />
|-<br />
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.<br />
|-<br />
| [[SPEED]] || RW || Gets or sets the speed of the weapon.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.<br />
|-<br />
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.<br />
|-<br />
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.<br />
|-<br />
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.<br />
|-<br />
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.<br />
|-<br />
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.<br />
|-<br />
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)<br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item's type.<br />
|-<br />
| [[VALUE]] || RW || Gets or sets the base value of the item.<br />
|-<br />
| [[WEIGHT]] || RW || Gets or sets the weight of the item.<br />
|-<br />
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.<br />
|}<br />
<br />
==Multi Definitions==<br />
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.<br />
<br />
===Properties===<br />
Here is a list of all multi definition properties.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''<br />
|-<br />
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.<br />
|-<br />
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)<br />
|-<br />
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.<br />
|-<br />
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)<br />
|-<br />
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)<br />
|-<br />
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).<br />
|-<br />
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.<br />
|-<br />
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)<br />
|-<br />
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.<br />
|}<br />
<br />
'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.<br />
<br />
==Examples==<br />
<spherescript>//<br />
// Blue Gold<br />
//<br />
[ITEMDEF i_gold_blue]<br />
ID=i_gold // inherits from i_gold<br />
NAME=Blue Gold // named Blue Gold<br />
TYPE=t_gold // is type t_gold<br />
VALUE=10 // valued at gold<br />
<br />
ON=@Create<br />
COLOR = colors_blue<br />
<br />
<br />
//<br />
// Small Stone and Plaster House (from default script pack)<br />
//<br />
[ITEMDEF 04064] // item ID 0x4064 (in mul files)<br />
DEFNAME=i_multi_house_stone_plaster_small<br />
NAME=Small Stone and Plaster House<br />
TYPE=t_multi<br />
VALUE=43800 // valued at 43800 gold<br />
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item<br />
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)<br />
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=ITEMDEF&diff=8035ITEMDEF2022-12-26T20:20:15Z<p>Gorgo: </p>
<hr />
<div>{{Languages|ITEMDEF}}<br />
<br />
__FORCETOC__<br />
<br />
An ITEMDEF block defines the basic properties of an [[Items|item]].<br />
<br />
==Properties==<br />
Here is a list of all item definition properties.<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.<br />
|-<br />
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.<br />
|-<br />
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.<br />
|-<br />
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.<br />
|-<br />
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.<br />
|-<br />
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.<br />
|-<br />
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.<br />
|-<br />
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets defname of the item<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.<br />
|-<br />
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).<br />
|-<br />
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.<br />
|-<br />
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).<br />
|-<br />
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.<br />
|-<br />
| [[HEIGHT]] || RW || Gets or sets the height of the item.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.<br />
|-<br />
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.<br />
|-<br />
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.<br />
|-<br />
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the item.<br />
|-<br />
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.<br />
|-<br />
| [[RANGEH]] || R || Gets the maximum range of the weapon.<br />
|-<br />
| [[RANGEL]] || R || Gets the minimum range of the weapon.<br />
|-<br />
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).<br />
|-<br />
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.<br />
|-<br />
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.<br />
|-<br />
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.<br />
|-<br />
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.<br />
|-<br />
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.<br />
|-<br />
| [[SPEED]] || RW || Gets or sets the speed of the weapon.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.<br />
|-<br />
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.<br />
|-<br />
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.<br />
|-<br />
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.<br />
|-<br />
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.<br />
|-<br />
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.<br />
|-<br />
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)<br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item's type.<br />
|-<br />
| [[VALUE]] || RW || Gets or sets the base value of the item.<br />
|-<br />
| [[WEIGHT]] || RW || Gets or sets the weight of the item.<br />
|-<br />
| [[WEIGHTREDUCTION]] || RW || Gets or sets the percent of weight reduction of the item.<br />
|}<br />
<br />
==Multi Definitions==<br />
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.<br />
<br />
===Properties===<br />
Here is a list of all multi definition properties.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''<br />
|-<br />
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.<br />
|-<br />
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)<br />
|-<br />
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.<br />
|-<br />
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)<br />
|-<br />
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)<br />
|-<br />
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).<br />
|-<br />
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.<br />
|-<br />
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)<br />
|-<br />
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.<br />
|}<br />
<br />
'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.<br />
<br />
==Examples==<br />
<spherescript>//<br />
// Blue Gold<br />
//<br />
[ITEMDEF i_gold_blue]<br />
ID=i_gold // inherits from i_gold<br />
NAME=Blue Gold // named Blue Gold<br />
TYPE=t_gold // is type t_gold<br />
VALUE=10 // valued at gold<br />
<br />
ON=@Create<br />
COLOR = colors_blue<br />
<br />
<br />
//<br />
// Small Stone and Plaster House (from default script pack)<br />
//<br />
[ITEMDEF 04064] // item ID 0x4064 (in mul files)<br />
DEFNAME=i_multi_house_stone_plaster_small<br />
NAME=Small Stone and Plaster House<br />
TYPE=t_multi<br />
VALUE=43800 // valued at 43800 gold<br />
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item<br />
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)<br />
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=ITEMDEF&diff=8034ITEMDEF2022-12-12T21:37:57Z<p>Gorgo: </p>
<hr />
<div>{{Languages|ITEMDEF}}<br />
<br />
__FORCETOC__<br />
<br />
An ITEMDEF block defines the basic properties of an [[Items|item]].<br />
<br />
==Properties==<br />
Here is a list of all item definition properties.<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.<br />
|-<br />
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.<br />
|-<br />
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.<br />
|-<br />
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.<br />
|-<br />
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.<br />
|-<br />
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.<br />
|-<br />
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.<br />
|-<br />
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets defname of the item<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.<br />
|-<br />
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).<br />
|-<br />
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.<br />
|-<br />
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).<br />
|-<br />
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.<br />
|-<br />
| [[HEIGHT]] || RW || Gets or sets the height of the item.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.<br />
|-<br />
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.<br />
|-<br />
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.<br />
|-<br />
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the item.<br />
|-<br />
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.<br />
|-<br />
| [[RANGEH]] || R || Gets the maximum range of the weapon.<br />
|-<br />
| [[RANGEL]] || R || Gets the minimum range of the weapon.<br />
|-<br />
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).<br />
|-<br />
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.<br />
|-<br />
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.<br />
|-<br />
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.<br />
|-<br />
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.<br />
|-<br />
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.<br />
|-<br />
| [[SPEED]] || RW || Gets or sets the speed of the weapon.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.<br />
|-<br />
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.<br />
|-<br />
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.<br />
|-<br />
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.<br />
|-<br />
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.<br />
|-<br />
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.<br />
|-<br />
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)<br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item's type.<br />
|-<br />
| [[VALUE]] || RW || Gets or sets the base value of the item.<br />
|-<br />
| [[WEIGHT]] || RW || Gets or sets the weight of the item.<br />
|}<br />
<br />
==Multi Definitions==<br />
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.<br />
<br />
===Properties===<br />
Here is a list of all multi definition properties.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''<br />
|-<br />
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.<br />
|-<br />
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)<br />
|-<br />
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.<br />
|-<br />
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)<br />
|-<br />
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)<br />
|-<br />
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).<br />
|-<br />
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.<br />
|-<br />
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed (tenths) and tiles that a ship will move at. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed (tenths per each movement) that a ship will move at. (t_ship only)<br />
|-<br />
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.<br />
|}<br />
<br />
'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.<br />
<br />
==Examples==<br />
<spherescript>//<br />
// Blue Gold<br />
//<br />
[ITEMDEF i_gold_blue]<br />
ID=i_gold // inherits from i_gold<br />
NAME=Blue Gold // named Blue Gold<br />
TYPE=t_gold // is type t_gold<br />
VALUE=10 // valued at gold<br />
<br />
ON=@Create<br />
COLOR = colors_blue<br />
<br />
<br />
//<br />
// Small Stone and Plaster House (from default script pack)<br />
//<br />
[ITEMDEF 04064] // item ID 0x4064 (in mul files)<br />
DEFNAME=i_multi_house_stone_plaster_small<br />
NAME=Small Stone and Plaster House<br />
TYPE=t_multi<br />
VALUE=43800 // valued at 43800 gold<br />
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item<br />
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)<br />
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=ITEMDEF&diff=8033ITEMDEF2022-12-11T21:32:38Z<p>Gorgo: </p>
<hr />
<div>{{Languages|ITEMDEF}}<br />
<br />
__FORCETOC__<br />
<br />
An ITEMDEF block defines the basic properties of an [[Items|item]].<br />
<br />
==Properties==<br />
Here is a list of all item definition properties.<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[ARMOR]] ''min,max'' || RW || Gets or sets the base protection that the armour will give.<br />
|-<br />
| [[ARMOR]].LO || R || Gets the minimum base protection the armour will give.<br />
|-<br />
| [[ARMOR]].HI || R || Gets the maximum base protection the armour will give.<br />
|-<br />
| [[BASEID]] || R || Gets the defname of the item if set, otherwise the ID.<br />
|-<br />
| [[CAN]] || RW || Gets or sets attributes for the item. See can_i_flags in sphere_defs.scp.<br />
|-<br />
| [[DAM]] ''min,max'' || RW || Gets or sets the base damage that the weapon will deal.<br />
|-<br />
| [[DAM]].LO || R || Gets the minimum base damage the weapon will deal.<br />
|-<br />
| [[DAM]].HI || R || Gets the maximum base damage the weapon will deal.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets defname of the item<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID to display as to clients.<br />
|-<br />
| [[DUPEITEM]] || RW || Gets or sets the defname of the item that this is a duplicate/rotation of (see [[DUPELIST]]).<br />
|-<br />
| [[DUPELIST]] ''item_defname, item_defname, ...'' || RW || Gets or sets a comma-separated list of items that this item will cycle through when rotated.<br />
|-<br />
| [[DYE]] || RW || Gets or sets whether or not the item can be dyed using dye tubs (1 or 0).<br />
|-<br />
| [[FLIP]] || RW || Gets or sets whether or not the item automatically rotates when dropped.<br />
|-<br />
| [[HEIGHT]] || RW || Gets or sets the height of the item.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item to inherit property values from.<br />
|-<br />
| [[INSTANCES]] || R || Returns the number of this item that exist in the world.<br />
|-<br />
| [[ISARMOR]] || R || Gets whether or not the item is considered to be armour.<br />
|-<br />
| [[ISWEAPON]] || R || Gets whether or not the item is considered to be a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item will occupy when equipped (1 or 0).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the item.<br />
|-<br />
| [[RANGE]] ''min, max'' || RW || Gets or sets the range of the weapon.<br />
|-<br />
| [[RANGEH]] || R || Gets the maximum range of the weapon.<br />
|-<br />
| [[RANGEL]] || R || Gets the minimum range of the weapon.<br />
|-<br />
| [[REPAIR]] || RW || Gets or sets whether or not the item can be repaired (1 or 0).<br />
|-<br />
| [[REPLICATE]] || RW || Gets or sets whether or not multiple instances of the item can be crafted at once.<br />
|-<br />
| [[RESDISPDNHUE]] || RW || Gets or sets the colour to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESDISPDNID]] || RW || Gets or sets the item ID to display as to clients who don't have a high enough [[RESDISP]] to see the item.<br />
|-<br />
| [[RESLEVEL]] || RW || Gets the minimum [[RESDISP]] required for a client to see the item.<br />
|-<br />
| [[RESMAKE]] || R || Returns the names of the resources needed to craft the item.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.COUNT'' || R || Gets the number of different resources that are needed to craft the item.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to craft the item. (zero-based)<br />
|-<br />
| [[REQSTR]] || RW || Gets or sets the amount of strength needed to equip the item.<br />
|-<br />
| [[SKILL (Item Property)|SKILL]] || RW || Gets or sets the skill that is used with the weapon.<br />
|-<br />
| [[SKILLMAKE]] || RW || Gets or sets the list of skills needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.KEY || R || Gets the name of the nth skill needed to craft the item.<br />
|-<br />
| [[SKILLMAKE]]''.n.VAL || R || Gets the amount of the nth skill needed to craft the item.<br />
|-<br />
| [[SPEED]] || RW || Gets or sets the speed of the weapon.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TDATA1]] || RW || Gets or sets the TDATA1 value of the item.<br />
|-<br />
| [[TDATA2]] || RW || Gets or sets the TDATA2 value of the item.<br />
|-<br />
| [[TDATA3]] || RW || Gets or sets the TDATA3 value of the item.<br />
|-<br />
| [[TDATA4]] || RW || Gets or sets the TDATA4 value of the item.<br />
|-<br />
| [[TEVENTS]] || RW || Gets a list of events attached the item, or adds an event to the item.<br />
|-<br />
| [[TFLAGS]] || R || Gets or sets the flags of the item from tiledata.mul.<br />
|-<br />
| [[TWOHANDS]] || RW || Gets or sets whether or not the item occupies both hands when equipped (layer_hand2)<br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item's type.<br />
|-<br />
| [[VALUE]] || RW || Gets or sets the base value of the item.<br />
|-<br />
| [[WEIGHT]] || RW || Gets or sets the weight of the item.<br />
|}<br />
<br />
==Multi Definitions==<br />
For multi items (t_multi, t_multi_custom, t_ship), the ITEMDEF has additional properties.<br />
<br />
===Properties===<br />
Here is a list of all multi definition properties.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Override&dagger;''' || '''Description'''<br />
|-<br />
| [[BASECOMPONENT]] || R || ?? || Gets how many static components the multi has in the multi.mul file.<br />
|-<br />
| [[BASECOMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's static components directly from the multi.mul file. (ID,DX,DY,DZ,D,VISIBLE)<br />
|-<br />
| [[COMPONENT]] || R || ?? || Gets how many dynamic components have been defined for the multi.<br />
|-<br />
| [[COMPONENT]]''.n.KEY'' || R || ?? || Accesses the multi's dynamic components. (ID,DX,DY,DZ,D)<br />
|-<br />
| [[COMPONENT]] ''item_defname, dx, dy, dz'' || W || ?? || Defines a dynamic component to the multi that will be spawned along with it (e.g. doors and house sign)<br />
|-<br />
| [[MULTIREGION]] ''left, top, right, bottom'' || RW || ?? || Gets or sets the boundaries of the multi (t_multi, t_multi_custom, t_ship).<br />
|-<br />
| [[REGIONFLAGS]] || RW || ?? || Gets or sets the flags that will be set on the multi's region.<br />
|-<br />
| [[SHIPSPEED]] ''period,tiles'' || RW || ?? || Gets or sets the speed and tiles that a ship will move at. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.TILES]] || RW || Y || Gets or sets the tiles that a ship will move at each movement. (t_ship only)<br />
|-<br />
| [[SHIPSPEED.PERIOD]] || RW || Y || Gets or sets the speed that a ship will move at. (t_ship only)<br />
|-<br />
| [[TSPEECH]] || RW || ?? || Gets a list of attached [[SPEECH]] handlers, or adds a handler to the multi.<br />
|}<br />
<br />
'''&dagger;''' Some ITEMDEF properties can be overridden using tags. For example, TAG.OVERRIDE.SHIPSPEED.PERIOD and TAG.OVERRIDE.SHIPSPEED.TILES can be set on individual ships in-game to affect their speed.<br />
<br />
==Examples==<br />
<spherescript>//<br />
// Blue Gold<br />
//<br />
[ITEMDEF i_gold_blue]<br />
ID=i_gold // inherits from i_gold<br />
NAME=Blue Gold // named Blue Gold<br />
TYPE=t_gold // is type t_gold<br />
VALUE=10 // valued at gold<br />
<br />
ON=@Create<br />
COLOR = colors_blue<br />
<br />
<br />
//<br />
// Small Stone and Plaster House (from default script pack)<br />
//<br />
[ITEMDEF 04064] // item ID 0x4064 (in mul files)<br />
DEFNAME=i_multi_house_stone_plaster_small<br />
NAME=Small Stone and Plaster House<br />
TYPE=t_multi<br />
VALUE=43800 // valued at 43800 gold<br />
MULTIREGION=-3,-3,3,4 // size of the region, relative to location of the item<br />
COMPONENT=i_door_wood,0,3,7 // adds a door at 0,3,7 (relative to location of the item)<br />
COMPONENT=i_sign_brass_2,2,4,5 // adds a brass sign at 2,4,5 (relative to location of the item)</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@CombatEnd&diff=8030@CombatEnd2022-10-26T21:12:50Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
This trigger fires when someone is being deleted from my attacker list and I don't have any more viable targets.<br />
<br />
<br />
Fires on:<br />
* [[Characters]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || Myself.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
''No arguments are set for this trigger.''<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
''No return values allowed for this trigger.''<br />
<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]<br />
[[Category: Characters]]<br />
[[Category: Combat]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8029Characters2022-10-26T21:11:28Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[ADDSHIP uid]] || W || X branch only. Adds the given uid to the player's ship. If the player current count of ships is greater than the limit he has, the ship will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DELSHIP uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the ship)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, color, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EFFECTLOCATION]] ''x,y,z,type,itemid,speed,loop,explode,color,render'' || W || X branch only. Similar to the EFFECT command but instead of an object it takes a terrain location as a target.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GETSHIPPOS uid]] || R || Returns the position of the given UID on the ships list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSHIPS]] || RW || X branch only. for Accounts and Chars, when created they read this new setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SHIP.n]] || R || X branch only. Added to access the ship in the Nth position, eg: ship.3.Redeed<br />
|-<br />
| [[SHIPS]] || R || X branch only. Return the ships on the player's list.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TIMERMS]] || W || Set an object timer to elapse after the given number of milliseconds.<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list and I don't have any more viable targets.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Regions&diff=8028Regions2022-10-24T11:06:42Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Regions}}<br />
<br />
__FORCETOC__<br />
Areas in the world, such as dungeons and cities are defined by regions. Accessing regions in scripts can be accomplished using the REGION reference from a [[Characters|character]], [[Items|item]] or [[Map Points|map point]] object, or the AREA.region_id reference from the [[Server|server]] object. The following tables detail the various properties of the region object in SphereServer:<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the CHAR.n reference allows you to access the characters that are attached to the account). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[REGION]] || R || For regions linked to a multi, gets the region that contains the multi region. Only valid for reading values.<br />
|}<br />
<br />
<br />
==Properties and Functions==<br />
Here is a list of all region properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. Properties from the [[AREADEF|region definition]] can also be accessed from the region object. If an attempt is made to execute (not read) a command that does not exist on the region or its definition, then the command will be called on all sectors that touch the region area.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ALLCLIENTS]] ''command'' || W || Executes ''command'' on all clients inside the region boundaries.<br />
|-<br />
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the region that start with the given prefix.<br />
|-<br />
| [[CLIENTS]] || R || Gets the total number of clients that are inside the sectors that touch the region.<br />
|-<br />
| [[COLDCHANCE]] || W || Set the ColdChance to all sectors in this Region.<br />
|-<br />
| [[DEFNAME]] || R || Gets the region's defname.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''+/-regiontype_defname'' || RW || Gets a list of attached region events, or adds or removes a region event to or from the region.<br />
|-<br />
| [[GUARDED]] || RW || Set the region to be Guarded or not.<br />
|-<br />
| [[ISEVENT]]''.regiontype_defname'' || R || Returns 1 if the region has a specified region event attached.<br />
|-<br />
| [[MAGIC]] || RW || Enables or Disables Region_Antimagic_All flag.<br />
|-<br />
| [[MAP]] || R || Gets the map that the region exists on.<br />
|-<br />
| [[MARK]] || RW || Same as RecallIn.<br />
|-<br />
| [[NOBUILD]] || RW || Enables or disables Building in this area (only affects futures houses).<br />
|-<br />
| [[NOPVP]] || RW || Enables or disables PvP in this region.<br />
|-<br />
| [[P]] || RW || Gets or Sets the P coordinates for this area.<br />
|-<br />
| [[RECALLIN]] || RW || Enables or disables Mark & RecallIn flags.<br />
|-<br />
| [[RECT]] || R || Gets the number of rectangles that this region is made from.<br />
|-<br />
| [[RECT]]''.n'' || R || Gets the nth rectangle that this region is made from.<br />
|-<br />
| [[RAINCHANCE]] || W || Sets the RainChance for all sectors inside this region.<br />
|-<br />
| [[RESOURCES]] ''+/-regiontype_defname'' || RW || Gets a list of attached region events, or adds or removes a region event to or from the region.<br />
|-<br />
| [[SAFE]] || RW || Get or Set Safe flag for this region.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the region.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the region's TAGs.<br />
|-<br />
| [[TYPE]] || R || If the region is linked to a multi, returns the multi's [[BASEID]] property.<br />
|-<br />
| [[UID]] || R || Gets the region's unique ID in the world.<br />
|-<br />
| [[UNDERGROUND]] || RW || Gets or sets Underground flag for this region.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all region triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@CliPeriodic]] || Fires multiple times approximately every 30 seconds, for each client in the region.<br />
|-<br />
| [[@Enter]] || Fires when a character enters the region.<br />
|-<br />
| [[@Exit]] || Fires when a character exits the region.<br />
|-<br />
| [[@RegPeriodic]] || Fires once approximately every 30 seconds, as long as there is at least one client in the region.<br />
|-<br />
| [[@ResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@ResourceGather]] || Fires before finishing the gathering skill.<br />
|-<br />
| [[@ResourceTest]] || Fires once for every resource listed in a REGIONTYPE, to check if the player (SRC) can get it. It is called only if the player meets the SKILLMAKE requirements for the item set in REAP.<br />
|-<br />
| [[@Step]] || Fires whenever a character takes a step within the region.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Override_TAGs&diff=8017Override TAGs2022-08-27T23:47:59Z<p>Gorgo: /* Character-based Override TAGs */</p>
<hr />
<div>{{Languages|Override_TAGs}}<br />
<br />
==Override Common Data==<br />
Ever wondered why you can't change for example 'TDATA' values on a per-item basis? Or some default values from Sphere.ini? <br />
<br />
<br />
The reason is simple: The majority of items, characters and situation will not need individual values there and are working fine with the default ones (either hardcoded or set in the INI or the *DEF sections), so it simply would be a waste of memory to store them again on each game object. Therefore for example a single crossbow in the world reads what items it needs as ammunition not from it's "WORLDITEM" data object, but from it's ITEMDEF (the TDATA property). <br />
<br />
<br />
Alas, as time goes by for some stuff it showed reasonable to allow overriding the default values for a single item, character or even region. Nevertheless it still would be a waste of resources to give all crossbows an "ammunition" property what on almost all of them will read: "default". So the Sphere developers decided to store the respective individual changes in TAGs: If the TAG exists it will be used, if not, the default is used. <br />
<br />
<br />
Common to most overrides is the syntax of the TAG's name: '''TAG.OVERRIDE.*''' - where "'''*'''" denotes the name of the respective tag. But there are also some others what were named before this naming scheme was established. <br />
<br />
<br />
<br />
==Item-based Override TAGs==<br />
<br />
{| border="1"<br />
| '''TAG.ALWAYSSEND'''<br />
| When optional flag OF_OsiMultiSight is on, all items inside a multi are not sent until entering the multi. If you want an item to be always sent, set TAG.ALWYASSEND to 1. This tag also can also go under the ITEMDEF section of an item.<br />
|-<br />
| '''TAG.NOSAVE'''<br />
| If set to 1 the object will NOT be saved.<br />
|-<br />
| '''TAG.OVERRIDE.DAMAGETYPE'''<br />
| Sets the damage type for a weapon (ARGN2 in @GetHit trigger).<br />
|-<br />
| '''TAG.OVERRIDE.DROPSOUND'''<br />
| Overrides the sound that will be played when the item is dropped somewhere.<br />
|-<br />
| '''TAG.OVERRIDE_LIGHTID'''<br />
| Overrides TDATA3 for lights (T_LIGHT_LIT, T_LIGHT_OUT). Take notice that there is an underscore in this TAG's name.<br />
|-<br />
| '''TAG.OVERRIDE.MAXITEMS'''<br />
| Overrides the maximum number of items that can be placed into a container (default: 255)<br />
|-<br />
| '''TAG.OVERRIDE.MAXWEIGHT'''<br />
| Overrides the maximum total weight that can be placed into a container.<br />
|-<br />
| '''TAG.OVERRIDE.PRACTICEMAX.SKILL_$skillid'''<br />
| Overrides SKILLPRACTICEMAX setting from Sphere.ini for a particular skill. $skillid is the numeric ID of the skill.<br />
|-<br />
| '''TAG.OVERRIDE.SKILL'''<br />
| Overrides the SKILL property of the ITEMDEF for a weapon.<br />
|-<br />
| '''TAG.OVERRIDE.SPEED'''<br />
| Overrides the SPEED for a weapon.<br />
|-<br />
| '''TAG.OVERRIDE.SOUND_HIT'''<br />
| Overrides the hit sound for a weapon. Take notice that there is an underscore in this TAG's name. (Removed in newer versions and is just AMMOSOUNDHIT=<Val> without the use of Tag.Override.<String>=<Val>)<br />
|-<br />
| '''TAG.OVERRIDE.SOUND_MISS'''<br />
| Overrides the miss sound for a weapon. Take notice that there is an underscore in this TAG's name. (Removed in newer versions and is just AMMOSOUNDMISS=<Val> without the use of Tag.Override.<String>=<Val>)<br />
|}<br />
<br />
==Character-based Override TAGs==<br />
<br />
{| border="1"<br />
| '''TAG.DEATHFLAGS'''<br />
| Changes some death related behaviour. The list of supported flags are in sphere_defs.scp.<br />
|-<br />
| '''TAG.MAXPLAYERPETS'''<br />
| Overrides the maximum number of pets that a player can stable. Default is 10.<br />
|-<br />
| '''TAG.NAME.ALT'''<br />
| Sets an alternative name, useful for incognito effects.<br />
|-<br />
| '''TAG.NAME.HUE'''<br />
| Changes the colour of the name displayed above a character.<br />
|-<br />
| '''TAG.NAME.PREFIX'''<br />
| Sets some text to display before the character's name.<br />
|-<br />
| '''TAG.NAME.SUFFIX'''<br />
| Sets some text to display after the character's name.<br />
|-<br />
| '''TAG.NOSKILLMSG'''<br />
| When set to 1, character will receive the "gainradius_not_met" defmessage (sphere_msgs.scp) when skillgain is aborted due to the GAINRADIUS on a skill.<br />
|-<br />
<br />
| '''TAG.OVERRIDE.MOVERATE'''<br />
| Overrides the MOVERATE property of the CHARDEF.<br />
|-<br />
| '''TAG.OVERRIDE.MOVEDELAY'''<br />
| Overrides completely the moverate checks and setting the next movement to the given timer, eg 'tag.override.moverate=250' makes the npc move each 250 milliseconds when walking. WARNING:* Setting this tag completelly overrides default moverate checks, TAG.OVERRIDE.MOVERATE gets ignored too.<br />
|-<br />
| '''TAG.OVERRIDE.RUNNINGPENALTY'''<br />
| Overrides RUNNINGPENALTY from Sphere.ini<br />
|-<br />
| '''TAG.OVERRIDE.SKILLCAP_$skillid'''<br />
| Overrides skill settings from the character's SKILLCLASS. $skillid is the numeric ID of the skill.<br />
|-<br />
| '''TAG.OVERRIDE.SKILLSUM'''<br />
| Overrides SKILLSUM setting from the character's SKILLCLASS.<br />
|-<br />
| '''TAG.OVERRIDE.SPIDERWEB<br />
| When set to 1, NPC will be able to drop spider webs (for a giant spider, if this set to 1 then it will stop it from dropping webs)<br />
|-<br />
| '''TAG.OVERRIDE.STAMINALOSSATWEIGHT'''<br />
| Overrides STAMINALOSSATWEIGHT from Sphere.ini<br />
|-<br />
| '''TAG.OVERRIDE.STATCAP_$statid'''<br />
| Overrides STR/DEX/INT settings from the character's SKILLCLASS. (0=STR, 1=INT, 2=DEX)<br />
|-<br />
| '''TAG.OVERRIDE.STATSUM<br />
| Overrides STATSUM setting from the character's SKILLCLASS.<br />
|-<br />
| '''TAG.OVERRIDE.TRAINSKILLMAX'''<br />
| Overrides NPCTRAINMAX setting from Sphere.ini<br />
|-<br />
| '''TAG.OVERRIDE.TRAINSKILLMAXPERCENT'''<br />
| Overrides NPCTRAINPERCENT setting from Sphere.ini<br />
|-<br />
| '''TAG.PARTY_AUTODECLINEINVITE'''<br />
| When set to 1, character will automatically decline party invitations.<br />
|-<br />
| '''TAG.PARTY_CANLOOTME'''<br />
| When set to 1, party members will be allow to loot this character without it being counted as a criminal action (linked to the option in the party menu).<br />
|-<br />
| '''TAG.VENDORMARKUP'''<br />
| This value is added to the markup percentage that vendors apply to their buy and sell prices. Since the default markup is 15%, this means that a vendor will sell something worth 100gp at 115gp and buy it back for 85gp. If you set this tag to -15 the markup will be cancelled out to 0%, or you can raise/lower it if you want your vendor to sell things at a higher/lower price.<br />
|}<br />
<br />
==Region-based Override TAGs==<br />
<br />
{| border="1"<br />
| '''TAG.ANNOUNCEMENT'''<br />
| Sets a message to be announced to all who enters the region if REGION_FLAG_ANNOUNCE is set.<br />
|-<br />
| '''TAG.GUARDOWNER'''<br />
| Specifies the owner of the region's guards (ex: "The City")<br />
|-<br />
| '''TAG.OVERRIDE.GUARDS'''<br />
| Specifies the character that will be summoned when guards are called in the region, overriding the <tt>guards {c_h_guard 1 c_h_guard_f 1}</tt> defname in sphere_defs.scp<br />
|-<br />
| '''TAG.RED'''<br />
| Sets the region as a safe place for evil. Murders are considered normal here.<br />
If region is guarded, guards will be red and protect evil players.<br />
|-<br />
| '''TAG.VENDORMARKUP'''<br />
| This value is added to the markup percentage that vendors apply to their buy and sell prices. Since the default markup is 15%, this means that a vendor will sell something worth 100gp at 115gp and buy it back for 85gp. If you set this tag to -15 the markup will be cancelled out to 0%, or you can raise/lower it if you want your vendor to sell things at a higher/lower price. If the vendor has this tag set directly on them then this region TAG will not be used.<br />
|}<br />
<br />
==Removed Override TAGs==<br />
{| border="1"<br />
| '''OLD TAG'''<br />
| '''NEW Variable'''<br />
| '''Description'''<br />
|-<br />
| '''TAG.BREATH.DAM<br />
| Breath.Dam<br />
| Overrides Damage done from fire breathing.<br />
|-<br />
| '''TAG.RANGE<br />
| Range<br />
| Range is now writable for both characters and items.<br />
|-<br />
| '''TAG.OVERRIDE.SHIPSPEED.PERIOD<br />
| ShipSpeed.Period<br />
| Overrides SHIPSPEED.PERIOD for a ship (the length of time it takes for the ship to move one step, in tenths of a second).<br />
|-<br />
| '''TAG.OVERRIDE.SHIPSPEED.TILES<br />
| ShipSpeed.Tiles<br />
| Overrides the amount of tiles moved in each tick.<br />
|-<br />
| '''TAG.OVERRIDE.DOORSOUND_CLOSE<br />
| DOORCLOSESOUND<br />
| Overrides the sound that will be played for a door when it is being closed.<br />
|-<br />
| '''TAG.OVERRIDE.DOORSOUND_OPEN<br />
| DOOROPENSOUND<br />
| Overrides the sound that will be played for a door when it is being opened.<br />
|-<br />
| '''TAG.OVERRIDE.PORTCULISSOUND<br />
| PORTCULISSOUND<br />
| Overrides the sound that will be played for a portcullis when it is used.<br />
|}<br />
[[Category: Articles]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8016Characters2022-08-27T23:42:53Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[ADDSHIP uid]] || W || X branch only. Adds the given uid to the player's ship. If the player current count of ships is greater than the limit he has, the ship will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DELSHIP uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the ship)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, color, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EFFECTLOCATION]] ''x,y,z,type,itemid,speed,loop,explode,color,render'' || W || X branch only. Similar to the EFFECT command but instead of an object it takes a terrain location as a target.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GETSHIPPOS uid]] || R || Returns the position of the given UID on the ships list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSHIPS]] || RW || X branch only. for Accounts and Chars, when created they read this new setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SHIP.n]] || R || X branch only. Added to access the ship in the Nth position, eg: ship.3.Redeed<br />
|-<br />
| [[SHIPS]] || R || X branch only. Return the ships on the player's list.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TIMERMS]] || W || Set an object timer to elapse after the given number of milliseconds.<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Server&diff=8015Server2022-08-27T23:40:02Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Server}}<br />
<br />
__FORCETOC__<br />
The server object is a global object that can be accessed from any script, by using the SERV reference. The following tables detail the various properties of the server in SphereServer:<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the CHAR.n reference allows you to access the characters that are attached to the account). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACCOUNT]]''.n'' || R || Gets the nth [[Accounts|account]] on the server. (zero-based)<br />
|-<br />
| [[ACCOUNT]]''.name'' || R || Gets the [[Accounts|account]] with the specified name.<br />
|-<br />
| [[AREA]]''.defname'' || R || Gets the [[Regions|region]] with the specified defname.<br />
|-<br />
| [[CHARDEF (Reference)|CHARDEF]]''.defname'' || R || Gets the [[CHARDEF|character definition]] for ''defname''.<br />
|-<br />
| [[DEF]]''.defname'' || R || Gets the value for ''defname''. Def0.defname can also be used similar to tag0 and ctag0.<br />
|-<br />
| [[CLIENT]]''.n'' || R || Gets the nth [[Characters#Clients|client]] on the server. (zero-based)<br />'''Note:''' The nth client may not be an ingame player character, check &lt;CLIENT.n&gt; first as it returns 1 for ingame clients and 0 for non-player clients.<br />
|-<br />
| [[GMPAGE]]''.n'' || R || Gets the nth [[GM Pages|GM page]] on the server. (zero-based)<br />
|-<br />
| [[GUILDSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|guild stone]] on the server. (zero-based)<br />
|-<br />
| [[ITEMDEF (Reference)|ITEMDEF]]''.defname'' || R || Gets the [[ITEMDEF|item definition]] for ''defname''.<br />
|-<br />
| [[LASTNEWCHAR]] || R || Gets the last [[Characters|character]] created on the server.<br />
|-<br />
| [[LASTNEWITEM]] || R || Gets the last [[Items|item]] created on the server.<br />
|-<br />
| [[MAP]]''(x, y, map)''<br />[[MAP]]''(x, y, z, map)'' || R || Gets the [[Map Points|map point]] for a specified location.<br />
|-<br />
| [[REGIONRESOURCE (Reference)|REGIONRESOURCE]]''.defname'' || R || Gets the [[REGIONRESOURCE|region resource definition]] for ''defname''.<br />
|-<br />
| [[REGIONTYPE (Reference)|REGIONTYPE]]''.defname'' || R || Gets the [[REGIONTYPE|region type definition]] for ''defname''.<br />
|-<br />
| [[ROOM (Reference)|ROOM]]''.defname'' || R || Gets the [[Rooms|room]] with the specified defname.<br />
|-<br />
| [[SKILL (Reference)|SKILL]]''.defname'' || R || Gets the [[SKILL|skill definition]] for ''defname''.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]]''.defname'' || R || Gets the [[SKILLCLASS|skillclass]] for ''defname''.<br />
|-<br />
| [[SPAWN (Reference)|SPAWN]]''.defname'' || R || Gets the [[SPAWN|spawn group]] for ''defname''.<br />
|-<br />
| [[SPELL (Reference)|SPELL]]''.defname'' || R || Gets the [[SPELL|spell definition]] for ''defname''.<br />
|-<br />
| [[SPELL (Reference)|SPELL]]''.n'' || R || Gets the nth [[SPELL|spell definition]], ordered by skill requirements (1-based, ascending).<br />
|-<br />
| (X only)[[TILEDATA (Reference)|TILEDATA]].TERRAIN(''id'').''attribute'' || R || Gets the tiledata ''attribute'' of ''id'' terrain.<br />
''attribute'' can be one of: FLAGS,UNK,INDEX,NAME.<br />
|-<br />
| (X only)[[TILEDATA (Reference)|TILEDATA]].ITEM(''id'').''attribute'' || R || Gets the tiledata ''attribute'' of ''id'' item.<br />
''attribute'' can be one of: FLAGS,WEIGHT,LAYER,UNK11,ANIM,HUE,LIGHT,HEIGHT,NAME.<br />
|-<br />
| [[TOWNSTONES]]''.n'' || R || Gets the nth [[Special Items#Guild.2FTown_Stones|town stone]] on the server. (zero-based)<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. Settings from Sphere.ini can also be accessed from the server object, but they are not listed in this table.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACCOUNT]] ADD ''name password'' || W || Creates an account with the specified name and password.<br />
|-<br />
| [[ACCOUNT]] ADDMD5 ''name hash'' || W || Creates an account with the specified name and MD5 password hash.<br />
|-<br />
| [[ACCOUNT]] BLOCKED ''days command'' || W || Executes ''command'' on all accounts that have been unused for ''days'' days and are currently blocked.<br />
|-<br />
| [[ACCOUNT]] JAILED ''days command'' || W || Executes ''command'' on all accounts that have been unused for ''days'' days and are currently jailed.<br />
|-<br />
| [[ACCOUNT]] UNUSED ''days command'' || W || Executes ''command'' on all accounts that have been unused for ''days'' days.<br />
|-<br />
| [[ACCOUNT]] UPDATE || W || Saves the accounts to file.<br />
|-<br />
| [[ACCOUNT]] ''name command'' || W || Executes ''command'' on the account with the specified name.<br />
|-<br />
| [[ACCOUNTS]] || RW || Gets or sets the number of accounts on the server.<br />
|-<br />
| [[ALLCLIENTS]] ''command'' || W || Executes ''command'' on all online player characters.<br />
|-<br />
| [[B]] ''message'' || W || Broadcasts ''message'' to all clients on the server.<br />
|-<br />
| [[BLOCKIP]] ''address, time'' || W || Blocks an IP address for ''time'', in tenths of a second (-1 = permanent).<br />
|-<br />
| [[CHARS]] || RW || Gets or sets the number of characters on the server.<br />
|-<br />
| [[CLEARLISTS]] ''mask'' || W || Removes all LISTs whose name contains ''mask''.<br />
|-<br />
| [[CLEARVARS]] ''prefix'' || W || Removes all VARs that start with the given prefix.<br />
|-<br />
| [[CLIENTS]] || R || Gets the total number of connected clients.<br />
|-<br />
| [[CONSOLE]] ''command'' || W || Executes ''command'' as if it had been typed directly into the server console.<br />
|-<br />
| [[EXPORT]] ''file, flags, distance'' || W || Exports all objects within ''distance'' tiles of SRC to a file. (Flags: 1 = Items, 2 = Characters, 3 = Both)<br />
|-<br />
| [[GARBAGE]] || W || Forces an immediate garbage collection (checks for invalid objects and fixes them if possible, or else removes them).<br />
|-<br />
| [[GMPAGES]] || R || Returns the total number of GM pages.<br />
|-<br />
| [[GUILDS]] || R || Returns the total number of guild ''and'' town stones.<br />
|-<br />
| [[GUILDSTONES]].COUNT || R || Returns the total number of guild stones on the server.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether player speech is logged to server console and log file.<br />
|-<br />
| [[IMPORT]] ''file, flags, distance'' || W || Imports previously exported items that were within ''distance'' tiles. (Flags: 1 = Items, 2 = Characters, 3 = Both)<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to SRC.<br />
|-<br />
| [[ITEMS]] || RW || Gets or sets the number of items on the server.<br />
|-<br />
| [[LOAD]] ''file'' || W || Loads a script file.<br />
|-<br />
| [[LOG]] ''message'' || W || Logs ''message'' to server console and logs.<br />
|-<br />
| [[LOOKUPSKILL]] ''skill_name'' || R || Looks up a skill name or key, and returns its skill number.<br />
|-<br />
| [[MAP]]''.map_num.''ALLSECTORS ''command'' || W || Executes ''command'' on all sectors of a map.<br />
|-<br />
| [[MAP]]''.map_num.''SECTOR.''sector_num command'' || RW || Executes ''command'' on sector ''sector_num'' of a map.<br />
|-<br />
| [[MAPLIST]]''.map_num'' || R || Returns 1 if ''map_num'' is a valid map number.<br />
|-<br />
| [[MAPLIST]]''.map_num''.BOUND.X || R || Returns the maximum X coordinate for a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.BOUND.Y || R || Returns the maximum Y coordinate for a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.CENTER.X || R || Returns the central X coordinate of a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.CENTER.Y || R || Returns the central Y coordinate of a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.SECTOR.COLS || R || Returns the number of sector columns on a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.SECTOR.QTY || R || Returns the number of sectors on a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.SECTOR.ROWs || R || Returns the number of sector rows on a map.<br />
|-<br />
| [[MAPLIST]]''.map_num''.SECTOR.SIZE || R || Returns the size of the sectors on a map.<br />
|-<br />
| [[MEM]] || R || Returns the total amount of memory being used, in kilobytes.<br />
|-<br />
| [[PRINTLISTS]] ''LOG'' || W || Displays a list of all LISTs to SRC, or the server console.<br />
|-<br />
| [[REGEN]]0 || RW || Gets or sets the length of time it takes for characters to regenerate 1 health point, in seconds.<br />
|-<br />
| [[REGEN]]1 || RW || Gets or sets the length of time it takes for characters to regenerate 1 mana point, in seconds.<br />
|-<br />
| [[REGEN]]2 || RW || Gets or sets the length of time it takes for characters to regenerate 1 stamina point, in seconds.<br />
|-<br />
| [[REGEN]]3 || RW || Gets or sets the length of time it takes for characters to lose 1 food point, in seconds.<br />
|-<br />
| [[RESPAWN]] || W || Respawns all dead NPCs (not corpses) in the world.<br />
|-<br />
| [[RESTOCK]] || W || Restocks all NPCs in the world.<br />
|-<br />
| [[RESTORE]] ''file, account_name, character_name'' || W || Restores a player character from a backup save.<br />
|-<br />
| [[RESYNC]] || W || Checks all script files for any changes made since they were last loaded.<br />
|-<br />
| [[RTICKS]] || R || Returns the real-world time, as a timestamp.<br />
|-<br />
| [[RTICKS]].FORMAT ''timestamp, format'' || R || Returns the real-world timestamp as a formatted datetime string.<br />
|-<br />
| [[RTICKS]].FROMTIME ''year, month, day, hour, minutes, seconds'' || R || Returns the specified real-world time, as a timestamp.<br />
|-<br />
| [[RTIME]] || R || Returns the real-world time, as a formatted string.<br />
|-<br />
| [[RTIME]].FORMAT ''format'' || R || Returns the real-world time, as a formatted string.<br />
More information : [[Serv.rtime.format]]<br />
|-<br />
| [[SAVE]] ''force_immediate'' || W || Begins a world save. If background saving is enabled, ''force_immediate'' can be used to force a foreground save.<br />
|-<br />
| [[SAVECOUNT]] || R || Returns the number of world saves that have taken place.<br />
|-<br />
| [[SAVESTATICS]] || W || Performs a statics save.<br />
|-<br />
| [[SHRINKMEM]] || W || Temporarily reduces memory usage.<br />
|-<br />
| [[SHUTDOWN]] ''time'' || W || Schedules a server shutdown in ''time'' minutes.<br />
|-<br />
| [[SYSCMD]] ''cmd'' || W || Executes ''cmd'' and waits for it to finish executing. Returns <0 if an error occurred. Requires OF_FileCommands.<br />
|-<br />
| [[SYSSPAWN]] ''cmd'' || W || Executes ''cmd'' and does not wait for the program to finish executing. Returns <0 if an error occurred. Requires OF_FileCommands.<br />
|-<br />
| [[TICKPERIOD]] || R || Returns how much server ticks are in a real-world second.<br />
|-<br />
| [[TIME]] || R || Returns the total server uptime, in tenths of a second.<br />
|-<br />
| [[TIMEHIRES]] || R || X branch only. Returns the internal timer in milliseconds.<br />
|-<br />
| [[TIMEUP]] || R || Returns the server uptime, as second.<br />
|-<br />
| [[TOWNSTONES]].COUNT || R || Returns the total number of town stones on the server.<br />
|-<br />
| [[UNBLOCKIP]] ''address'' || W || Unblocks a previously blocked IP address.<br />
|-<br />
| [[VARLIST]] ''LOG'' || W || Displays a list of all VARs to SRC, or the server console.<br />
|-<br />
| [[VERSION]] || R || Returns the SphereServer version.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8014Characters2022-08-27T23:35:11Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[ADDSHIP uid]] || W || X branch only. Adds the given uid to the player's ship. If the player current count of ships is greater than the limit he has, the ship will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DELSHIP uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the ship)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, color, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EFFECTLOCATION]] ''x,y,z,type,itemid,speed,loop,explode,color,render'' || W || X branch only. Similar to the EFFECT command but instead of an object it takes a terrain location as a target.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GETSHIPPOS uid]] || R || Returns the position of the given UID on the ships list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSHIPS]] || RW || X branch only. for Accounts and Chars, when created they read this new setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SHIP.n]] || R || X branch only. Added to access the ship in the Nth position, eg: ship.3.Redeed<br />
|-<br />
| [[SHIPS]] || R || X branch only. Return the ships on the player's list.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=EFFECTLOCATION&diff=8013EFFECTLOCATION2022-08-27T23:34:27Z<p>Gorgo: /* Description */</p>
<hr />
<div>=Usage=<br />
'''EFFECTLOCATION x,y,z,type, item_id, speed, loop, explode, colour(hue), rendermode'''<br />
<br />
Example:<br />
[FUNCTION testLocationZ]<br />
effectLocation <p.x>,<p.y>,<height>+1,0,i_sword_long,1,0,0,colors_red,3<br />
<br />
=Description=<br />
<br />
X branch only. x,y,z are de coordinates where the effect will show on the ground. Type is a number 0 or 2 from the table below (other effects will not be played, only effect 0(bolt) and 2(ground level) seems valid, probably cause they don't accept a map point). Item_id is the base id (this must be a "base" item ID - which you can identify as an [ITEMDEF 0xxx] where xxx is a number not a name) of the item or animation. If the ID is a animation, you likely want to use the first id of the animation loop. Speed is a number determining the speed of the animation and the travel speed if it's a projectile, with 1 being the slowest and higher numbers being faster. Loop specifies the time the animation will play, 16 is a good default. This is NOT frames of animation, as a high speed results in more frames per given loop setting. Explode is a boolean defining whether the projectile should make an explosion animation when reaching the character.<br />
<br />
=EffectLocation Types=<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Effect Number''' || '''Short''' || '''Long Description'''<br />
|-<br />
| 0 || Standard flying object || The object will follow its target until it hits, and then explode if that flag is set||<br />
|-<br />
| 2 || Ground-based effect || This effect will stay at a particular point on the map until it expires. As a result, it will appear lower than a type 3 effect. This is the only way to get an effect onto an item.||<br />
|-<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=EFFECTLOCATION&diff=8012EFFECTLOCATION2022-08-27T23:27:14Z<p>Gorgo: /* Description */</p>
<hr />
<div>=Usage=<br />
'''EFFECTLOCATION x,y,z,type, item_id, speed, loop, explode, colour(hue), rendermode'''<br />
<br />
Example:<br />
[FUNCTION testLocationZ]<br />
effectLocation <p.x>,<p.y>,<height>+1,0,i_sword_long,1,0,0,colors_red,3<br />
<br />
=Description=<br />
<br />
x,y,z are de coordinates where the effect will show on the ground. Type is a number 0 or 2 from the table below (other effects will not be played, only effect 0(bolt) and 2(ground level) seems valid, probably cause they don't accept a map point). Item_id is the base id (this must be a "base" item ID - which you can identify as an [ITEMDEF 0xxx] where xxx is a number not a name) of the item or animation. If the ID is a animation, you likely want to use the first id of the animation loop. Speed is a number determining the speed of the animation and the travel speed if it's a projectile, with 1 being the slowest and higher numbers being faster. Loop specifies the time the animation will play, 16 is a good default. This is NOT frames of animation, as a high speed results in more frames per given loop setting. Explode is a boolean defining whether the projectile should make an explosion animation when reaching the character.<br />
<br />
=EffectLocation Types=<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Effect Number''' || '''Short''' || '''Long Description'''<br />
|-<br />
| 0 || Standard flying object || The object will follow its target until it hits, and then explode if that flag is set||<br />
|-<br />
| 2 || Ground-based effect || This effect will stay at a particular point on the map until it expires. As a result, it will appear lower than a type 3 effect. This is the only way to get an effect onto an item.||<br />
|-<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=EFFECTLOCATION&diff=8011EFFECTLOCATION2022-08-27T23:25:52Z<p>Gorgo: /* Effect Types */</p>
<hr />
<div>=Usage=<br />
'''EFFECTLOCATION x,y,z,type, item_id, speed, loop, explode, colour(hue), rendermode'''<br />
<br />
Example:<br />
[FUNCTION testLocationZ]<br />
effectLocation <p.x>,<p.y>,<height>+1,0,i_sword_long,1,0,0,colors_red,3<br />
<br />
=Description=<br />
<br />
x,y,z are de coordinates where the effect will show on the ground. Type is a number 0-3 from the table below. Item_id is the base id (this must be a "base" item ID - which you can identify as an [ITEMDEF 0xxx] where xxx is a number not a name) of the item or animation. If the ID is a animation, you likely want to use the first id of the animation loop. Speed is a number determining the speed of the animation and the travel speed if it's a projectile, with 1 being the slowest and higher numbers being faster. Loop specifies the time the animation will play, 16 is a good default. This is NOT frames of animation, as a high speed results in more frames per given loop setting. Explode is a boolean defining whether the projectile should make an explosion animation when reaching the character.<br />
<br />
=EffectLocation Types=<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Effect Number''' || '''Short''' || '''Long Description'''<br />
|-<br />
| 0 || Standard flying object || The object will follow its target until it hits, and then explode if that flag is set||<br />
|-<br />
| 2 || Ground-based effect || This effect will stay at a particular point on the map until it expires. As a result, it will appear lower than a type 3 effect. This is the only way to get an effect onto an item.||<br />
|-<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=EFFECTLOCATION&diff=8010EFFECTLOCATION2022-08-27T23:23:59Z<p>Gorgo: /* Usage */</p>
<hr />
<div>=Usage=<br />
'''EFFECTLOCATION x,y,z,type, item_id, speed, loop, explode, colour(hue), rendermode'''<br />
<br />
Example:<br />
[FUNCTION testLocationZ]<br />
effectLocation <p.x>,<p.y>,<height>+1,0,i_sword_long,1,0,0,colors_red,3<br />
<br />
=Description=<br />
<br />
x,y,z are de coordinates where the effect will show on the ground. Type is a number 0-3 from the table below. Item_id is the base id (this must be a "base" item ID - which you can identify as an [ITEMDEF 0xxx] where xxx is a number not a name) of the item or animation. If the ID is a animation, you likely want to use the first id of the animation loop. Speed is a number determining the speed of the animation and the travel speed if it's a projectile, with 1 being the slowest and higher numbers being faster. Loop specifies the time the animation will play, 16 is a good default. This is NOT frames of animation, as a high speed results in more frames per given loop setting. Explode is a boolean defining whether the projectile should make an explosion animation when reaching the character.<br />
<br />
=Effect Types=<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Effect Number''' || '''Short''' || '''Long Description'''<br />
|-<br />
| 0 || Standard flying object || The object will follow its target until it hits, and then explode if that flag is set||<br />
|-<br />
| 1 || Lightning effect || This is the only way to achieve the lightning effect in-game ||<br />
|-<br />
| 2 || Ground-based effect || This effect will stay at a particular point on the map until it expires. As a result, it will appear lower than a type 3 effect. This is the only way to get an effect onto an item.||<br />
|-<br />
| 3 ||Character-based effect || This effect will follow the character as he moves, the way a flamestrike does when the spell is cast. The bottom of the effect is somewhere around the character's knees.<br />
|-<br />
| 4 ||Flash effect || (New 6+ (needs verification)) Clients Only) Provides a screen-wide effect. All other parameters besides Item Id is ignored. Item Id controls the flash type:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Item Id''' || '''Effect''' || '''Description'''<br />
|-<br />
| 0 || Fade to Black (Slow) || Fades the screen to black before returning to normal similar to the death effect found on some client versions<br />
|-<br />
| 1 || Fade to White (Slow) || Fades the screen slowly to complete white followed by a return to normal<br />
|-<br />
| 2 || Fade to white (Fast) || Fades the screen quickly to complete white followed by a return to normal (lightning flash type effect)<br />
|-<br />
| 3 || Fade to White then Black (Slow) || Fades to complete white then to black. Behaves as if effect 1 is played immediately followed by effect 0.<br />
|-<br />
| 4 || Fade to Black (Fast) || Fades the screen quickly to complete black followed by a return to normal<br />
|}<br />
<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=EFFECTLOCATION&diff=8009EFFECTLOCATION2022-08-27T23:22:50Z<p>Gorgo: Created page with "=Usage= '''EFFECTLOCATION x,y,z,type, item_id, speed, loop, explode, colour(hue), rendermode''' =Description= x,y,z are de coordinates where the effect will show on the grou..."</p>
<hr />
<div>=Usage=<br />
'''EFFECTLOCATION x,y,z,type, item_id, speed, loop, explode, colour(hue), rendermode'''<br />
<br />
=Description=<br />
<br />
x,y,z are de coordinates where the effect will show on the ground. Type is a number 0-3 from the table below. Item_id is the base id (this must be a "base" item ID - which you can identify as an [ITEMDEF 0xxx] where xxx is a number not a name) of the item or animation. If the ID is a animation, you likely want to use the first id of the animation loop. Speed is a number determining the speed of the animation and the travel speed if it's a projectile, with 1 being the slowest and higher numbers being faster. Loop specifies the time the animation will play, 16 is a good default. This is NOT frames of animation, as a high speed results in more frames per given loop setting. Explode is a boolean defining whether the projectile should make an explosion animation when reaching the character.<br />
<br />
=Effect Types=<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Effect Number''' || '''Short''' || '''Long Description'''<br />
|-<br />
| 0 || Standard flying object || The object will follow its target until it hits, and then explode if that flag is set||<br />
|-<br />
| 1 || Lightning effect || This is the only way to achieve the lightning effect in-game ||<br />
|-<br />
| 2 || Ground-based effect || This effect will stay at a particular point on the map until it expires. As a result, it will appear lower than a type 3 effect. This is the only way to get an effect onto an item.||<br />
|-<br />
| 3 ||Character-based effect || This effect will follow the character as he moves, the way a flamestrike does when the spell is cast. The bottom of the effect is somewhere around the character's knees.<br />
|-<br />
| 4 ||Flash effect || (New 6+ (needs verification)) Clients Only) Provides a screen-wide effect. All other parameters besides Item Id is ignored. Item Id controls the flash type:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Item Id''' || '''Effect''' || '''Description'''<br />
|-<br />
| 0 || Fade to Black (Slow) || Fades the screen to black before returning to normal similar to the death effect found on some client versions<br />
|-<br />
| 1 || Fade to White (Slow) || Fades the screen slowly to complete white followed by a return to normal<br />
|-<br />
| 2 || Fade to white (Fast) || Fades the screen quickly to complete white followed by a return to normal (lightning flash type effect)<br />
|-<br />
| 3 || Fade to White then Black (Slow) || Fades to complete white then to black. Behaves as if effect 1 is played immediately followed by effect 0.<br />
|-<br />
| 4 || Fade to Black (Fast) || Fades the screen quickly to complete black followed by a return to normal<br />
|}<br />
<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8008Characters2022-08-27T23:19:54Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[ADDSHIP uid]] || W || X branch only. Adds the given uid to the player's ship. If the player current count of ships is greater than the limit he has, the ship will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DELSHIP uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the ship)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, color, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EFFECTLOCATION]] ''x,y,z,type,itemid,speed,loop,explode,color,render'' || W || similar to the EFFECT command but instead of an object it takes a terrain location as a target.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GETSHIPPOS uid]] || R || Returns the position of the given UID on the ships list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSHIPS]] || RW || X branch only. for Accounts and Chars, when created they read this new setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SHIP.n]] || R || X branch only. Added to access the ship in the Nth position, eg: ship.3.Redeed<br />
|-<br />
| [[SHIPS]] || R || X branch only. Return the ships on the player's list.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8007Characters2022-08-27T23:19:01Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[ADDSHIP uid]] || W || X branch only. Adds the given uid to the player's ship. If the player current count of ships is greater than the limit he has, the ship will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DELSHIP uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the ship)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, color, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EFFECTLOCATION x,y,z,type,itemid,speed,loop,explode,color,render]] || W || similar to the EFFECT command but instead of an object it takes a terrain location as a target.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GETSHIPPOS uid]] || R || Returns the position of the given UID on the ships list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSHIPS]] || RW || X branch only. for Accounts and Chars, when created they read this new setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SHIP.n]] || R || X branch only. Added to access the ship in the Nth position, eg: ship.3.Redeed<br />
|-<br />
| [[SHIPS]] || R || X branch only. Return the ships on the player's list.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HouseDesignCommitItem&diff=8006@HouseDesignCommitItem2022-08-27T23:13:00Z<p>Gorgo: /* Description */</p>
<hr />
<div>==Description==<br />
X branch only. This trigger fires when an item is about to commit when using house designer.<br />
<br />
<br />
Fires on:<br />
* [[Items]]<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Items|item]] being commited.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| local.id || I || ID of the item<br />
|-<br />
| local.p.x || I || The x location of the item<br />
|-<br />
| local.p.y || I || The y location of the item<br />
|-<br />
| local.p.z || I || The z location of the item<br />
|-<br />
| local.visible || I || 0 or 1 (non-visible items are things like doors and signs) return false will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.<br />
<br />
|}<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Prevents the item from being commited.<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HouseDesignBegin&diff=8005@HouseDesignBegin2022-08-27T23:12:47Z<p>Gorgo: /* Description */</p>
<hr />
<div>==Description==<br />
X branch only. This trigger is called when the player enters on design mode in a t_custom_multi multi.<br />
<br />
<br />
Fires on:<br />
* [[Multis]]<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The multi about to design.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARGN1 || IO || If set to 1 Redeeds all addons on the multi. (Default = 1)<br />
|-<br />
| ARGN2 || IO || If set to 1 Transfer all Locked Items and Secured containers to the Moving Crate (default = 0)<br />
|-<br />
| ARGN3 || IO || If set to 1 Ejects from the house all chars inside the house excepting the player entering in design mode, if set to 2 Ejects everyone from the house, if set to 0 doesn't eject anyone.<br />
All chars ejected will be moved to the House sign.<br />
|}<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Forces the char to exit Customize mode.<br />
WARNING: Forcing the char to exit here and setting argn1=0 in @HouseDesignExit will make it enter in customize mode, exit, enter... infinitelly, hence crashing the server with an infinite loop.<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Items&diff=8004Items2022-08-27T23:12:31Z<p>Gorgo: /* Triggers */</p>
<hr />
<div>{{Languages|Items}}<br />
<br />
__FORCETOC__<br />
Generally speaking, there are two types of "things" in the game; characters and items. Compared to characters, items are very complex. Items have a number of different uses, for example a sword is an item that players can see and equip to increase the damage they can do in combat. Some items in the game can not be seen by the players, but they have as much impact on the player as their sword, for example, a memory item is equipped every time a player is under the effects of a spell. Some [[Special Items|special types of item]] also have additional properties that can be accessed via scripts. The following tables detail the various properties of items in SphereServer:<br />
<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside. When an item's CONT is changed, it bypasses the typical behavior (for example, you can force an item to be "in" a container and bypass @dropon triggers, or force an item to be equipped to a player and bypass @equiptest and @equip triggers -- but be careful, because in this second scenario it may end up in an invalid layer.)<br />
|-<br />
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to. Note, you can make circular LINK's, but a single item cannot be linked to more than one other item.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the object is in.<br />
|-<br />
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
! Name !! '''Read/Write''' !! '''Description'''<br />
|-<br />
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given Magery circle to the spellbook.<br />
|-<br />
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOSOUNDHIT]] || RW || Overrides the hit sound on weapons.<br />
|-<br />
| [[AMMOSOUNDMISS]] || RW || Overrides the miss sound on weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[AMOUNT]] || RW || Gets the amount of items this icon represents (e.g. a pile of gold or any stacked item).<br />
|-<br />
| [[ATTR]] || RW || Gets or sets the item's attribute flags.<br />
|-<br />
| [[BOUNCE]] || W || Moves the item to SRC's backpack (triggering the ''you put the item in your pack'' message.<br />
|-<br />
| [[CAN]] || RW || Gets or Sets the can_flags (Setting can be only done in the Itemdef itself). Only readable in X branch.<br />
|-<br />
| [[CANMASK]] || RW || Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the item.<br />
|-<br />
| [[CANSEELOS]] ''point_or_uid'' || R || Returns 1 if SRC has line of sight to the item or character (uid) or point (location).<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags,point_or_uid'' || R || Returns 1 if SRC has line of sight to the item. The ''flags'' are defined in the los_flags section of the sphere_defs.scp file and can be used to modify what tests take place. The ''point_or_uid'' is an object or position that can be used to test line of sight to something other than SRC. Note, the delimiter for FLAG values is ;<br />
|-<br />
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the object's hue.<br />
|-<br />
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.<br />
|-<br />
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.<br />
|-<br />
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)<br />
|-<br />
| [[CONTP]] || RW || Gets or sets the position of the item within its container.<br />
|-<br />
| [[DAMAGE]] ''chance, type, source'' || W || If ''chance'' is greater than (Rand(maxhits*16)), inflicts damage of ''type'' (the damage type flags are defined in the sphere_defs.scp file) upon the item. You can optionally specify the ''source'' of the damage.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.<br />
|-<br />
| [[DECAY]] ''time'' || W || Sets the decay timer (in tenths of a second) for the item.<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.<br />
|-<br />
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and SRC. If ''point_or_uid'' is used, SRC can be replaced with a map location or another object.<br />
|-<br />
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.<br />
|-<br />
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.<br />
|-<br />
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.<br />
|-<br />
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.<br />
|-<br />
| [[DROP]] || W || Drops the item to the ground.<br />
|-<br />
| [[DUPE]] || W || Clones the item.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EQUIP]] || W || Equips the item to SRC.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[FIX]] || W || Re-aligns the item or character's Z level to ground level (if items are on the ground, the top item's ''Z+HEIGHT'' is used).<br />
|-<br />
| [[FLIP]] || W || Rotates the item clockwise.<br />
|-<br />
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.<br />
|-<br />
| [[HEIGHT]] || R || Gets the height of the item.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the item to SRC.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player character.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped (possible layers are defined in the sphere_defs.scp file).<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating if it is clothing, armor, or a shield. This gets or sets a modifier for the item's damage if it is a weapon type.<br />
|-<br />
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.<br />
|-<br />
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.<br />
|-<br />
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.<br />
|-<br />
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.<br />
|-<br />
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.<br />
|-<br />
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.<br />
|-<br />
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.<br />
|-<br />
| [[MOVE]] ''direction amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position. Possible ''direction'' values are N,S,W, or E. Note, you can combine directions (like: MOVE SW 1) but nonsensical directions (like: MOVE WE 2) have the nonsense removed.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the object to a specific location (note, the AREADEF or ROOMDEF must have a P defined).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the object's name.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[REMOVE]] || W || Deletes the object.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside a container.<br />
|-<br />
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the object speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || Makes the object speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC. ''F'' makes the ''function'' available, and when added, the function name must be the 1st argument. ''M'' allows you to place a ''multi'' item, in which case the multi number must be passed as an argument. ''G'' forces the target to only be the ground. ''W'' checks the criminal status of the player before (or after?) the target selection is made.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Schedules a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the object.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the item. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TRIGGER]] ''trig_name, trigger_argtype, argument1, argument2, ...'' || R || Fires a custom trigger (trig_name), allowing you to define the behavior of the arguments (the types are defined under trigger_argtype in the sphere_defs.scp file). The result of the trigger's RETURN value is returned. For example:<br />
LOCAL.result=<TRIGGER @CustomTrigger,<DEF.tat_as_argn>,1,2,3><br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item type. You can use built-in or custom [[TYPEDEF]]s as a value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the item to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USESCUR]] || W || X branch only. Gets or sets the current uses of an item. Only partially supported.<br />
|-<br />
| [[USESMAX]] || W || X branch only. Gets or sets the maximum uses of an item. Only partially supported.<br />
|-<br />
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the item.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the item.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all item triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Buy]] || Fires when the item is being bought from a vendor.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips are about to be sent to a client.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Damage]] || Fires when the item receives damage.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@DropOn_Char]] || Fires when the item has been dropped on to a character.<br />
|-<br />
| [[@DropOn_Ground]] || Fires when the item has been dropped on to the ground.<br />
|-<br />
| [[@DropOn_Item]] || Fires when the item is dropped on to another item.<br />
|-<br />
| [[@DropOn_Self]] || Fires when an item has been dropped on to this item.<br />
|-<br />
| [[@DropOn_Trade]] || Fires when an item is being dropped on a Trade Window.<br />
|-<br />
| [[@Dye]] || Fires when an item is having its colored changed.<br />
|-<br />
| [[@Equip]] || Fires when the item has been equipped.<br />
|-<br />
| [[@EquipTest]] || Fires when the item is about to be equipped.<br />
|-<br />
| [[@HouseDesignBegin]] || X branch only. A trigger for t_multi_custom, called when the player enters on design mode.<br />
|-<br />
| [[@HouseDesignCommitItem]] || X branch only. Fires for each commited item in house design system.<br />
|-<br />
| [[@PickUp_Ground]] || Fires when the item ihas been picked up from the ground.<br />
|-<br />
| [[@PickUp_Pack]] || Fires when the item is picked up from inside a container.<br />
|-<br />
| [[@PickUp_Self]] || Fires when an item has been picked up from inside the item.<br />
|-<br />
| [[@PickUp_Stack]] || Fires when the item is picked up from a stack.<br />
|-<br />
| [[@Redeed]] || Fires when multi item is about to redeed (t_multi, t_ship, t_multi_custom, t_addon).<br />
|-<br />
| [[@Sell]] || Fires when the item is sold to a vendor.<br />
|-<br />
| [[@SpellEffect]] || Fires when the object is hit by the effects of a spell.<br />
|-<br />
| [[@Step]] || Fires when a character steps on the item.<br />
|-<br />
| [[@TargOn_Cancel]] || Fires when a target is cancelled from the item.<br />
|-<br />
| [[@TargOn_Char]] || Fires when a character is targeted from the item.<br />
|-<br />
| [[@TargOn_Ground]] || Fires when the ground is targeted from the item.<br />
|-<br />
| [[@TargOn_Item]] || Fires when an item is targeted from this item.<br />
|-<br />
| [[@Timer]] || Fires when the item's timer expires.<br />
|-<br />
| [[@ToolTip]] || Fires when old-style tooltips are requested for the item.<br />
|-<br />
| [[@UnEquip]] || Fires when the item is unequipped.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HouseDesignBegin&diff=8003@HouseDesignBegin2022-08-27T23:08:21Z<p>Gorgo: Created page with "==Description== This trigger is called when the player enters on design mode in a t_custom_multi multi. Fires on: * Multis ==References== The following object referenc..."</p>
<hr />
<div>==Description==<br />
This trigger is called when the player enters on design mode in a t_custom_multi multi.<br />
<br />
<br />
Fires on:<br />
* [[Multis]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The multi about to design.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARGN1 || IO || If set to 1 Redeeds all addons on the multi. (Default = 1)<br />
|-<br />
| ARGN2 || IO || If set to 1 Transfer all Locked Items and Secured containers to the Moving Crate (default = 0)<br />
|-<br />
| ARGN3 || IO || If set to 1 Ejects from the house all chars inside the house excepting the player entering in design mode, if set to 2 Ejects everyone from the house, if set to 0 doesn't eject anyone.<br />
All chars ejected will be moved to the House sign.<br />
|}<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Forces the char to exit Customize mode.<br />
WARNING: Forcing the char to exit here and setting argn1=0 in @HouseDesignExit will make it enter in customize mode, exit, enter... infinitelly, hence crashing the server with an infinite loop.<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Items&diff=8002Items2022-08-27T23:01:24Z<p>Gorgo: /* Triggers */</p>
<hr />
<div>{{Languages|Items}}<br />
<br />
__FORCETOC__<br />
Generally speaking, there are two types of "things" in the game; characters and items. Compared to characters, items are very complex. Items have a number of different uses, for example a sword is an item that players can see and equip to increase the damage they can do in combat. Some items in the game can not be seen by the players, but they have as much impact on the player as their sword, for example, a memory item is equipped every time a player is under the effects of a spell. Some [[Special Items|special types of item]] also have additional properties that can be accessed via scripts. The following tables detail the various properties of items in SphereServer:<br />
<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside. When an item's CONT is changed, it bypasses the typical behavior (for example, you can force an item to be "in" a container and bypass @dropon triggers, or force an item to be equipped to a player and bypass @equiptest and @equip triggers -- but be careful, because in this second scenario it may end up in an invalid layer.)<br />
|-<br />
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to. Note, you can make circular LINK's, but a single item cannot be linked to more than one other item.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the object is in.<br />
|-<br />
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
! Name !! '''Read/Write''' !! '''Description'''<br />
|-<br />
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given Magery circle to the spellbook.<br />
|-<br />
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOSOUNDHIT]] || RW || Overrides the hit sound on weapons.<br />
|-<br />
| [[AMMOSOUNDMISS]] || RW || Overrides the miss sound on weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[AMOUNT]] || RW || Gets the amount of items this icon represents (e.g. a pile of gold or any stacked item).<br />
|-<br />
| [[ATTR]] || RW || Gets or sets the item's attribute flags.<br />
|-<br />
| [[BOUNCE]] || W || Moves the item to SRC's backpack (triggering the ''you put the item in your pack'' message.<br />
|-<br />
| [[CAN]] || RW || Gets or Sets the can_flags (Setting can be only done in the Itemdef itself). Only readable in X branch.<br />
|-<br />
| [[CANMASK]] || RW || Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the item.<br />
|-<br />
| [[CANSEELOS]] ''point_or_uid'' || R || Returns 1 if SRC has line of sight to the item or character (uid) or point (location).<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags,point_or_uid'' || R || Returns 1 if SRC has line of sight to the item. The ''flags'' are defined in the los_flags section of the sphere_defs.scp file and can be used to modify what tests take place. The ''point_or_uid'' is an object or position that can be used to test line of sight to something other than SRC. Note, the delimiter for FLAG values is ;<br />
|-<br />
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the object's hue.<br />
|-<br />
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.<br />
|-<br />
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.<br />
|-<br />
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)<br />
|-<br />
| [[CONTP]] || RW || Gets or sets the position of the item within its container.<br />
|-<br />
| [[DAMAGE]] ''chance, type, source'' || W || If ''chance'' is greater than (Rand(maxhits*16)), inflicts damage of ''type'' (the damage type flags are defined in the sphere_defs.scp file) upon the item. You can optionally specify the ''source'' of the damage.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.<br />
|-<br />
| [[DECAY]] ''time'' || W || Sets the decay timer (in tenths of a second) for the item.<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.<br />
|-<br />
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and SRC. If ''point_or_uid'' is used, SRC can be replaced with a map location or another object.<br />
|-<br />
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.<br />
|-<br />
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.<br />
|-<br />
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.<br />
|-<br />
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.<br />
|-<br />
| [[DROP]] || W || Drops the item to the ground.<br />
|-<br />
| [[DUPE]] || W || Clones the item.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EQUIP]] || W || Equips the item to SRC.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[FIX]] || W || Re-aligns the item or character's Z level to ground level (if items are on the ground, the top item's ''Z+HEIGHT'' is used).<br />
|-<br />
| [[FLIP]] || W || Rotates the item clockwise.<br />
|-<br />
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.<br />
|-<br />
| [[HEIGHT]] || R || Gets the height of the item.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the item to SRC.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player character.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped (possible layers are defined in the sphere_defs.scp file).<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating if it is clothing, armor, or a shield. This gets or sets a modifier for the item's damage if it is a weapon type.<br />
|-<br />
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.<br />
|-<br />
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.<br />
|-<br />
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.<br />
|-<br />
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.<br />
|-<br />
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.<br />
|-<br />
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.<br />
|-<br />
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.<br />
|-<br />
| [[MOVE]] ''direction amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position. Possible ''direction'' values are N,S,W, or E. Note, you can combine directions (like: MOVE SW 1) but nonsensical directions (like: MOVE WE 2) have the nonsense removed.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the object to a specific location (note, the AREADEF or ROOMDEF must have a P defined).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the object's name.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[REMOVE]] || W || Deletes the object.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside a container.<br />
|-<br />
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the object speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || Makes the object speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC. ''F'' makes the ''function'' available, and when added, the function name must be the 1st argument. ''M'' allows you to place a ''multi'' item, in which case the multi number must be passed as an argument. ''G'' forces the target to only be the ground. ''W'' checks the criminal status of the player before (or after?) the target selection is made.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Schedules a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the object.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the item. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TRIGGER]] ''trig_name, trigger_argtype, argument1, argument2, ...'' || R || Fires a custom trigger (trig_name), allowing you to define the behavior of the arguments (the types are defined under trigger_argtype in the sphere_defs.scp file). The result of the trigger's RETURN value is returned. For example:<br />
LOCAL.result=<TRIGGER @CustomTrigger,<DEF.tat_as_argn>,1,2,3><br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item type. You can use built-in or custom [[TYPEDEF]]s as a value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the item to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USESCUR]] || W || X branch only. Gets or sets the current uses of an item. Only partially supported.<br />
|-<br />
| [[USESMAX]] || W || X branch only. Gets or sets the maximum uses of an item. Only partially supported.<br />
|-<br />
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the item.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the item.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all item triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Buy]] || Fires when the item is being bought from a vendor.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips are about to be sent to a client.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Damage]] || Fires when the item receives damage.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@DropOn_Char]] || Fires when the item has been dropped on to a character.<br />
|-<br />
| [[@DropOn_Ground]] || Fires when the item has been dropped on to the ground.<br />
|-<br />
| [[@DropOn_Item]] || Fires when the item is dropped on to another item.<br />
|-<br />
| [[@DropOn_Self]] || Fires when an item has been dropped on to this item.<br />
|-<br />
| [[@DropOn_Trade]] || Fires when an item is being dropped on a Trade Window.<br />
|-<br />
| [[@Dye]] || Fires when an item is having its colored changed.<br />
|-<br />
| [[@Equip]] || Fires when the item has been equipped.<br />
|-<br />
| [[@EquipTest]] || Fires when the item is about to be equipped.<br />
|-<br />
| [[@HouseDesignBegin]] || trigger for t_multi_custom, called when the player enters on design mode.<br />
|-<br />
| [[@HouseDesignCommitItem]] || Fires for each commited item in house design system.<br />
|-<br />
| [[@PickUp_Ground]] || Fires when the item ihas been picked up from the ground.<br />
|-<br />
| [[@PickUp_Pack]] || Fires when the item is picked up from inside a container.<br />
|-<br />
| [[@PickUp_Self]] || Fires when an item has been picked up from inside the item.<br />
|-<br />
| [[@PickUp_Stack]] || Fires when the item is picked up from a stack.<br />
|-<br />
| [[@Redeed]] || Fires when multi item is about to redeed (t_multi, t_ship, t_multi_custom, t_addon).<br />
|-<br />
| [[@Sell]] || Fires when the item is sold to a vendor.<br />
|-<br />
| [[@SpellEffect]] || Fires when the object is hit by the effects of a spell.<br />
|-<br />
| [[@Step]] || Fires when a character steps on the item.<br />
|-<br />
| [[@TargOn_Cancel]] || Fires when a target is cancelled from the item.<br />
|-<br />
| [[@TargOn_Char]] || Fires when a character is targeted from the item.<br />
|-<br />
| [[@TargOn_Ground]] || Fires when the ground is targeted from the item.<br />
|-<br />
| [[@TargOn_Item]] || Fires when an item is targeted from this item.<br />
|-<br />
| [[@Timer]] || Fires when the item's timer expires.<br />
|-<br />
| [[@ToolTip]] || Fires when old-style tooltips are requested for the item.<br />
|-<br />
| [[@UnEquip]] || Fires when the item is unequipped.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8001Characters2022-08-27T22:56:18Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[ADDSHIP uid]] || W || X branch only. Adds the given uid to the player's ship. If the player current count of ships is greater than the limit he has, the ship will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DELSHIP uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the ship)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GETSHIPPOS uid]] || R || Returns the position of the given UID on the ships list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSHIPS]] || RW || X branch only. for Accounts and Chars, when created they read this new setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SHIP.n]] || R || X branch only. Added to access the ship in the Nth position, eg: ship.3.Redeed<br />
|-<br />
| [[SHIPS]] || R || X branch only. Return the ships on the player's list.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=8000Characters2022-08-27T22:30:37Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[ADDHOUSE uid]] || W || X branch only. Adds the given uid to the player's house. If the player current count of houses is greater than the limit he has, the house will be redeeded.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DELHOUSE uid]] || W || X branch only. Deletes the given uid from the player's list (Will not delete the house)(-1 clears the whole list).<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GETHOUSEPOS uid]] || R || Returns the position of the given UID on the houses list (-1 if not found).<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HOUSE.n]] || R || X branch only.Access the house in the Nth position, eg: house.3.Redeed<br />
|-<br />
| [[HOUSES]] ||R || X branch only. Returns the number of houses on the player's list.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXHOUSES]] || RW || X branch only. Added to Accounts and Chars, when created they read this setting from the sphere.ini (if values on sphere.ini change, they will not reflect on already created accounts/chars).<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HouseDesignCommitItem&diff=7999@HouseDesignCommitItem2022-08-27T19:14:49Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
This trigger fires when an item is about to commit when using house designer.<br />
<br />
<br />
Fires on:<br />
* [[Items]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Items|item]] being commited.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| local.id || I || ID of the item<br />
|-<br />
| local.p.x || I || The x location of the item<br />
|-<br />
| local.p.y || I || The y location of the item<br />
|-<br />
| local.p.z || I || The z location of the item<br />
|-<br />
| local.visible || I || 0 or 1 (non-visible items are things like doors and signs) return false will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.<br />
<br />
|}<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Prevents the item from being commited.<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HouseDesignCommitItem&diff=7998@HouseDesignCommitItem2022-08-26T22:29:52Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
This trigger fires when an item is about to commit when using house designer.<br />
<br />
<br />
Fires on:<br />
* [[Items]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Items|item]] being commited.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| local.id || I || ID of the item<br />
|-<br />
| local.p.x || I || The x location of the item<br />
|-<br />
| local.p.y || I || The y location of the item<br />
|-<br />
| local.p.z || I || The z location of the item<br />
|-<br />
| local.id || I || 0 or 1 (non-visible items are things like doors and signs) return false will remove this item from the commit. If not return false a local.MaxZ will check the P.Z value of the item and update it if it's higher than the old one.<br />
<br />
|}<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Prevents the item from being commited.<br />
|}</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Items&diff=7997Items2022-08-26T22:24:40Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Items}}<br />
<br />
__FORCETOC__<br />
Generally speaking, there are two types of "things" in the game; characters and items. Compared to characters, items are very complex. Items have a number of different uses, for example a sword is an item that players can see and equip to increase the damage they can do in combat. Some items in the game can not be seen by the players, but they have as much impact on the player as their sword, for example, a memory item is equipped every time a player is under the effects of a spell. Some [[Special Items|special types of item]] also have additional properties that can be accessed via scripts. The following tables detail the various properties of items in SphereServer:<br />
<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside. When an item's CONT is changed, it bypasses the typical behavior (for example, you can force an item to be "in" a container and bypass @dropon triggers, or force an item to be equipped to a player and bypass @equiptest and @equip triggers -- but be careful, because in this second scenario it may end up in an invalid layer.)<br />
|-<br />
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to. Note, you can make circular LINK's, but a single item cannot be linked to more than one other item.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the object is in.<br />
|-<br />
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
! Name !! '''Read/Write''' !! '''Description'''<br />
|-<br />
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given Magery circle to the spellbook.<br />
|-<br />
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOSOUNDHIT]] || RW || Overrides the hit sound on weapons.<br />
|-<br />
| [[AMMOSOUNDMISS]] || RW || Overrides the miss sound on weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[AMOUNT]] || RW || Gets the amount of items this icon represents (e.g. a pile of gold or any stacked item).<br />
|-<br />
| [[ATTR]] || RW || Gets or sets the item's attribute flags.<br />
|-<br />
| [[BOUNCE]] || W || Moves the item to SRC's backpack (triggering the ''you put the item in your pack'' message.<br />
|-<br />
| [[CAN]] || RW || Gets or Sets the can_flags (Setting can be only done in the Itemdef itself). Only readable in X branch.<br />
|-<br />
| [[CANMASK]] || RW || Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the item.<br />
|-<br />
| [[CANSEELOS]] ''point_or_uid'' || R || Returns 1 if SRC has line of sight to the item or character (uid) or point (location).<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags,point_or_uid'' || R || Returns 1 if SRC has line of sight to the item. The ''flags'' are defined in the los_flags section of the sphere_defs.scp file and can be used to modify what tests take place. The ''point_or_uid'' is an object or position that can be used to test line of sight to something other than SRC. Note, the delimiter for FLAG values is ;<br />
|-<br />
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the object's hue.<br />
|-<br />
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.<br />
|-<br />
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.<br />
|-<br />
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)<br />
|-<br />
| [[CONTP]] || RW || Gets or sets the position of the item within its container.<br />
|-<br />
| [[DAMAGE]] ''chance, type, source'' || W || If ''chance'' is greater than (Rand(maxhits*16)), inflicts damage of ''type'' (the damage type flags are defined in the sphere_defs.scp file) upon the item. You can optionally specify the ''source'' of the damage.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.<br />
|-<br />
| [[DECAY]] ''time'' || W || Sets the decay timer (in tenths of a second) for the item.<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.<br />
|-<br />
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and SRC. If ''point_or_uid'' is used, SRC can be replaced with a map location or another object.<br />
|-<br />
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.<br />
|-<br />
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.<br />
|-<br />
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.<br />
|-<br />
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.<br />
|-<br />
| [[DROP]] || W || Drops the item to the ground.<br />
|-<br />
| [[DUPE]] || W || Clones the item.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EQUIP]] || W || Equips the item to SRC.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[FIX]] || W || Re-aligns the item or character's Z level to ground level (if items are on the ground, the top item's ''Z+HEIGHT'' is used).<br />
|-<br />
| [[FLIP]] || W || Rotates the item clockwise.<br />
|-<br />
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.<br />
|-<br />
| [[HEIGHT]] || R || Gets the height of the item.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the item to SRC.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player character.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped (possible layers are defined in the sphere_defs.scp file).<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating if it is clothing, armor, or a shield. This gets or sets a modifier for the item's damage if it is a weapon type.<br />
|-<br />
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.<br />
|-<br />
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.<br />
|-<br />
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.<br />
|-<br />
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.<br />
|-<br />
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.<br />
|-<br />
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.<br />
|-<br />
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.<br />
|-<br />
| [[MOVE]] ''direction amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position. Possible ''direction'' values are N,S,W, or E. Note, you can combine directions (like: MOVE SW 1) but nonsensical directions (like: MOVE WE 2) have the nonsense removed.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the object to a specific location (note, the AREADEF or ROOMDEF must have a P defined).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the object's name.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[REMOVE]] || W || Deletes the object.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside a container.<br />
|-<br />
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the object speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || Makes the object speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC. ''F'' makes the ''function'' available, and when added, the function name must be the 1st argument. ''M'' allows you to place a ''multi'' item, in which case the multi number must be passed as an argument. ''G'' forces the target to only be the ground. ''W'' checks the criminal status of the player before (or after?) the target selection is made.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Schedules a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the object.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the item. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TRIGGER]] ''trig_name, trigger_argtype, argument1, argument2, ...'' || R || Fires a custom trigger (trig_name), allowing you to define the behavior of the arguments (the types are defined under trigger_argtype in the sphere_defs.scp file). The result of the trigger's RETURN value is returned. For example:<br />
LOCAL.result=<TRIGGER @CustomTrigger,<DEF.tat_as_argn>,1,2,3><br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item type. You can use built-in or custom [[TYPEDEF]]s as a value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the item to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USESCUR]] || W || X branch only. Gets or sets the current uses of an item. Only partially supported.<br />
|-<br />
| [[USESMAX]] || W || X branch only. Gets or sets the maximum uses of an item. Only partially supported.<br />
|-<br />
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the item.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the item.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all item triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Buy]] || Fires when the item is being bought from a vendor.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips are about to be sent to a client.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Damage]] || Fires when the item receives damage.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@DropOn_Char]] || Fires when the item has been dropped on to a character.<br />
|-<br />
| [[@DropOn_Ground]] || Fires when the item has been dropped on to the ground.<br />
|-<br />
| [[@DropOn_Item]] || Fires when the item is dropped on to another item.<br />
|-<br />
| [[@DropOn_Self]] || Fires when an item has been dropped on to this item.<br />
|-<br />
| [[@DropOn_Trade]] || Fires when an item is being dropped on a Trade Window.<br />
|-<br />
| [[@Dye]] || Fires when an item is having its colored changed.<br />
|-<br />
| [[@Equip]] || Fires when the item has been equipped.<br />
|-<br />
| [[@EquipTest]] || Fires when the item is about to be equipped.<br />
|-<br />
| [[@HouseDesignCommitItem]] || Fires for each commited item in house design system.<br />
|-<br />
| [[@PickUp_Ground]] || Fires when the item ihas been picked up from the ground.<br />
|-<br />
| [[@PickUp_Pack]] || Fires when the item is picked up from inside a container.<br />
|-<br />
| [[@PickUp_Self]] || Fires when an item has been picked up from inside the item.<br />
|-<br />
| [[@PickUp_Stack]] || Fires when the item is picked up from a stack.<br />
|-<br />
| [[@Redeed]] || Fires when multi item is about to redeed (t_multi, t_ship, t_multi_custom, t_addon).<br />
|-<br />
| [[@Sell]] || Fires when the item is sold to a vendor.<br />
|-<br />
| [[@SpellEffect]] || Fires when the object is hit by the effects of a spell.<br />
|-<br />
| [[@Step]] || Fires when a character steps on the item.<br />
|-<br />
| [[@TargOn_Cancel]] || Fires when a target is cancelled from the item.<br />
|-<br />
| [[@TargOn_Char]] || Fires when a character is targeted from the item.<br />
|-<br />
| [[@TargOn_Ground]] || Fires when the ground is targeted from the item.<br />
|-<br />
| [[@TargOn_Item]] || Fires when an item is targeted from this item.<br />
|-<br />
| [[@Timer]] || Fires when the item's timer expires.<br />
|-<br />
| [[@ToolTip]] || Fires when old-style tooltips are requested for the item.<br />
|-<br />
| [[@UnEquip]] || Fires when the item is unequipped.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HouseDesignCommit&diff=7996@HouseDesignCommit2022-08-26T22:22:49Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
This trigger fires when a player attempts to commit a new house design.<br />
<br />
<br />
Fires on:<br />
* [[Characters#Players|Players]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[ARGO]] || The [[Special Items#Customizable Multis|custom multi]] being designed.<br />
|-<br />
| [[I]] || The [[Characters#Players|player]] committing the design.<br />
|-<br />
| [[SRC]] || The [[Characters#Players|player]] committing the design.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARGN1 || I || The total number of components in the current house design.<br />
|-<br />
| ARGN2 || I || The total number of components in the house design being committed.<br />
|-<br />
| ARGN3 || I || The revision number of the house design being committed.<br />
|-<br />
| LOCAL.FIXTURES.NEW || I || The total number of fixtures in the house design being committed.<br />
|-<br />
| LOCAL.FIXTURES.OLD || I || The total number of fixtures in the current house design.<br />
|-<br />
| LOCAL.MAXZ || I || The value of the top placed item<br />
|}<br />
<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Prevents the house design from being committed.<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=TYPEDEF&diff=7995TYPEDEF2022-08-26T22:19:42Z<p>Gorgo: </p>
<hr />
<div>{{Languages|TYPEDEF}}<br />
<br />
__FORCETOC__<br />
Type definitions are the equivalent of [[EVENTS]] that can be attached to [[Items|items]]. There are different properties that can be used to attach a type block to an item or set of items:<br />
* [[ITEMDEF|item definitions]] via their [[TYPE]] and/or [[TEVENTS]] property.<br />
* [[Items|items]] via their [[TYPE]] and/or [[EVENTS (Property)|EVENTS]] property.<br />
<br />
<br />
In addition to handling triggers, type definitions can also be used to define different types of terrain. This can be used to affect the return value of the [[TYPE]] property on [[Map points|map points]], or for some hardcoded types such as t_rock it can be used to define which terrain IDs Sphere should consider to be rock when the mining skill is used.<br />
<br />
==Built-in Types==<br />
<br />
The built-in types are all listed in the sphere_defs.scp file. The table below only lists some of the built-in types and it is VERY weak on actual details...so use with care.<br />
<br />
{| border="1"<br />
! DEFNAME !! Number !! Description<br />
|- <br />
| t_normal || 0 || No built-in behavior.<br />
|- <br />
| t_container and t_container_locked || 1 and 2 || These types are used for containers. They leverage the following properties:<br />
* MORE1 = "ID" from the key that can unlock this item (If the MORE1 of the key matches the MORE1 of the container then they are linked)<br />
* MORE2 = The lock complexity (how hard it is to pick the lock)<br />
* MOREX = The trap type (not used yet?)<br />
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
* LINK = UID of a secondary key?<br />
|- <br />
| t_door or t_door_locked || 3 or 4 || This type is used for both unlocked and locked doors. They leverage the following properties:<br />
* MORE1 = UID of this door's key (if it has one)<br />
* TDATA1 = ID for the sound it makes when double clicked<br />
|- <br />
| t_key || 5 || This type is used for keys. It leverages the following properties:<br />
* MORE1 = "ID" of the item(s) this key can unlock (if the MORE1 of the key matches the MORE1 of the container/door then they are linked)<br />
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?<br />
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.<br />
|-<br />
| t_light_lit || 6 || This type is used for light sources that can be turned onIT_S or off. It leverages the following properties:<br />
* MOREY = Number of charges before the item is consumed<br />
* MOREZ = Type of light pattern it will cast<br />
|- <br />
| t_light_out || 7 || This type is used for light sources that can be turned on or off. It leverages the following properties:<br />
* MOREY = Number of charges before the item is consumed<br />
* MOREZ = Type of light pattern it will cast<br />
|- <br />
| t_food || 8 || This type is used for edible food. It leverages the following properties:<br />
* MORE2 = The ID of the creature that this came from<br />
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)<br />
* MOREZ = Is the poison level of the food<br />
'''Note:''' The following properties may also exist depending on your server version:<br />
* MOREX = The ID of a spell effect that will be gained when eaten<br />
* MOREY = The strength of the spell effect<br />
|- <br />
| t_food_raw || 9 || This type is used for ''raw'' food. It leverages the following properties:<br />
* MORE1 = ID of the item it makes when cooked (the default is i_unused and if defined, it will override TDATA1)<br />
* MORE2 = The ID of the creature that this came from<br />
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)<br />
* MOREZ = Is the poison level of the food<br />
* TDATA1 = The item ID this cooks into<br />
'''Note:''' The following properties may also exist depending on your server version:<br />
* MOREX = The ID of a spell effect that will be gained when eaten<br />
* MOREY = The strength of the spell effect<br />
* TDATA2 = The creature ID type that the food came from<br />
* TDATA3 = The amount of skill required to cook it (did this ever work?)<br />
|- <br />
| t_armor || 10 || This type is used for armor. It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)<br />
* MOREY = There are two possible effects of setting MOREY:<br />
*# If MOREX is set, then MOREY is the power/effect of that spell<br />
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)<br />
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.<br />
|- <br />
| t_weapon_mace_smith || 11 || This type is used for macefighting weapons that can also be used by blacksmiths to forge items. It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic<br />
The following overrides can be set on a per item basis:<br />
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does<br />
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits<br />
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses<br />
|- <br />
| t_weapon_mace_sharp || 12 || This type is used for macefighting weapons that have sharp cutting edges. It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic<br />
The following overrides can be set on a per item basis:<br />
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does<br />
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits<br />
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses<br />
|- <br />
| t_weapon_sword || 13 || This type is used for swordsmanship weapons. It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic<br />
The following overrides can be set on a per item basis:<br />
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does<br />
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits<br />
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses<br />
|- <br />
| t_weapon_fence || 14 || This type is used for fencing weapons. It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic<br />
The following overrides can be set on a per item basis:<br />
* TAG.OVERRIDE.DAMAGETYPE = can be used on a per item basis to override the types of damage this weapon does<br />
* TAG.OVERRIDE.SOUND_HIT = can be used on a per item basis to override the sound this weapon makes when it hits<br />
* TAG.OVERRIDE.SOUND_MISS = can be used on a per item basis to override the sound this weapon makes when it misses<br />
|- <br />
| t_weapon_bow || 15 || This type is used for archery weapons (bow or crossbow). It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREY = Attack bonus (percentage), but only if ATTR & attr_magic<br />
* TDATA1 = The sound effect the weapon makes when it shoots<br />
* TDATA2 = The required strength to wield the weapon<br />
* TDATA3 = ID of arrow item that will be fired (and must therefore be on the player's person)<br />
* TDATA4 = ID of the arrow animation (for bows it is usually i_arrow_x, for crossbows, i_xbow_x)<br />
The following overrides can be set on a per item basis:<br />
* TAG.OVERRIDE.DAMAGETYPE = to override the types of damage this weapon does<br />
* TAG.OVERRIDE.SOUND_HIT = to override the sound this weapon makes when it hits<br />
* TAG.OVERRIDE.SOUND_MISS = to override the sound this weapon makes when it misses<br />
* AMMOANIMRENDER = to override the rendermode of the ANIM this item uses (yes, no TAGs)<br />
* AMMOTYPE = to override the type of ammo (TDATA3) this item uses (yes, no TAGs)<br />
* AMMOANIM = to override the ammo animation (TDATA4) this item uses (yes, no TAGs)<br />
* AMMOANIMHUE = to override the color of the ammo animation this item uses (yes, no TAGs)<br />
|- <br />
| t_wand || 16 || This type is used for magic wands. It leverages the following properties:<br />
* MORE1L = the current amount of hitpoints the item has<br />
* MORE1H = the maximum hitpoints for the item<br />
* MORE2 = the number of remaining charges (if magical)<br />
* MOREX = the spell type (if magical)<br />
* MOREY = the spell strength (0-1000)<br />
* MOREZ = the poison skill applied (0-100)<br />
* TDATA2 = Required Strength to equip the wand<br />
* TDATA3 = ID of the light pattern<br />
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object). <br />
|- <br />
| t_telepad || 17 || This type is used for teleport pads. It leverages the following properties:<br />
* MOREP = Coordinates of the point to which you will teleport when you step on the item<br />
* MORE1 = If set to 1, the teleport pad will only work for players (and their pets)<br />
* MORE2 = If set to 1, the teleport animation and sound will not be shown to anyone witnessing the teleport<br />
|- <br />
| t_switch || 18 || This type is used for switches. The way these things work is, when used, they trigger @DCLICK on the LINK object. It leverages the following properties:<br />
* LINK = UID of item to trigger<br />
* MORE1 = The item ID of the next state of the switch<br />
* MOREX = A flag to indicate if this is activated by stepping on it<br />
|-<br />
| t_book || 19 || This type is used for books of static or dynamic text. It leverages the following properties:<br />
* MORE1L = This can be set to an ID of a book (some default book text is included in the sphere_books.scp file)<br />
* MORE1H = Some flags that determine book behavior:<br />
** 0c00: Scripted book<br />
** 0800: Editable book<br />
** 08000: ? time stamp ?<br />
* AUTHOR = The ID of the character that wrote the book<br />
* BODY.# = The text for each page of the book (starting with page 0)<br />
'''Note:''' we need more information on those flags...<br />
|-<br />
| t_rune || 20 || This type is used for recall runes. It leverages the following properties:<br />
* MORE1 = The number of uses left before it wears out<br />
* MOREP = The coordinates of the marked location<br />
|-<br />
| t_booze || 21 || This type is used for alcohol (it causes a drunk effect when double clicked.) It leverages the following properties:<br />
* TDATA1 = A flag that indicates whether the container is empty or not.<br />
|-<br />
| t_potion || 22 || This type is used for potions. It leverages the following properties:<br />
* MORE1 = The potion spell effect that will result when the potion is double clicked<br />
* MORE2 = The strength of the potion (This has a different effect defending on the spell, usually between 0 and 1000)<br />
* MOREX = The countdown to explosion (for purple potions)<br />
* TDATA1 = A flag that indicates whether the container is empty or not<br />
|-<br />
| t_fire || 23 || This type is used for fires (and ovens?). These items can be used to cook food, and they can burn you if stepped on. It leverages the following properties:<br />
* TIMER = time until it decays?<br />
* MORE1 (or MORE2?) = Amount of damage it will cause when stepped on or dclicked<br />
* MOREZ = Type of light pattern it will cast<br />
|-<br />
| t_clock || 24 || This type is used to tell time (game time, not real time) when double clicked. The result comes out something like "half past eleven o'clock at night". From what I can tell there are no MORE or TDATA modifiers that affect the result.<br />
|-<br />
| t_trap and t_trap_active || 25 and 26 || These types are used for traps that are triggered when walked on. They leverage the following properties:<br />
* MORE1 = ID of the animation<br />
* MORE2 = The damage the trap will cause<br />
* MOREX = The length of time the animation will run<br />
* MOREY = The length of time the activated trap will idle until reset<br />
* MOREZ = A flag that indicates if the trap must idle before changing from active to inactive. <br />
|-<br />
| t_musical || 27 || This type is used for musical instruments. It leverages the following properties:<br />
* TDATA1 = The sound ID to be played if successful<br />
* TDATA2 = The sound ID to be played if not successful<br />
|-<br />
| t_spell || 28 || This type is used for magic spell effects. It leverages the following properties:<br />
* MORE1L = The polymorph effect on STR<br />
* MORE1H = The polymorph effect on DEX<br />
* MORE2 = The number of charges left<br />
* MOREX = The spell effect that will result when the item is stepped on<br />
* MOREY = The strength of the spell (This has a different effect defending on the spell, usually between 0 and 1000)<br />
* MOREZ = Type of light pattern it will cast<br />
|-<br />
| t_gem || 29 || This type is used for gems, and from what I can tell there is no built-in behavior for it.<br />
|-<br />
| t_water || 30 || This type is used for water, which means it can be fished in or used to clean used bandages.<br />
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.<br />
|-<br />
| t_clothing || 31 || This type is used for all cloth based equip-able items. It is essentially identical to t_armor and t_armor_leather. It leverages the following properties:<br />
* MORE1L = Max hitpoints<br />
* MORE1H = Current hitpoints<br />
* MOREX = Spell effect when worn (for example, setting MOREX=1 causes a permanent Clumsy effect)<br />
* MOREY = There are two possible effects of setting MOREY:<br />
*# If MOREX is set, then MOREY is the power/effect of that spell<br />
*# If the ATTR includes attr_magic, then there is an AR bonus (how is this calculated?)<br />
'''Note:''' Old versions of sphere stored remaining charges in MORE2, this is no longer true.<br />
|-<br />
| t_scroll || 32 || This type is used for scrolls. It leverages the following properties:<br />
* MOREX = ID of the spell to cast when double-clicked<br />
* MOREY = Power of the spell (equivalent to the EFFECT setting of the spell itself?)<br />
|- <br />
| t_carpentry || 33 || This type is used by carpenters to craft items, and from what I can tell there is no built-in behavior for it.<br />
|- <br />
| t_spawn_char || 34 || This type is used to spawn NPCs. Once it spawns its first creature, it will turn red and change its appearance to the ICON of the creature (or appear as a wisp if the spawn is set to use a template.) It leverages the following properties:<br />
* AMOUNT = The maximum amount of NPCs the spawner should create<br />
* MORE1/SPAWNID* = The creature ID or spawn template ID for what you want to spawn<br />
* MORE2/COUNT* = The current number of creatures spawned from this point<br />
* MOREX/TIMELO* = The minimum time between spawns (in minutes)<br />
* MOREY/TIMEHI* = The maximum time between spawns (in minutes)<br />
* MOREZ/MAXDIST* = The maximum distance away from the spawn to create the spawned NPC (this is also the maximum wander distance for the NPC)<br />
* AT*(R/W) = Access the object in the N position and reads/writes/executes the given text, eg: at.0.remove, <at.0.str>...<br />
* ADDOBJ*(W) = Adds to the spawn an object with the given uid (must be a valid uid)<br />
* DELOBJ*(W) = Deletes from the spawn an object with the given uid (must be a valid uid)<br />
* START*(W) = Forces the spawn to start spawning<br />
* STOP*(W) = Stops the spawn and removes everything it created<br />
* RESET*(W) = Froces an STOP and then START it again<br />
<br />
*X branch only<br />
<br />
'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.<br />
|- <br />
| t_game_piece || 35 || This type is used for game board pieces (checkers, chess, etc). They cannot be removed from the game, and they have no tile image outside of the game board gump. It leverages the following properties:<br />
* TDATA1 = The starting x position for this piece<br />
* TDATA2 = The starting y position for this piece<br />
|- <br />
| t_portculis || 36 || This type is used for portcullis doors that raise and lower when double clicked. It leverages the following properties:<br />
* MORE1 = The z height at the lowest setting<br />
* MORE2 = The z height at the highest setting<br />
|- <br />
| t_figurine || 37 || This type is used for shrunk NPCs (essentially magic figurines), that turn into a "pet" creature when double clicked. It leverages the following properties:<br />
* MORE1 = The creature ID that will spawn when the item is double clicked.<br />
* MORE2 = The UID of the off-line creature (in "stable master" inventory)<br />
* TDATA2 = The required strength to mount the creature (presumably only if it is possible to mount it)<br />
* TDATA3 = The base creature ID. <br />
|-<br />
| t_shrine || 38 || This type is used for shrines. They will resurrect a ghost when double-clicked by a ghost.<br />
|- <br />
| t_moongate || 39 || This type is used for moongates. When stepped on they teleport the player to another location. It leverages the following properties:<br />
* MOREP = The coordinates that the moongate leads to<br />
* MORE1 = If set to 1, the smoke and sound is supressed<br />
* MORE2 = If set to 1, NPCs (and pets?) cannot use it<br />
|- <br />
| t_chair || 40 || This type is used for any sort of a chair item and it's only purpose is to trigger a sitting animation.<br />
|-<br />
| t_forge || 41 || This type is used by blacksmiths to smelt ore....<br />
|-<br />
| t_ore || 42 || This type is harvested by miners, and converted by blacksmiths (using a forge) into something else. It leverages the following properties:<br />
* TDATA1 = ID of item created when the ore is smelted (usually ingots)<br />
|- <br />
| t_log || 43 || This type is a raw material resource usually harvested from trees.<br />
|-<br />
| t_tree || 44 || This type is chopped by lumberjacks to get logs. It leverages the following properties:<br />
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.<br />
* FRUIT = ID of item gathered if double-clicked (usually logs)<br />
|- <br />
| t_rock || 45 || This type can be mined for ore.<br />
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.<br />
|-<br />
| t_carpentry_chop || 46 || A carpentry tool that can be used to craft carpentry objects as well as used to "chop" trees (like a saw?)<br />
|-<br />
| t_multi || 47 || Multi part object like house or ship.<br />
* MORE1 is the UID of the player that created/owns the multi<br />
|-<br />
| t_reagent || 48 || Alchemy when clicked ?<br />
|-<br />
| t_ship || 49 || This is a ship multi.<br />
* MORE1 is the UID of the player that created/owns the multi<br />
* MORE2 contains the speed, anchor flag, direction of movement, and facing direction in each byte respectively<br />
|-<br />
| t_ship_plank || 50 || Ship plank for players to get on a boat.<br />
* TDATA1 = is the itemID of the next open/closed state.<br />
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)<br />
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)<br />
* MOREX = type to become (IT_SHIP_SIDE or IT_SHIP_SIDE_LOCKED)<br />
|-<br />
| t_ship_side || 51 || Should extend to make a plank TDATA1 is the itemID of the next open/closed state. <br />
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)<br />
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)<br />
|-<br />
| t_ship_side_locked || 52 || TDATA1 is the itemID of the next open/closed state. <br />
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)<br />
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)<br />
|-<br />
| t_ship_tiller || 53 || Tiller man on the ship.<br />
* MORE1 = the lock code. Normally this is the UID, except if uidLink is set.<br />
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?<br />
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.<br />
|-<br />
| t_eq_trade_window || 54 || Container for the trade window.<br />
|-<br />
| t_fish || 55 || Fish can be cut up. Yields 4 * <Amount> when a bladed object is used on it.<br />
|-<br />
| t_sign_gump || 56 || This type is used for simple signs (and things like grave stones). It leverages the following properties:<br />
* TDATA2 = The gumpID<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
* MORE1 = the lock code. Normally this is the UID, except if uidLink is set.<br />
* LINK = If this is set to the UID of a "multi" object (like a house) the key can open all doors/containers in that multi?<br />
'''Note:''' Keys, containers, and doors are interesting. If both a key and a door/container contain the same arbitrary MORE1 value, the key can be used to lock or unlock the door/container. That action changes the TYPE of the door/container to indicate whether it is locked or not. It also seems like LINK on the key can be set to the UID of a multi so that it can be used to open all doors/containers inside that multi.<br />
|-<br />
| t_stone_guild || 57 || This type is used for guild stones. It leverages the following properties:<br />
* MORE1 = The alignment of the guild (chaos, neutral, order)<br />
* MORE2 = The amount of gold in the guild account<br />
|-<br />
| || ||<br />
t_anim_active 58 // = active anium that will recycle when done.<br />
t_sand 59 // = sand on the beach<br />
t_cloth 60 // = bolt or folded cloth<br />
t_hair 61 //<br />
t_beard 62 // = just for grouping purposes.<br />
|-<br />
| t_ingot || 63 || This type is used for ingots (when a blacksmith smelts ore, it turns into ingots. It leverages the following properties:<br />
* TDATA1 = The skill required to smelt this<br />
* TDATA2 = The skill required to get the maximum yield when smelting<br />
|-<br />
| t_coin || 64 || This types is used for coins, gold or otherwise.<br />
|-<br />
| t_crops || 65 || This type is used to grow plants that likely bear fruit. Double clicking a t_crop item will harvest the fruit if it is ripe. It leverages the following properties:<br />
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)<br />
* TDATA1 = Is the ID of the first stage of the crop (the sprout), it is the ID that the crop will be reset to regrow from (0=nothing, which means this plant will not regrow once harvested)<br />
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)<br />
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant (0 means the plant is not mature)<br />
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.<br />
|-<br />
| t_drink || 66 || This type is used for non-alcoholic drinks. It leverages the following properties:<br />
* TATA1 = A flag that indicates whether the container is empty or not. <br />
'''Note:''' There is an INI flag OF_DrinkIsFood (0x10000) that, if set, will increase FOOD level when the drink is consumed (like T_FOOD does)<br />
|-<br />
| || ||<br />
t_anvil 67 // = for repair.<br />
t_port_locked 68 // = this portcullis must be triggered.<br />
|-<br />
| t_spawn_item || 69 || This type is used to spawn items. Once it spawns its first item, it will turn red and change its appearance to the i_worldgem_lg ID item. It leverages the following properties:<br />
* AMOUNT = The maximum amount of items the spawner should create<br />
* MORE1/SPAWNID* = The item ID or spawn template ID for what you want to spawn<br />
* MORE2/PILE* = The current number of items spawned from this point<br />
* MOREX/TIMELO* = The minimum time between spawns (in minutes)<br />
* MOREY/TIMEHI* = The maximum time between spawns (in minutes)<br />
* MOREZ/MAXDIST* = The maximum distance away from the spawn to create the spawned item (this is also the maximum wander distance for the NPC)<br />
* AT*(R/W) = Access the object in the N position and reads/writes/executes the given text, eg: at.0.remove, <at.0.str>...<br />
* ADDOBJ*(W) = Adds to the spawn an object with the given uid (must be a valid uid)<br />
* DELOBJ*(W) = Deletes from the spawn an object with the given uid (must be a valid uid)<br />
* START*(W) = Forces the spawn to start spawning<br />
* STOP*(W) = Stops the spawn and removes everything it created<br />
* RESET*(W) = Froces an STOP and then START it again<br />
<br />
*X branch only<br />
<br />
'''Note:''' The spawn is considered active if the TIMER has a positive value, and when the timer reaches zero, it is automatically restarted using a random number between MOREX and MOREY.<br />
|-<br />
| || ||<br />
t_telescope 70 // = big telescope pic.<br />
|-<br />
| t_bed || 71 || This type is used to indicate the item is a bed. I am not sure how it is used exactly, but it leverages the following properties:<br />
* TDATA1 = The direction it occupies<br />
|-<br />
| t_gold || 72 || This type is used to indicate the object is a gold coin and can be used to purchase stuff.<br />
|-<br />
| t_map || 73 || This type is used for cartography maps. It has the following properties:<br />
* MORE1L = The top coordinate.<br />
* MORE1H = The left coordinate.<br />
* MORE2L = The bottom coordinate.<br />
* MORE2H = The right coordinate.<br />
* MOREZ = A flag that indicates whether the map has pins or not.<br />
* MOREX and MOREY = The coordinates of the pin (I think).<br />
* TDATA1 = The map gump width.<br />
* TDATA2 = The map gump height.<br />
|-<br />
| t_eq_memory_obj || 74 || This type is used for character memories, and it really depends on the type of memory to know what each property really means, but here is a relatively good guide:<br />
* MORE1L = The action type this is a memory for<br />
* MORE1H = The skill involved<br />
* MORE2 = The start time of the memory<br />
* MOREP = The map coordinates at which the memory occurred. <br />
|-<br />
| || ||<br />
t_weapon_mace_staff 75 // = staff type of mace. or just other type of mace.<br />
|-<br />
| t_eq_horse || 76 || This type is used for equipped horse object. Essentially it represents a riding horse to the client. It leverages the following properties:<br />
* MORE1 = The creature ID<br />
* MORE2 = The UID of the offline creature (in "stable master" inventory)<br />
* TDATA2 = The required strength to mount it<br />
* TDATA3 = The base creature ID<br />
|-<br />
| t_comm_crystal || 77 || This type is used for communication crystals.<br />
|-<br />
| t_game_board || 78 || This type is used as a container for game pieces (t_game_piece). It leverages the following properties:<br />
* MORE1 = The type of pieces to use (0=chess, 1=checkers, 2=none... presumably this is hard-coded)<br />
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
|-<br />
| t_trash_can || 79 || This type is used as a trash can container, and it deletes any object placed into it. It leverages the following properties:<br />
* TDATA2 = The gumpID of the container (this is not an ITEMDEF)<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
|-<br />
| t_cannon_muzzle || 80 || This type is used for the business end of the cannon. It leverages the following properties:<br />
* MORE2 = A mask of what is currently loaded in it. (0 = none, 1=powder, 2=shot)<br />
|-<br />
| t_cannon || 81 || This type is used for the cannon control.<br />
<br />
|-<br />
| t_cannon_ball || 82 || This is ammo for a t_cannon.<br />
|-<br />
| || ||<br />
t_armor_leather 83 // = non metallic armor (t_clothing)<br />
|-<br />
| t_seed || 84 || This type is used for seeds. A seed can be created by using a dagger on a fruit (assuming the fruit is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:<br />
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from. 0 is Nothing.<br />
* TDATA2 = The art asset to use as the seed art asset. A copper coin is default.<br />
|-<br />
| || ||<br />
t_junk 85 // = never used<br />
t_crystal_ball 86 // = Has no internal use.<br />
t_swamp 87 // = swamp (smelly)<br />
|-<br />
| t_message || 88 || This type is used for bulletin board messages. It leverages the following properties:<br />
* TDATA2 = The gumpID<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
|-<br />
| t_reagent_raw || 89 || Freshly grown reagents...not processed yet. A seed can be created by using a dagger on a raw reagent (assuming the raw reagent is setup to have a seed.) A seed can be planted by double clicking it and targeting the ground (specifically t_dirt items). It leverages the following properties:<br />
* TDATA1 = The ID of a t_crop item that will grow the fruit that this seed comes from. 0 is Nothing.<br />
* TDATA2 = The art asset to use as the seed art asset. A copper coin is default.<br />
|-<br />
| t_eq_client_linger || 90 || Change player to npc for a while.<br />
|-<br />
| t_snow || 91 || Snow<br />
|-<br />
| t_it_stone || 92 || This type is an "item stone" that is used to generate items when the object is double clicked. It has the following properties:<br />
* MORE1 = The item or template ID to generate<br />
* MORE2 = The price (or Plotflags to set?)<br />
* MOREX = The regen time (0 = instant)<br />
* MOREY = The total amount to deliver (0 = infinite, 0xFFFF = none left)<br />
|-<br />
| t_unused_93 || 93 || This has no use.<br />
|-<br />
| t_explosion || 94 || This type is used for explosion animations. It leverages the following properties:<br />
* MOREX = The damage that the explosion will cause<br />
* MOREY = The type of damage (fire, magic, etc)<br />
* MOREZ = The distance range for the damage<br />
|-<br />
| t_eq_npc_script || 95 || This type is used to script NPC actions (in the form of a book). The sphere_defs.scp file says "get rid of this in favor of waiting on m_events" but it may still exist... if so, it leverages the following properties:<br />
* MORE1 = The same as for other books<br />
* MORE2L = The current script page<br />
* MORE2H = The current offset<br />
* MOREZ = The priority for this script (as a percent, this is the chance they want to "do" this task)<br />
|-<br />
| t_web || 96 || Walk on this and transform into some other object. MORE1 is the amount of hits the web can take.<br />
|-<br />
| t_grass || 97 || Can be eaten by grazing animals<br />
* MORE1 = The regiontype ID that determines what sorts of resources (fish etc) that it can produce.<br />
|-<br />
| t_arock || 98 || A rock or boulder. can be thrown by giants.<br />
|-<br />
| t_tracker || 99 || Points to a linked object.<br />
|-<br />
| t_sound || 100 || This type is used to play sounds. It uses the following properties:<br />
* MORE1 = The sound ID<br />
* MORE2 = A flag to indicate repetition<br />
|-<br />
| t_stone_town || 101 || This type is used for town stones. It leverages the following properties:<br />
* MORE1 = The alignment of the town (chaos, neutral, order)<br />
* MORE2 = The amount of gold in the town bank account<br />
|-<br />
| || ||<br />
t_weapon_mace_crook 102 //<br />
t_weapon_mace_pick 103 //<br />
t_leather 104 // = leather or skins of some sort.(not wearable)<br />
t_ship_other 105 // = some other part of a ship.<br />
|-<br />
| t_bboard || 106 || This type is a bulleting board container that holds t_message items. It leverages the following properties:<br />
* TDATA2 = The gumpID of the container<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
|-<br />
| t_spellbook || 107 || This type is used for the Magery spellbook. It leverages the following properties:<br />
* MORE1 = A bit mask of available spells in circles 0-4, so to add all those spells: set MORE1=0ffffffff<br />
* MORE2 = A bit mask of available spells in circles 5-8, so to add all those spells: set MORE2=0ffffffff<br />
'''Note:''' In older sphere versions, MOREX, MOREY, and MOREZ could be set to add additional spells (necro, etc), but recently these concepts may have been removed... same with these TDATA settings:<br />
* TDATA2 = Required Strength to equip the book<br />
* TDATA3 = Type of light pattern it will cast<br />
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)<br />
|-<br />
| t_corpse || 108 || This type is a container used for all dead corpses. It leverages the following properties:<br />
* <s>MORE1 = The time of death</s> TIMESTAMP seems to hold the time of death.<br />
* MORE1 = Corpse is already carved? (0=not carved, 1=carved) <br />
* MORE2 = The UID of the individual character that landed the killing blow<br />
* MOREX & MOREY = Combined, these make up a single DWORD which specifies what type of creature this was<br />
* MOREZ = The direction it is facing<br />
* TDATA2 = The gumpID of the container<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
There are two special TAGs for corpses:<br />
* TAG.BLOOD = This is the number of times you can carve the corpse and cause blood to come out (default 5)<br />
* TAG.MAXBLOOD = Not certain about this one, but it is likely related... perhaps it is set on the CHARDEF?<br />
|-<br />
| || ||<br />
t_track_item 109 // - track a id or type of item.<br />
t_track_char 110 // = track a char or range of char id's<br />
t_weapon_arrow 111 //<br />
t_weapon_bolt 112 //<br />
t_eq_vendor_box 113 // = an equipped vendor box<br />
|-<br />
| t_eq_bank_box || 114 || This type is a container that is used for the character bank. It leverages the following properties:<br />
* MORE1 = The amount of gold in the account (is this still true?)<br />
* MORE2 = The amount to restock to (for NPCs vendors who can buy stuff from players?)<br />
* MOREP = The location in the world (x, y, and z) where the bank box was opened<br />
* TDATA2 = The gumpID for the bank box container<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = the maximum gump size<br />
|-<br />
| t_deed || 115 || This type is used to create something else when double clicked. It is perhaps the best solution for a player to place a ''multi'' part item like a house. When double clicked, it will prompt for a target location. It leverages the following properties:<br />
* MORE1 = The ID of the item that will be created at the target location<br />
* MORE2 = The previous key ID (ideally this is set when a house or ship are re-deeded so that all the existing keys will still work)<br />
|-<br />
| t_loom || 116 || This type of device is used by weavers who turn wool or thread into bolts of cloth. It leverages the following properties:<br />
* MORE1 = The ID of the currently loaded resource (wool or cotton/flax) that is being woven<br />
* MORE2 = The amount of resources currently in the loom<br />
|-<br />
| t_bee_hive || 117 || This type is used for beehives. It leverages the following properties:<br />
* MORE1 = The amount of honey which has accumulated in the hive<br />
|-<br />
| t_archery_butte || 118 || This type is used for practice archery targets. When double clicked, the target will first check if you have an archery weapon equipped and if so, it will return some ammo. It leverages the following properties:<br />
* MORE1 = The ID for the type of ammo currently stuck in the target<br />
* MORE2 = The amount of items stuck in the target<br />
|-<br />
| || ||<br />
t_eq_murder_count 119 // = my murder count flag. MORE1 contains the amount of time before it expires. <br />
t_eq_stuck 120 // we are stuck in a web<br />
t_trap_inactive 121 // = a safe trap.<br />
//t_unused_122 122<br />
t_bandage 123 // = can be used for healing.<br />
t_campfire 124 // = this is a fire but a small one.<br />
t_map_blank 125<br />
t_spy_glass 126<br />
t_sextant 127<br />
t_scroll_blank 128<br />
|-<br />
| t_fruit || 129 || This type is used for fruit. When double clicked, fruit will be eaten. Fruit can be grown from crops (t_crop). It leverages the following properties:<br />
* TDATA1 = The ID of a t_crop item that this fruit comes from (If not set, this fruit may not have a seed, use zero to be certain)<br />
* MOREM = Is the amount (0 to 127) of "food units" that will be gained when the item is used (eaten)<br />
* MOREZ = Is the poison level of the fruit<br />
|-<br />
| || ||<br />
t_water_wash 130 // water that will not contain fish. (for washing or drinking) TDATA1 is a flag that indicates whether the container is empty or not <br />
t_weapon_axe 131 // not the same as a sword. but uses swordsmanship skill<br />
|-<br />
| t_weapon_xbow || 132 || This type is used for crossbow weapons. It is essentially identical to t_weapon_bow.<br />
|-<br />
| || ||<br />
t_spellicon 133<br />
t_door_open 134<br />
t_meat_raw 135 // just a meaty part of a corpse. (uncooked meat)<br />
t_garbage 136<br />
|-<br />
| t_keyring || 137 || This type is a container used to store keys. It leverages the following properties:<br />
* TDATA2 = The gumpID<br />
* TDATA3 = The minimum gump size<br />
* TDATA4 = The maximum gump size<br />
|-<br />
| t_table || 138 || doesn't really do anything.<br />
|-<br />
| t_floor || 139 || <br />
|-<br />
| t_roof || 140 || <br />
|-<br />
| t_feather || 141 || a birds feather<br />
|-<br />
| t_wool || 142 || wool cut from a sheep.<br />
|-<br />
| t_fur || 143 || <br />
|-<br />
| t_blood || 144 || blood of some creature<br />
|-<br />
| t_foliage || 145 || This type is very similar to t_crops, the difference being the foliage does not disappear when the fruit is harvested. It leverages the following properties:<br />
* MORE1 = Time in seconds before this item will grow to the next stage (this overrides the default server defined number)<br />
* TDATA1 = Is the ID of the first stage of the crop (the sprout)<br />
* TDATA2 = Is the ID of the next stage of the crop (or zero if this is the final mature crop which will bear the fruit)<br />
* TDATA3 = Is the ID of the fruit that this plant will grow and should only be set on the ''ripe'' plant<br />
'''Note''' This type has unusual TIMER behavior in that regardless of the ATTR flags, the timer will restart when it reaches zero.<br />
|-<br />
| || ||<br />
t_grain 146<br />
t_scissors 147<br />
t_thread 148<br />
t_yarn 149<br />
t_spinwheel 150<br />
t_bandage_blood 151 // = can't be used for healing.<br />
t_fish_pole 152<br />
t_shaft 153 // bolt or arrow.<br />
t_lockpick 154<br />
t_kindling 155<br />
t_train_dummy 156<br />
t_train_pickpocket 157<br />
t_bedroll 158<br />
t_bellows 159<br />
|-<br />
| t_hide || 160 ||Made into leather.<br />
* TDATA1 = Hold ID or DEFNAME of custom cut leather (or any item).<br />
|-<br />
| t_cloth_bolt || 161 || A bolt of cloth.<br />
|-<br />
| t_board || 162 || Logs are plained into decent lumber<br />
|-<br />
| t_pitcher || 163 || A pitcher holding a liquid of some kind.<br />
*TDATA1 is a flag that indicates whether the container is empty or not. <br />
|-<br />
| t_pitcher_empty || 164 || An empty pitcher that can or did hold a liquid.<br />
* TDATA1 is a flag that indicates whether the container is empty or not. <br />
|-<br />
| t_dye_vat || 165 || For dyeing items with.<br />
|-<br />
| t_dye || 166 || Dyes to set colors on a t_dye_vat<br />
|-<br />
| t_potion_empty || 167 || Empty bottle.<br />
|-<br />
| t_mortar || 168 || Alchemists mortar and pestle.<br />
|-<br />
| t_hair_dye || 169 || Hair dye.<br />
|-<br />
| t_sewing_kit || 170 || Tailoring sewing kit.<br />
|-<br />
| t_tinker_tools || 171 || Tinker's tools.<br />
|-<br />
| t_wall || 172 || Wall of a structure.<br />
|-<br />
| t_window || 173 || Window for a structure. MOREZ is the light pattern<br />
|-<br />
| t_cotton || 174 || Cotton from the plant<br />
|-<br />
| t_bone || 175 || A bone from a corpse.<br />
|-<br />
| t_eq_script || 176 || This type can have tags and can be equipped. Possibly used for memory objects that leverage @Equip and @UnEquip triggers.<br />
|-<br />
| t_ship_hold || 177 || A ships hold.<br />
* TDATA2 is the gumpID<br />
* TDATA3 is the minimum gump size<br />
* TDATA4 is the maximum gump size<br />
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)<br />
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)<br />
|-<br />
| t_ship_hold_lock || 178 || A locked ship's hold.<br />
* MORE1 = the lock code. normally this is the same as the uid (magic lock=non UID)<br />
* MORE2= 0-1000 = How hard to pick or magic unlock. (conflict with door ?)<br />
|-<br />
| t_lava || 179 || <br />
|-<br />
| t_shield || 180 || This type is used to indicate the object is an equipable shield. It has the following properties:<br />
* MORE1L = The current amount of hitpoints the item has<br />
* MORE1H = The maximum hitpoints for the item<br />
* MORE2 = The number of remaining charges (if magical)<br />
* MOREX = The spell type (if magical)<br />
* MOREY = The spell strength (0-1000)<br />
|-<br />
| t_jewelry || 181 || This type is used for equpable jewelry. It leverages the following properties:<br />
* MORE1L = The current amount of hitpoints the item has<br />
* MORE1H = The maximum hitpoints for the item<br />
* MORE2 = The number of remaining charges (if magical)<br />
* MOREX = The spell type (if magical)<br />
* MOREY = The spell strength (0-1000)<br />
* TDATA2 = Required Strength to equip the item<br />
* TDATA3 = Light pattern<br />
* TDATA4 = A flag to indicate what happens when the light burns out (0=nothing, 1=delete the object)<br />
|-<br />
| t_dirt || 182 || This type is used to represent a patch of dirt where something can be planted.<br />
|- <br />
| t_script || 183 || This type can have tags, but can NOT be equipped.<br />
|-<br />
| t_spellbook_necro || 184 || AOS Necromancy spellbook (should have MOREZ=100 by default)<br />
|-<br />
| t_spellbook_pala || 185 || AOS Paladin spellbook (should have MOREZ=200 by default)<br />
|-<br />
| t_spellbook_extra || 186 || some spellbook for script purposes (MOREZ=basic offset)<br />
|-<br />
| t_spellbook_bushido || 187 || SE Bushido spellbook (should have MOREZ=400 by default)<br />
|-<br />
| t_spellbook_ninjitsu || 188 || SE Ninjitsu spellbook (should have MOREZ=500 by default)<br />
|-<br />
| t_spellbook_arcanist || 189 || ML Spellweaver spellbook (should have MOREZ=600 by default)<br />
|-<br />
| t_multi_custom || 190 || Customisable multi<br />
|-<br />
| t_spellbook_mystic || 191 || SA Mysticism spellbook (should have MOREZ=677 by default)<br />
|-<br />
| t_hoverover || 192 || Hover-over item (CAN_C_HOVER can hover over blocking items)<br />
|-<br />
| t_spellbook_bard || 193 || SA Bard spellbook (should have MOREZ=700 by default)<br />
|}<br />
<br />
==Scripted TYPEDEFs==<br />
<br />
{| border="1"<br />
! DEFNAME !! File !! Description<br />
|-<br />
| t_advance_gate || ??.scp || MORE = ID of character to change into<br />
|}<br />
<br />
==Syntax==<br />
The syntax for defining a type is:<br />
<br />
<br />
<tt><br />
[TYPEDEF ''defname'']<br /><br />
TERRAIN=''id''<br /><br />
TERRAIN=''start_id'', ''end_id''<br /><br />
<br /><br />
ON=''trigger_name''<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;''script''<br /><br />
<br /><br />
ON=''trigger_name''<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;''script''<br /><br />
<br /></tt><br />
<br />
<br />
Any number of triggers can be handled by one [[TYPEDEF]] definition, however it is not possible to handle the same trigger twice without using multiple definitions.<br />
<br />
<br />
The trigger name can be the name of any [[Items#Triggers|item trigger]]. The return value from the script can affect Sphere's hardcoded behaviour in different ways. See the documentation for the trigger to discover what parameters are passed in to each trigger and what the return values do.<br />
<br />
<br />
'''Note:''' If the ''defname'' matches any of Sphere's hardcoded types (see 'typedefs' block in sphere_defs.scp), then the [[TYPEDEF]] can be used to override the behaviours of items of that type.<br />
<br />
<br />
==Examples==<br />
<spherescript><br />
//<br />
// Water definition from default script pack.<br />
//<br />
[TYPEDEF t_water]<br />
TERRAIN = 0a8 0ab<br />
TERRAIN = 0136 0137<br />
</spherescript><br />
<br />
<spherescript><br />
//<br />
// Makes an item speak when double clicked.<br />
//<br />
[TYPEDEF t_exampletype]<br />
ON=@DClick<br />
SAY I have been double clicked!<br />
RETURN 2<br />
</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Chapter_4&diff=7994Chapter 42022-08-19T21:11:04Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Chapter_4}}<br />
<br />
==Introduction to Objects==<br />
Your first glimpse of real scripting! <br />
<br />
<br />
First and foremost, you MUST understand the object structure of the SPHERE system. Now, because SPHERE interacts with something visible, most of these objects are relatively easy to understand. But first, you must understand this simple fact about object-oriented programming (a term I'm sure all you programmers havel come to know and fear): <br />
<br />
<br />
'''OBJECT-ORIENTED SCRIPTING IS CENTERED AROUND OBJECTS.'''<br />
<br />
<br />
Duh. <br />
<br />
<br />
Actually, it isn't as "Duh" as you may think. Here is a list of the objects available to you in a SPHERE script: <br />
<br />
<br />
{| border="1"<br />
| '''Who'''<br />
| '''What'''<br />
|- <br />
| SRC <br />
| The '''"source"''' of an event. If an item is damaged, the SRC is whatever damaged it. If a player is hit, the SRC is whoever hit the player. If an item is double-clicked, the SRC is the player who double-clicked it. The ONLY event that does not have a SRC, as we shall see later, is @Timer, for good reasons. Note that usually on functions the SRC isn't always the one who called the functions, but the default object (I or just an empty thing, eg: &lt;I.NAME&gt; or &lt;NAME&gt; are the same thing.<br />
|- <br />
| ACT <br />
| The last object acted upon by the referenced character, for example on that char trigger @ItemDclick, ACT is the item the player double-clicked.<br />
|- <br />
| TARG <br />
| The object targetted by the character.<br />
|- <br />
| CONT <br />
| The container of the object.<br />
|- <br />
| TOPOBJ <br />
| If an object is buried in several containers within containers, this is always the top-level container before you get to the world. If an item is buried in a player's backpack, TOPOBJ is the player.<br />
|- <br />
| ACCOUNT <br />
| The account of a player, obviously.<br />
|- <br />
| REGION <br />
| The current region/area a player is in.<br />
|- <br />
| SECTOR <br />
| The world is divided into 64 by 64 tile sectors (by default but you can change it by setting the MAPx settings (look at sphere.ini section for this)). This is the player's current sector.<br />
|- <br />
| SERV <br />
| used to call server commands, like serv.save, serv.allclients, etc.<br />
<br />
'''Object references from SERV'''<br />
{| border="1"<br />
| LASTNEWITEM <br />
| The last item created from NEWITEM/NEWDUPE functions.<br />
|- <br />
| LASTNEWCHAR <br />
| The last character created by NEWNPC/NEWDUPE functions.<br />
|}<br />
|- <br />
| LINK <br />
| The object referred to in the LINK property of an '''item'''.<br />
|- <br />
| UID.x <br />
| The object with UID equal to X.<br />
|- <br />
| FINDLAYER.X <br />
| The object in layer X.<br />
|- <br />
| FINDCONT.X <br />
| The xth object in the container referenced.<br />
|- <br />
| FINDID.x <br />
| The first object with ID of x in the container.<br />
|- <br />
| FINDTYPE.x <br />
| The first object with TYPE of X in the container.<br />
|- <br />
| NEW <br />
| The newer object created from NEWITEM/NEWNPC/NEWDUPE functions.<br />
|- <br />
| OBJ <br />
| An empty object variable, which you need to set to use, eg:<br />
<br />
<tt><font color="darkblue">OBJ = &lt;FINDLAYER.'''layer_bankbox'''&gt;<br /><br />
OBJ.SAY HEHE<br /></font></tt><br />
<br />
will make I's bank box say hehe.<br><br />
'''NOTE''': OBJ is a global variable so it can possibly interfere with other scripts.<br><br />
It's best to set it back to nothing when not in use in a certain script.<br />
|- <br />
| REFx <br />
| This works in the same way as OBJ except the reference is local and will not interfere with other scripts. 'x' is a number between 1 and 65535, allowing you to reference as many objects as you need simultaneously (e.g. REF1 = &lt;FINDLAYER.layer_bankbox&gt;).<br />
|- <br />
| FILE <br />
| Call the file commands on the current FILE object.<br />
|- <br />
| DB <br />
| See [[MySQL]]<br />
|- <br />
| PARTY.MEMBER.x <br />
| The xth party member of the referenced party.<br />
|- <br />
| GUILD.MEMBER.x <br />
| The xth guild member of the referenced guild.<br />
|}<br />
<br />
<br />
As you can see, we're rather limited in what we can do! Actually, not really. With the current scripting system, you can do almost anything imaginable with SPHERE. It might run slow or be laggy, but it can be done. Those last five events (the ones with the x in them) are complex and I don't expect you to know how to use them yet. <br />
<br />
<br />
Now that we know the objects, we need to know how to access the properties of those objects, and above all, do things to those objects. We use the dot operator (.) to access properties of objects. For example: <br />
<br />
<tt><font color="darkblue">SRC.STR<br /><br />
ACT.MOREP<br /><br />
SRC.ACT.MOREP<br /><br />
SRC.TARG.HITS<br /><br />
SRC.DAMAGE {1 5} 01 &lt;ACT&gt;<br /><br />
SERV.NEWITEM i_gold<br /><br />
NEW.AMOUNT 10000<br /><br />
SRC.TARG.KILL<br /><br />
CONT.KILL<br /><br />
FINDLAYER.layer_backpack.FINDID.i_gold.AMOUNT<br /></font></tt><br />
<br />
<br />
I don't expect you to understand what all of these things do yet, but you will by the end of this chapter.<br />
<br />
<br />
'''Some notes''': You must also understand that OBJECTS aren't ITEMS, when someone say OBJECT they probably mean a character/item/some of those in the table. The objects can also be called REFERENCE, for example, ACT.STR 100 the reference is ACT.<br />
<br />
<br />
Here is the next principle of SPHERE scripting:<br />
<br />
<br />
'''ALL ACTIONS ARE TRIGGERED BY EVENTS OR FUNCTIONS, WHICH DEFINE THE OBJECTS'''<br />
<br />
<br />
Nothing happens in a SPHERE script that just sits there. A player, or something else in the game, must do something to an item or a character for a script to execute. For example, being hit executes the @GetHit script on the person being hit, and @Hit on the hitter. Stepping on an item executes the @Step script on the item and the @ItemStep script on the player. When an item is double-clicked, @DClick is executed on the item and @ItemDClick is executed on the player. <br />
<br />
<br />
If the player is the one who double-clicks the ITEM, he becomes SRC. If he targets an item, in the @Targon_Item script, the player is SRC, and the item he targeted is SRC.TARG. <br />
<br />
<br />
We refer to an event like this: <br />
<br />
<br />
<tt><font color="darkblue">ON=@DClick </font></tt><br />
<br />
<br />
Following that line would be everything that we want to happen when the player clicks the item. <br />
<br />
<br />
We'll see examples in the next section of the use of both events and objects.<br />
<br />
<br />
==Making Decisions==<br />
It was an amazing day when someone showed this script to me. This was actually the script that tested the "new" scripting system in version .37. SPHERE wasn't even SPHERE then. It was called "Grayworld" and was on menasoft.com. Actually, I believe it was in the Admin FAQ that they used to have on the website. Here it is, updated to 56b format:<br />
<br />
<br />
<tt><font color="darkblue">[TYPEDEF T_VEND_MACHINE]<br /><br />
// Some other trigger.<br /><br />
// Vending machine.<br /><br />
<br /><br />
ON=@DCLICK<br />
:IF (&lt;SRC.RESTEST 10 i_gold&gt;)<br /><br />
::SERV.NEWITEM={ i_HAM 1 i_fruit_apple 1 i_bread_loaf 1 i_bacon_slice 1 i_RIBS_COOKED 1 i_SAUSAGES 1}<br /><br />
::SRC.BOUNCE &lt;NEW.UID&gt; // put it in your pack.<br /><br />
::SRC.CONSUME 10 i_gold<br /><br />
::SRC.MESSAGE That will be 10 Gold Thank Thee.<br /><br />
::SOUND 0F7<br /><br />
:ELSE<br /><br />
::MESSAGE You lack 10 Gold to pay.<br /><br />
:ENDIF<br /><br />
:RETURN 1<br /></font></tt><br />
<br />
<br />
Put this script into one of your files and resync your server. I like to use spheretrig.scp for test triggers like this. Now, in the game, type <font color="darkred">.set type t_vend_machine</font> and target any item (like a door). Then double-click it and watch what happens. If you get the "not enough gold" message, <font color="red">.add</font> yourself some i_gold, and try again.<br />
<br />
<br />
See the result of this simple little script? It's got a lot that we've dicussed, and even more that we haven't. First, you may notice the use of this strange IF construction. You will use this again and again, so pay attention! The IF structure looks like this:<br />
<br />
<br />
<tt><font color="darkblue">IF (1 or 0)<br /><br />
// Execute these lines if 1<br /><br />
ELIF (1 or 0)<br /><br />
// Execute these lines if the first wasn't 1, but this one is<br /><br />
// You can have as many ELIFs as you need<br /><br />
ELSE<br /><br />
// Execute if none of the above are 1<br /><br />
ENDIF<br /></font></tt><br />
<br />
<br />
Always, always, always, always pair your IF with an ENDIF. It doesn't matter what's in the middle. You can have eight hundred ELIFs and an ELSE. But ALWAYS be sure your IF is paired somewhere with an ENDIF. Actually those are the only two required parts of this construction. ELSE and ELIF are completely optional, and you should only use them if they are absolutely needed.<br />
<br />
<br />
So what is this "1 or 0" thing? How does it help me in my scripting if I'm just typing a 1 or a 0 in there? Actually, you will NEVER type a 1 or a 0 in there, and this is a perfect time to introduce the equivalence test operators. Here they are:<br />
<br />
<br />
{|<br />
| '''==''' || '''equal to'''<br />
|-<br />
| '''!=''' || '''not equal to'''<br />
|-<br />
| '''> ''' || '''greater than'''<br />
|-<br />
| '''< ''' || '''less than'''<br />
|-<br />
| '''<=''' || '''less than or equal to'''<br />
|-<br />
| '''>=''' || '''greater than or equal to '''<br />
|}<br /><br />
'''1 = true'''<br /><br />
'''0 = false'''<br /><br />
<br />
<br />
I've put this table in bold since it's so incredibly important. And here is another SPHERE principle: <br />
<br />
<br />
'''Do not use == and = interchangably in an IF statement. SPHERE actually allows this, but you will get confused and use == where you mean =, and vice versa.'''<br />
<br />
<br />
Here is an example of using a equivalence operator in an IF statement: <br />
<br />
<br />
<tt><font color="darkblue">IF (&lt;SRC.STR&gt; == 75)</font></tt><br />
<br />
<br />
Read this "If src.str is equal to 75". Want to know something interesting? Internally, if SRC.STR is in fact equal to 75, SPHERE will replace the ENTIRE part inside the parentheses with a 1. If it is not equal to 75, SPHERE will replace that part with a 0. That's where your 1 and 0 comes from. <br />
<br />
<br />
Now you may be wondering, what the &lt; &gt; brackets around &lt;SRC.STR&gt; are doing there. Actually, this is one of the most elusive concepts in SPHERE scripting. The &lt; &gt; brackets mean "Replace whatever is inside with the actual value of that thing." This is done before any testing is executed. Say SRC.STR has been set to 71. Here are the steps SPHERE takes in simplifying this IF statement: <br />
<br />
<br />
<tt><font color="darkred">1. IF (&lt;SRC.STR&gt; == 75)</font><br /><br />
<br /><br />
<font color="darkred">2. IF (71 == 75)</font><br /><br />
<br /><br />
<font color="darkred">3. IF (0)</font><br /></tt><br />
<br />
Notice above in the example script that we have this statement:<br />
<br />
<br />
<tt><font color="darkred">&lt;SRC.RESTEST 10 i_gold&gt;</font></tt><br />
<br />
<br />
"What the heck is <font color="darkred">RESTEST</font>?" <font color="darkred">RESTEST</font> is what we call a function. It takes parameters (in this case an amount and an item ID) and returns a value. SPHERE replaces the entire function statement &lt;SRC.RESTEST 10 i_gold&gt; with that value. RESTEST checks to see if the player has an amount of the item specified greater than the amount specified: <br />
<br />
<br />
"Does the player have an amount of i_gold equal to or greater than 10?" is what the function asks. Internally SPHERE says "Yes" and replaces it with a 1, or "No" and replaces it with a 0. <br />
<br />
<br />
Say the player had 9 gold in his backpack. Here is the simplification of the IF statement: <br />
<br />
<br />
<tt><font color="darkred">1. IF (&lt;SRC.RESTEST 10 i_gold&gt;)<br /><br />
<br /><br />
2. IF (0)<br /></font></tt><br />
<br />
<br />
We'll see in later chapters how to define our own functions, give them parameters and have them return a value! <br />
<br />
<br />
I hope you have a general understanding of the <font color="darkred">IF</font> statement now. Here is a more complex example for you to analyze: <br />
<br />
<br />
<tt><font color="darkblue">IF (&lt;SRC.STR&gt; &gt; 60)<br /><br />
:SRC.SYSMESSAGE Your strength is greater than 60.<br /><br />
ELIF (&lt;SRC.STR&gt; &gt; 40)<br /><br />
:SRC.SYSMESSAGE Your strength is greater than 40, but less than 60.<br /><br />
ELIF (&lt;SRC.STR&gt; &gt; 20)<br /><br />
:SRC.SYSMESSAGE You are a weakling with between 20 and 40 strength.<br /><br />
ELSE<br /><br />
:SRC.SYSMESSAGE Start lifting weights because your strength is less than 20!<br /><br />
ENDIF<br /></font></tt><br />
<br />
<br />
What does this do? Well first, SPHERE looks at the IF statement, and says "Is the value of SRC.STR greater than 60?" If the answer is no, SPHERE replaces that with a 0, and jumps down to the first ELIF. "Is the value of SRC.STR greater than 40?" If not, it jumps down to the next one. "Is the value of SRC.STR greater than 20?" If not, it looks for further ELIFs. Unable to find them, it jumps to the ELSE statement, since nothing above was true. <br />
<br />
<br />
SYSMESSAGE prints out a message to the corner of the screen of the referenced object. In this case, that's SRC. Earlier, you saw an example involving the MESSAGE function. It prints the message above the object referenced. If the object is inside of a closer container, it does a SYSMESSAGE to the topmost container object. This means that if an item in a backpack is given a MESSAGE command, and the backpack is not opened, the player will see the message in the corner of his screen. <br />
<br />
<br />
<tt><font color="darkred">'''SYSMESSAGE''' [text]<br/ ><br />
'''MESSAGE''' [text]<br/ ><br />
'''RESTEST''' [amount] [item]<br/ ><br />
'''NEWITEM''' [item]<br/ ><br />
'''BOUNCE''' // Put an item into the character's backpack<br/ ></font></tt><br />
<br />
<br />
Your first five functions. Congratuations. Actually, you saw another one in an earlier script! Remember what it is?<br />
<br />
<br />
<tt><font color="darkred">'''SAY''' [text]<br /></font></tt><br />
<br />
<br />
This, of course, causes the object to SAY (so everyone can hear it) the text given. With MESSAGE and SYSMESSAGE, the text is private to a single client. MESSAGE text is only visible to the SRC. (In other words, LINK.MESSAGE or SRC.TARG.MESSAGE will show a message over LINK or SRC.TARG that only SRC can see!) <br />
<br />
<br />
So finally, what is this weird <font color="darkred">RETURN 1</font> at the end of the script? <br />
<br />
<br />
RETURN is used in a variety of ways. In the case of an event script, if you RETURN 1, it prevents the default action from happening. For example, if you put this on an item in the game and double-click it, it doesn't actually try to use the item too. It just executes the double-click script. (To a player it would look like he was using the item, but we know better.) If you change it to RETURN 0, it would try to use the item too, realize it had no idea what to do with this item, and say "You are not sure how to use this item" or something like that. Either way, the script ends as soon as it sees a RETURN statement. The distinction between RETURN 1 and RETURN 0 is even more clear in character events, and I shall make an effort to point that out at the time.<br />
<br />
<br />
==[SPEECH] for Dummies==<br />
I say "Hello" you say "Goodbye", or "Cheese", or "You are a bad scripter" <br />
<br />
<br />
Well, it's time to introduce you to your newest concept in SPHERE scripting:<br />
<br />
<br />
NPC SPEECH is an event.<br />
<br />
<br />
A long time ago there was supposed to be a @Hear trigger, and we waited and waited and waited, and it was going to be the next big thing in TUS (SPHERE's name before version .50), but nothing ever came of it. Then came SPHERE with all these new scripting revelations, and we said "Hey! We don't even need @Hear! Speech works just like any other event!<br />
<br />
<br />
For example:<br />
<br />
<br />
<tt><font color="darkblue">[SPEECH spk_human_test]<br /><br />
ON=*hello*<br /><br />
:SAY @55 Cheese!<br /></font></tt><br />
<br />
<br />
You should recognize that from a previous chapter when we created this script and set it on an NPC. But what if we want that NPC to do more than say "Cheese!" in a yellow colored font. What if we want him run away as fast as he possibly can, or drop his gold on the ground and faint?<br />
<br />
<br />
We could easily do this:<br />
<br />
<br />
<tt><font color="darkblue">[SPEECH spk_human_test]<br /><br />
ON=*hello*<br /><br />
:IF (&lt;SRC.KARMA&gt; &lt; &lt;SERV.PLAYERNEUTRAL&gt;) // Are they less than good?<br /><br />
::SAY You are evil! Get away from me!<br /><br />
::FLEE // Causes an NPC to run away from SRC (this can have an argument (the one to flee from))<br /><br />
:ELSE<br /><br />
::SAY Cheese!<br /><br />
::BOW //Makes him bow to src (this can have an argument (the one to be bowed to uid))<br /><br />
:ENDIF<br /><br />
:RETURN 1<br /></font></tt><br />
<br />
<br />
If you don't RETURN 1, the processing will pass through to the default handler, which will make the NPC say something like "Huh? I don't understand thee!"<br />
<br />
<br />
In an NPC speech event, <font color="darkred">SRC</font> is the player who triggered the event, the speaker who said "hello" in this case. The default object is the NPC with the event on him, as you can see from the script above. That is why SAY works without an object reference.<br />
<br />
<br />
You can have ANYTHING in a speech script that you can have in a normal script. Just remember, there are no items involved. No MORE, no MORE2, no MOREP. But I'll tell you in a little bit how to get as many variables as you want on both NPCs and humans.<br />
<br />
<br />
This section doesn't need to be any longer, does it? You already know how to write an event, and you already know some basic statements, like <font color="darkred">IF</font>. That should provide some very robust NPC speaking on your shard!<br />
<br />
<br />
==The Difference Between = And <nowiki>==</nowiki>?==<br />
In most programming languages, = is called the "assignment operator". == is called the "equals sign".<br />
<br />
<br />
Here are my style guidelines, for better readability of your scripts, and so on. (If we can't read your scripts, we can't help you with them.)<br />
<br />
<br />
# == should only be used in test statements, like an IF<br /> <tt>IF (&lt;SRC.STR&gt; '''==''' 75)</tt><br /><br />
# = should be used for assignments, like setting a variable to a value<br /> <tt>MORE '''=''' 3<br /> MOREP '''=''' 45 65 12 4</tt><br />
<br />
<br />
And that's about it. I'm pretty lenient huh?<br />
<br />
<br />
As a comparison, my Java class at school has style guidelines in a set of pages the size of this entire tutorial.<br />
<br />
[[Category:Tutorials]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=MAPWAYPOINT&diff=7993MAPWAYPOINT2022-08-19T20:00:30Z<p>Gorgo: Created page with "=Usage= REFERENCE.MAPWAYPOINT ObjectUID,WayPointType =Description= This function adds/removes waypoints on client radar map (enhanced clients only). Waypoint types: 0 = R..."</p>
<hr />
<div>=Usage=<br />
<br />
REFERENCE.MAPWAYPOINT ObjectUID,WayPointType<br />
<br />
=Description=<br />
<br />
This function adds/removes waypoints on client radar map (enhanced clients only).<br />
<br />
Waypoint types:<br />
0 = Remove waypoint<br />
1 = Corpse<br />
2 = Party Member<br />
4 = Quest Giver<br />
5 = New Player Quest<br />
6 = Healer<br />
11 = Shrine<br />
12 = Moongate<br />
14 = Green Dot<br />
15 = Green Dot (flashing)<br />
<br />
=Example=<br />
<br />
<spherescript>ON=@Dclick //let's suppose that dclicked item is a map (for example) where the target is stored in its link.<br />
src.mapwaypoint <link>,4</spherescript></div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=7992Characters2022-08-19T19:52:43Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] "ObjectUID, WaypointType" || W || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=7991Characters2022-08-19T19:51:40Z<p>Gorgo: /* Properties and Functions */</p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAPWAYPOINT]] || RW || Add/remove waypoints on client radar map (enhanced clients only).<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=7947Characters2022-07-07T04:33:16Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || X branch only. Fires when the character is attempting to parry a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HitParry&diff=7946@HitParry2022-07-07T03:30:45Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
X branch only. The trigger is fired before the trigger @(Skill)UseQuick for parrying is succesfull. By default a parried hit will reduce the damage by 100% and thus negating the hit and the following triggers (@Hit and so on).<br />
<br />
There are two for changing the damage reduced:<br />
<br />
* Overwriting the Argn1 value in the @HitParry trigger.<br />
<br />
* By using the EFFECT property in the skill definition of the Parrying Skill, in this case the damage will be reduced by the EFFECT value:<br />
- If only one values is defined (Example:EFFECT=75) the damage will always be reduced by 75% no matter skills.<br />
<br />
- If one or more values are defined (Example: EFFECT=25,75) the damage will be reduced by 25% when the Parrying skill is near 0.0 and by 75% when the Parrying skill is near 100.0, that is damage reduction will be scaled according to the character parrying skill.<br />
<br />
- If no values are defined, the default value of 100 will be used.<br />
<br />
<br />
Fires on:<br />
* [[Characters]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Characters|character]] that is attempting to parry the strike.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] that did the strike.<br />
|-<br />
| [[ARGO]] || The [[Items|weapon]] or shield used for parry, if any.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARNG1 || IO || Percent of damage that will be reduced (default 100%).<br />
|-<br />
| ARNG2 || IO || Damage type.<br />
|-<br />
| LOCAL.PARRYCHANCE || IO || The chance to parry the blow. The chance will be passed to the SkillUseQuick/UseQuick triggers.<br />
|-<br />
| LOCAL.PARRYSKILLID || IO || The skill used for parrying, this can be changed by setting the appropriate skill ID.<br />
|-<br />
| LOCAL.ITEMPARRYDAMAGECHANCE || IO || The chance that the parrying item will be damaged (default 100%).<br />
|-<br />
| LOCAL.DAMAGE || IO || The amount of damage (raw) before the parry reduction.<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Completely blocks the damage as if the parry damage reduction was set to 100.<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]<br />
[[Category: Characters]]<br />
[[Category: Combat]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HitParry&diff=7945@HitParry2022-07-06T20:30:37Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
The trigger is fired before the trigger @(Skill)UseQuick for parrying is succesfull. By default a parried hit will reduce the damage by 100% and thus negating the hit and the following triggers (@Hit and so on).<br />
<br />
There are two for changing the damage reduced:<br />
<br />
* Overwriting the Argn1 value in the @HitParry trigger.<br />
<br />
* By using the EFFECT property in the skill definition of the Parrying Skill, in this case the damage will be reduced by the EFFECT value:<br />
- If only one values is defined (Example:EFFECT=75) the damage will always be reduced by 75% no matter skills.<br />
<br />
- If one or more values are defined (Example: EFFECT=25,75) the damage will be reduced by 25% when the Parrying skill is near 0.0 and by 75% when the Parrying skill is near 100.0, that is damage reduction will be scaled according to the character parrying skill.<br />
<br />
- If no values are defined, the default value of 100 will be used.<br />
<br />
<br />
Fires on:<br />
* [[Characters]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Characters|character]] that is attempting to parry the strike.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] that did the strike.<br />
|-<br />
| [[ARGO]] || The [[Items|weapon]] or shield used for parry, if any.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARNG1 || IO || Percent of damage that will be reduced (default 100%).<br />
|-<br />
| ARNG2 || IO || Damage type.<br />
|-<br />
| LOCAL.PARRYCHANCE || IO || The chance to parry the blow. The chance will be passed to the SkillUseQuick/UseQuick triggers.<br />
|-<br />
| LOCAL.PARRYSKILLID || IO || The skill used for parrying, this can be changed by setting the appropriate skill ID.<br />
|-<br />
| LOCAL.ITEMPARRYDAMAGECHANCE || IO || The chance that the parrying item will be damaged (default 100%).<br />
|-<br />
| LOCAL.DAMAGE || IO || The amount of damage (raw) before the parry reduction.<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Completely blocks the damage as if the parry damage reduction was set to 100.<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]<br />
[[Category: Characters]]<br />
[[Category: Combat]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HitParry&diff=7944@HitParry2022-07-06T19:53:26Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
The trigger is fired before the trigger @(Skill)UseQuick for parrying is succesfull. By default a parried hit will reduce the damage by 100% and thus negating the hit and the following triggers (@Hit and so on).<br />
<br />
There are two for changing the damage reduced:<br />
<br />
* Overwriting the Argn1 value in the @HitParry trigger.<br />
<br />
* By using the EFFECT property in the skill definition of the Parrying Skill, in this case the damage will be reduced by the EFFECT value:<br />
- If only one values is defined (Example:EFFECT=75) the damage will always be reduced by 75% no matter skills.<br />
<br />
- If one or more values are defined (Example: EFFECT=25,75) the damage will be reduced by 25% when the Parrying skill is near 0.0 and by 75% when the Parrying skill is near 100.0, that is damage reduction will be scaled according to the character parrying skill.<br />
<br />
- If no values are defined, the default value of 100 will be used.<br />
<br />
<br />
Fires on:<br />
* [[Characters]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Characters|character]] that succesfully parried the strike.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] that did the strike.<br />
|-<br />
| [[ARGO]] || The [[Items|weapon]] or shield used for parry, if any.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARNG1 || IO || Percent of damage that will be reduced (default 100%).<br />
|-<br />
| ARNG2 || IO || Damage type.<br />
|-<br />
| LOCAL.PARRYCHANCE || IO || The chance to parry the blow. The chance will be passed to the SkillUseQuick/UseQuick triggers.<br />
|-<br />
| LOCAL.PARRYSKILLID || IO || The skill used for parrying, this can be changed by setting the appropriate skill ID.<br />
|-<br />
| LOCAL.ITEMPARRYDAMAGECHANCE || IO || The chance that the parrying item will be damaged (default 100%).<br />
|-<br />
| LOCAL.DAMAGE || IO || The amount of damage (raw) before the parry reduction.<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Completely blocks the damage as if the parry damage reduction was set to 100.<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]<br />
[[Category: Characters]]<br />
[[Category: Combat]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=How_Combat_Works&diff=7943How Combat Works2022-07-05T20:39:08Z<p>Gorgo: </p>
<hr />
<div>{{Languages|How_Combat_Works}}<br />
<br />
The following diagram shows when combat triggers are triggered. See the [[Triggers]] page for more information on each trigger.<br />
<br />
<br />
<tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[[@HitTry]] (attacker)<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;/&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\<br /><br />
[[@Hit]] (attacker)&nbsp;&nbsp;&nbsp;&nbsp;[[@HitMiss]] (attacker)<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|<br /><br />
[[@Damage]] (weapon)<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|<br /><br />
[[@HitParry]] (victim)<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|<br /><br />
[[@GetHit]] (victim)<br /><br />
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|<br /><br />
[[@Damage]] (armor)<br /></tt><br />
<br />
<br />
Thanks to Moe for posting this.<br />
<br />
[[Category:Articles]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HitParry&diff=7942@HitParry2022-07-05T20:36:33Z<p>Gorgo: </p>
<hr />
<div>==Description==<br />
The trigger is fired when a character succesfully parries a hit, before the trigger @(Skill)UseQuick for parrying is succesfull. By default a parried hit will reduce the damage by 100% and thus negating the hit and the following triggers (@Hit and so on).<br />
<br />
There are two for changing the damage reduced:<br />
<br />
* Overwriting the Argn1 value in the @HitParry trigger.<br />
<br />
* By using the EFFECT property in the skill definition of the Parrying Skill, in this case the damage will be reduced by the EFFECT value:<br />
- If only one values is defined (Example:EFFECT=75) the damage will always be reduced by 75% no matter skills.<br />
<br />
- If one or more values are defined (Example: EFFECT=25,75) the damage will be reduced by 25% when the Parrying skill is near 0.0 and by 75% when the Parrying skill is near 100.0, that is damage reduction will be scaled according to the character parrying skill.<br />
<br />
- If no values are defined, the default value of 100 will be used.<br />
<br />
<br />
Fires on:<br />
* [[Characters]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Characters|character]] that succesfully parried the strike.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] that did the strike.<br />
|-<br />
| [[ARGO]] || The [[Items|weapon]] or shield used for parry, if any.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARNG1 || IO || Percent of damage that will be reduced (default 100%).<br />
|-<br />
| ARNG2 || IO || Damage type.<br />
|-<br />
| LOCAL.ITEMPARRYDAMAGE || IO || The chance that the parrying item will be damaged (default 100%).<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Completely blocks the damage as if the parry damage reduction was set to 100.<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]<br />
[[Category: Characters]]<br />
[[Category: Combat]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@HitParry&diff=7941@HitParry2022-07-02T15:54:15Z<p>Gorgo: Created page with "==Description== The trigger is fired when a character succesfully parries a hit, that is the trigger @(Skill)UseQuick for parrying is succesfull. By default a parried hit will..."</p>
<hr />
<div>==Description==<br />
The trigger is fired when a character succesfully parries a hit, that is the trigger @(Skill)UseQuick for parrying is succesfull. By default a parried hit will reduce the damage by 100% and thus negating the hit and the following triggers (@Hit and so on).<br />
<br />
There are two for changing the damage reduced:<br />
<br />
* Overwriting the Argn1 value in the @HitParry trigger.<br />
<br />
* By using the EFFECT property in the skill definition of the Parrying Skill, in this case the damage will be reduced by the EFFECT value:<br />
- If only one values is defined (Example:EFFECT=75) the damage will always be reduced by 75% no matter skills.<br />
<br />
- If one or more values are defined (Example: EFFECT=25,75) the damage will be reduced by 25% when the Parrying skill is near 0.0 and by 75% when the Parrying skill is near 100.0, that is damage reduction will be scaled according to the character parrying skill.<br />
<br />
- If no values are defined, the default value of 100 will be used.<br />
<br />
<br />
Fires on:<br />
* [[Characters]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[I]] || The [[Characters|character]] that succesfully parried the strike.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] that did the strike.<br />
|-<br />
| [[ARGO]] || The [[Items|weapon]] or shield used for parry, if any.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARNG1 || IO || Percent of damage that will be reduced (default 100%).<br />
|-<br />
| ARNG2 || IO || Damage type.<br />
|-<br />
| LOCAL.ITEMPARRYDAMAGE || IO || The chance that the parrying item will be damaged (default 100%).<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Completely blocks the damage as if the parry damage reduction was set to 100.<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]<br />
[[Category: Characters]]<br />
[[Category: Combat]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Characters&diff=7940Characters2022-07-02T15:43:58Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Characters}}<br />
<br />
__FORCETOC__<br />
A character can be either a player or an NPC.<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[Accounts|ACCOUNT]] || RW || Gets or sets the [[Accounts|account]] that the character belongs to.<br />
|-<br />
| [[ACT]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that is related to the action the character is performing.<br />
|-<br />
| [[FINDCONT]]''.n'' || R || Gets the nth [[Items|item]] equipped to the character. (zero-based)<br />
|-<br />
| [[FINDID]]''.item_id'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[BASEID]].<br />
|-<br />
| [[FINDLAYER]]''.layer'' || R || Gets the [[Items|item]] that the character has equipped in a specified layer.<br />
|-<br />
| [[FINDTYPE]]''.type'' || R || Gets the first [[Items|item]] found equipped to the character or inside their backpack, with the matching [[TYPE]].<br />
|-<br />
| [[MEMORYFINDTYPE]]''.memory_flags'' || R || Gets a [[Items|memory item]] with the specified flags.<br />
|-<br />
| [[MEMORYFIND]].''object_uid'' || R || Gets a [[Items|memory item]] that is linked to the given object.<br />
|-<br />
| [[OWNER]] || R || Gets the character that owns this character. (RW in SphereServer-X Build)<br />
|-<br />
| [[SPAWNITEM]] || R || Gets the [[Items|spawn item]] (t_spawn_char) that this character originated from.<br />
|-<br />
| [[WEAPON]] || R || Gets the [[Items|weapon]] that the character currently has equipped.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the character is at.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the character is currently located in.<br />
|-<br />
| [[Rooms|ROOM]] || R || Gets the [[Rooms|room]] that the character is in.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the character is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the character.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[CHARDEF]] that defines the character.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all character properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the character, the property from the [[CHARDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[AC]] || R || Returns the character's total defense.<br />
|-<br />
| [[ACTARG1]] || RW || Gets or sets the character's ACTARG1 value. X branch only: for skills Enticement, Peacemaking and Provocation, if ACTARG1 is set to the UID of the instrument to play, it will be played the sound of that instrument.<br />
|-<br />
| [[ACTARG2]] || RW || Gets or sets the character's ACTARG2 value.<br />
|-<br />
| [[ACTARG3]] || RW || Gets or sets the character's ACTARG3 value.<br />
|-<br />
| [[ACTDIFF]] || RW || Gets or sets the difficulty of the character's current action.<br />
|-<br />
| [[ACTION]] || RW || Gets or sets the skill that the character is currently using.<br />
|-<br />
| [[ACTP]] || RW || Gets or sets the character's ACTP value. Can get x,y,z,position of the point in X branch.<br />
|-<br />
| [[ACTPRV]] || RW || Gets or sets the character's ACTPRV value.<br />
|-<br />
| [[AFK]] || W || Gets or sets whether or not the character is in AFK mode.<br />
|-<br />
| [[AGE]] || R || Returns the age of the character since its creation, in seconds.<br />
|-<br />
| [[ALLSKILLS]] ''amount'' || W || Sets all of the character's skills to the specified amount.<br />
|-<br />
| [[ANIM]] ''anim_id'' || W || Plays the specified animation on the character.<br />
|-<br />
| [[ATTACKER]]''.properties'' || R || Gets the number of opponents who have damaged the character.<br />
|-<br />
| [[BANK]] ''layer'' || W || Opens the character's bank (or the container at the specified layer) for SRC to view.<br />
|-<br />
| [[BANKBALANCE]] || R || Returns the total amount of gold in the character's bankbox.<br />
|-<br />
| [[BARK]] ''sound_id'' || W || Plays the specified sound (or the character's generic sound if not specified) to nearby clients from this character.<br />
|-<br />
| [[BODY]] || RW || Gets or sets the character's body.<br />
|-<br />
| [[BOUNCE]] ''item_uid'' || W || Places a specified item in the character's backpack.<br />
|-<br />
| [[BOW]] || W || Makes the character bow to SRC.<br />
|-<br />
| [[CAN (Characters)|CAN]] || RW || Gets or Sets the Can flags for this chardef. Only readable in X branch.<br />
|-<br />
| [[CANCAST]] ''spell_id, check_antimagic'' || R || Returns 1 if the character can cast a given spell, bypassing anti-magic field tests if ''check_antimagic'' set to 0.<br />
|-<br />
| [[CANMAKE]] ''item_id'' || R || Returns 1 if the character has the skills and resources to craft a certain item.<br />
|-<br />
| [[CANMAKESKILL]] ''item_id'' || R || Returns 1 if the character has the skills to craft a certain item.<br />
|-<br />
| [[CANMASK (Characters)|CANMASK]] || RW || X branch only. Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANMOVE]] ''direction'' || R || Returns 1 if the character can move in the given direction.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the character.<br />
|-<br />
| [[CANSEELOS]] || R || Returns 1 if SRC has line of sight to the character.<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags'' || R || Returns 1 if SRC has line of sight to the character, with flags to modify what tests take place.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the character's hue.<br />
|-<br />
| [[CONSUME]] ''resource_list'' || W || Removes specified resources from SRC's backpack.<br />
|-<br />
| [[COUNT]] || R || Returns the number of items equipped to the character.<br />
|-<br />
| [[CREATE]] || RW (R only on X)|| Gets or sets the character's age since creation, in seconds (Tenth of seconds on X).<br />
|-<br />
| [[CRIMINAL]] || W || Sets whether or not the character is a criminal.<br />
|-<br />
| [[CURFOLLOWER]] || RW || Gets or sets the number of current followers the character has,<br />
|-<br />
| [[DAMAGE]] ''amount, type, source'' || W || Inflicts damage upon the character.<br />
<br />
When using COMBAT_ELEMENTAL_ENGINE add the following parameters after ''source'': ''physical'',''fire'',''cold'',''poison'',''energy''. All the values are in %.<br />
<br />
<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DEX]] || RW || Gets or sets the character's total dexterity.<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DIALOGCLOSE]] ''dialog_id button'' || W || Closes a dialog that SRC has open, simulating a button press.<br />
|-<br />
| [[DIALOGLIST]]''.COUNT'' || R || Gets the number of number of dialogs currently considered to be visible on SRC's screen.<br />
|-<br />
| [[DIALOGLIST]]''.n.ID'' || R || Gets the ID of the nth dialog that SRC has open (zero-based).<br />
|-<br />
| [[DIALOGLIST]]''.n.COUNT'' || R || Gets the number of instances of nth dialog SRC has open (zero-based).<br />
|-<br />
| [[DIR]] || RW || Gets or setes the direction that the character is facing.<br />
|-<br />
| [[DISCONNECT]] || W || Disconnects the character.<br />
|-<br />
| [[DISMOUNT]] || W || Dismounts the character from their ride.<br />
|-<br />
| [[DISPIDDEC]] || R || Gets the ID of the character as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and either SRC, a map location or another object.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the character, with SRC as the source of the event.<br />
|-<br />
| [[DCLICK]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[DRAWMAP]] ''radius'' || W || Starts the cartography skill, drawing a map of the local area up to ''radius'' tiles.<br />
|-<br />
| [[DROP]] ''item_uid'' || W || Drops a specified item at the character's feet.<br />
|-<br />
| [[DUPE]] || W || Creates a clone of the character.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the character to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EMOTEACT]] || RW || Gets, sets or toggles whether or not the character will emote all of its actions.<br />
|-<br />
| [[EQUIP]] ''item_uid'' || W || Equips an item to the character.<br />
|-<br />
| [[EQUIPARMOR]] || W || Equips the character with the best armour in their backpack.<br />
|-<br />
| [[EQUIPHALO]] ''timeout'' || W || Equips a halo light to the character, lasting for ''timeout'' tenths of a second.<br />
|-<br />
| [[EQUIPWEAPON]] || W || Equips the character with the best weapon in their backpack.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[EXP]] || RW || Gets or sets the character's experience points.<br />
|-<br />
| [[FACE]] ''object_uid'' (P coords in X branch) || W || Turns the character to face a specified object or SRC. Admits coordinates instead uid in X branch.<br />
|-<br />
| [[FAME]] || RW || Gets or sets the character's fame.<br />
|-<br />
| [[FAME]]''.fame_group'' || R || Returns 1 if the character's fame falls within the specified fame group.<br />
|-<br />
| [[FCOUNT]] || R || Returns the total number of items equipped to the character, including subitems<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the character's flags.<br />
|-<br />
| [[FIX]] || W || Re-aligns the character's Z level to ground level.<br />
|-<br />
| [[FIXWEIGHT]] || W || Recalculates the character's total weight.<br />
|-<br />
| [[FLIP]] || W || Rotates the character.<br />
|-<br />
| [[FONT]] || RW || Gets or sets the character's speech font.<br />
|-<br />
| [[FOOD]] || RW || Gets or sets the character's food level.<br />
|-<br />
| [[FORGIVE]] || W || Revokes the character's jailed status.<br />
|-<br />
| [[GO]] ''location'' || W || Teleports the character to the specified location.<br />
|-<br />
| [[GOCHAR]] ''n'' || W || Teleports the character to the nth character in the world.<br />
|-<br />
| [[GOCHARID]] ''character_defname'' || W || Teleports the character to the next characer in the world with the specified [[BASEID]]<br />
|-<br />
| [[GOCLI]] ''n'' || W || Teleports the character to the nth online player. (zero-based)<br />
|-<br />
| [[GOITEMID]] ''item_defname'' || W || Teleports the character to the next item in the world with the specified [[BASEID]].<br />
|-<br />
| [[GOLD]] || RW || Gets or sets the amount of gold the character has.<br />
|-<br />
| [[GONAME]] ''name'' || W || Teleports the character to the next character or item in the world with the specified name, accepts wildcards (*).<br />
|-<br />
| [[GOSOCK]] ''socket'' || W || Teleports the character to the online player with the specified socket number.<br />
|-<br />
| [[GOTYPE]] ''item_type'' || W || Teleports the character to the next item in the world with the specified [[TYPE]].<br />
|-<br />
| [[GOUID]] ''object_uid'' || W || Teleports the character to the object with the specified [[UID]].<br />
|-<br />
| [[GUILDABBREV]] || R || Returns the character's guild abbreviation.<br />
|-<br />
| [[HEAR]] ''text'' || W || For NPCs, acts as if SRC had spoken the specified ''text''. For players, displays ''text'' as a system message.<br />
|-<br />
| [[HEIGHT]] || R || Gets the character's height.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the character's hitpoints.<br />
|-<br />
| [[HOME]] || RW || Gets or sets the character's home location.<br />
|-<br />
| [[HUNGRY]] || W || Displays this character's hunger level to SRC.<br />
|-<br />
| [[ID]] || R || Gets the character's ID.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the character to SRC.<br />
|-<br />
| [[INT]] || RW || Gets or sets the character's total intelligence.<br />
|-<br />
| [[INVIS]] || W || Sets whether or not the character is invisible.<br />
|-<br />
| [[INVUL]] || W || Sets whether or not the character is invulnerable.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISDIALOGOPEN]] ''dialog_id'' || R || Returns 1 if SRC has the specified dialog visible on their screen.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISGM]] || R || Returns 1 if the character is in GM mode.<br />
|-<br />
| [[ISINPARTY]] || R || Returns 1 if the player is in a [[party]].<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISMYPET]] || R || Returns 1 if the character belongs to SRC.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE.<br />
|-<br />
| [[ISONLINE]] || R || Returns 1 if the character is considered to be online.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player.<br />
|-<br />
| [[ISSTUCK]] || R || Returns 1 if the character cannot walk in any direction.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its [[CHARDEF]].<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISVENDOR]] || R || Returns 1 if the character is a vendor.<br />
|-<br />
| [[ISVERTICALSPACE]] ''location'' || R || Returns 1 if the ceiling at the given location is high enough for the character to fit under.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[JAIL]] ''cell'' || W || Sends the character to jail, to a specified jail cell.<br />
|-<br />
| [[KARMA]] || RW || Gets or sets the character's karma.<br />
|-<br />
| [[KARMA]]''.karma_group'' || R || Returns 1 if the character's karma falls within the specified karma group.<br />
|-<br />
| [[KILL]] || W || Kills the character.<br />
|-<br />
| [[LEVEL]] || RW || Gets or sets the character's experience level.<br />
|-<br />
| [[LIGHT]] || RW || Gets or sets the character's personal light level.<br />
|-<br />
| [[LUCK]] || RW || Gets or sets the luck value for the character.<br />
|-<br />
| [[MAKEITEM]] ''item_defname, amount'' ||| W || Begins an attempt to craft the specified quantity of the given item.<br />
|-<br />
| [[MANA]] || RW || Gets or sets the character's mana.<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAXFOLLOWER]] || RW || Gets or sets the maximum number of followers the character can have.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the character's maximum hitpoints.<br />
|-<br />
| [[MAXMANA]] || RW || Gets or sets the character's maximum mana.<br />
|-<br />
| [[MAXSTAM]] || RW || Gets or sets the character's maximum stamina.<br />
|-<br />
| [[MAXWEIGHT]] || R || Returns the maximum weight that the character can carry.<br />
|-<br />
| [[MEMORY]]''.object_uid'' || RW || Gets or sets the memory flags the character has for the given object.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this character to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this character to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the character's armour rating.<br />
|-<br />
| [[MODDEX]] || RW || Gets or sets the character's dexterity modifier.<br />
|-<br />
| [[MODINT]] || RW || Gets or sets the character's intelligence modifier.<br />
|-<br />
| [[MODMAXWEIGHT]] || RW || Gets or sets the character's maximum weight modifier.<br />
|-<br />
| [[MODSTR]] || RW || Gets or sets the character's strength modifier.<br />
|-<br />
| [[MOUNT]] || R || Gets the UID of the character's mount.<br />
|-<br />
| [[MOUNT]] ''mount_uid'' || W || Attempts to mount the character on to the specified mount.<br />
|-<br />
| [[MOVE]] ''direction'' || R || Returns the movement flags for the tile in the given direction (see can_flags in sphere_defs.scp).<br />
|-<br />
| [[MOVE]] ''direction, amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the character to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the character to a specific location.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the character's name.<br />
|-<br />
| [[NEWBIESKILL]] ''skill_id'' || W || Distributes items that are associated with the specified skill, to the character.<br />
|-<br />
| [[NEWGOLD]] ''amount'' || W || Generates ''amount'' gold in the character's backpack.<br />
|-<br />
| [[NEWLOOT]] ''item_or_template_defname'' || W || Generates the specified item or template into the character's backpack, providing that they are an NPC that hasn't been summoned.<br />
|-<br />
| [[NIGHTSIGHT]] || RW || Gets or sets whether or not the character has nightsight enabled.<br />
|-<br />
| [[NOTOGETFLAG]] ''viewer_uid, allow_incognito'' || RW || Gets the character's notoriety flags as seen by the specified viewer.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the character's AI type.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the character's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the characer's Z level.<br />
|-<br />
| [[OBODY]] || RW || Gets or sets the character's original body.<br />
|-<br />
| [[OPENPAPERDOLL]] || W || Displays the character's paperdoll to SRC.<br />
|-<br />
| [[OPENPAPERDOLL]] ''character_uid'' || W || Displays a specified character's paperdoll to this character.<br />
|-<br />
| [[OSKIN]] || RW || Gets or sets the character's original colour.<br />
|-<br />
| [[ODEX]] || RW || Gets or sets the character's base dexterity (without modifiers).<br />
|-<br />
| [[OINT]] || RW || Gets or sets the character's base intelligence (without modifiers).<br />
|-<br />
| [[OSTR]] || RW || Gets or sets the character's base strength (without modifiers).<br />
|-<br />
| [[PACK]] || W || Opens the character's backpack for SRC to view.<br />
|-<br />
| [[POISON]] ''strength'' || W || Poisons the character, with the specified poison strength.<br />
|-<br />
| [[POLY]] ''character_id'' || W || Begins casting the polymorph spell, with ''character_id'' being the character to turn into.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[PRIVSET]] ''plevel'' || W || Sets the PLEVEL of the character.<br />
|-<br />
| [[RANGE]] || R || Gets the combat range of the character.<br />
|-<br />
| [[RELEASE]] || W || Clears the character's owners.<br />
|-<br />
| [[REMOVE]] ''allow_player_removal'' || W || Deletes the character.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOLD]] || RW || Gets or sets the character's resistance to cold.<br />
|-<br />
| [[RESCOLDMAX]] || RW || Gets or sets the character's maximum resistance to cold.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item equipped to the character or inside their baackpack.<br />
|-<br />
| [[RESENDTOOLTIP]] ''sendfull'',''usecache'' || W || Forces Sphere to update the tooltips for nearby clients. If sendfull is 1 the entire tooltip is sent and if 0 then just the header is sent. If usecache is 1 then the cached version (if found) will be sent and if 0 then the cached version (if found) will be replaced and sent<br />
|-<br />
| [[RESENERGY]] || RW || Gets or sets the character's resistance to energy.<br />
|-<br />
| [[RESENERGYMAX]] || RW || Gets or sets the character's maximum resistance to energy.<br />
|-<br />
| [[RESFIRE]] || RW || Gets or sets the character's resistance to fire.<br />
|-<br />
| [[RESFIREMAX]] || RW || Gets or sets the character's maximum resistance to fire.<br />
|-<br />
| [[RESPOISON]] || RW || Gets or sets the character's resistance to poison.<br />
|-<br />
| [[RESPOISONMAX]] || RW || Gets or sets the character's maximum resistance to poison.<br />
|-<br />
| [[RESTEST]] ''item_list'' || R || Returns 1 if all of the items in the list can be found equipped to the character or inside their backpack.<br />
|-<br />
| [[RESURRECT]] ''force'' || W || Resurrects the character. If ''force'' is 1 then usual anti-magic checks are bypasses.<br />
|-<br />
| [[SALUTE]] ''object_uid'' || W || Makes the character salute a specified object or SRC.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the character speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the character speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || MAkes the character speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEX]] ''value_male:value_female'' || R || Returns ''value_male'' or ''value_female'' depending on the character's gender.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the character's location or a specified location into sextant coordinates.<br />
|-<br />
| ''skill_name'' || RW || Gets or sets the character's skill level in ''skill_name''.<br />
|-<br />
| [[SKILL (Function)|SKILL]] || W || Begins using a skill.<br />
|-<br />
| [[SKILLADJUSTED]]."number or skill_name" (X branch only) || R || Returns the skill value adjusted by the stat bonus. Example “SkillAdjusted.1” or “SkillAdjusted.Anatomy”.<br />
|-<br />
| [[SKILLCHECK]] ''skill_id, difficulty'' || R || Performs a check for skill success, returning 1 if the attempt was successful.<br />
|-<br />
| [[SKILLBEST]]''.n'' || R || Returns the ID of the character's nth highest skill (0 = Highest)<br />
|-<br />
| [[SKILLGAIN]] ''skill, difficulty'' || W || Invokes Sphere's skill gain for the specified skill, with the given difficulty (0-100)<br />
|-<br />
| [[SKILLTEST]] ''skill_list'' || R || Returns 1 if the character possess all of the skills in the list.<br />
|-<br />
| [[SKILLTOTAL]] || R || Returns the total value of all the character's skills.<br />
|-<br />
| [[SKILLTOTAL]] ''skill_group'' || R || Returns the total value of all the character's skills with the specified group flag(s).<br />
|-<br />
| [[SKILLTOTAL]] ''-amount'' || R || Returns the total value of all the character's skills that are under ''amount''.<br />
|-<br />
| [[SKILLTOTAL]] ''+amount'' || R || Returns the total value of all the character's skills that are over ''amount''.<br />
|-<br />
| [[SKILLUSEQUICK]] ''skill_id, difficulty'' || R || Quickly uses a skill, returning 1 if the attempt was successful.<br />
|-<br />
| [[SLEEP]] ''fall_forwards'' || W || Makes the character appear to sleep.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this character.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the character to be affected by a spell.<br />
|-<br />
| [[SPEECHCOLOROVERRIDE]] ''value'' || RW || Override client speech hue. <br />
|-<br />
| [[STAM]] || RW || Gets or sets the character's stamina.<br />
|-<br />
| [[STEPSTEALTH]] || RW || Gets or sets the amount of steps a character can do while using the Stealth skill.<br />
|-<br />
| [[STONE]] || RW || Gets or sets whether or not the character is trapped in stone.<br />
|-<br />
| [[STR]] || RW || Gets or sets the character's total strength.<br />
|-<br />
| [[SUICIDE]] || W || Forces the character to commit suicide.<br />
|-<br />
| [[SUMMONCAGE]] || W || Teleports the character to SRC's, surrounded by a cage multi.<br />
|-<br />
| [[SUMMONTO]] || W || Teleports the character to SRC's position.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Scheduled a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the character.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the character. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TITHING]] || RW || Gets or sets the number of tithing points the character has.<br />
|-<br />
| [[TITLE]] || RW || Gets or sets the character's title.<br />
|-<br />
| [[TOWNABBREV]] || R || Returns the character's town abbreviation.<br />
|-<br />
| [[TRIGGER]] ''trig_name, trig_type'' || R || Fires a custom trigger and returns the RETURN value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNDERWEAR]] || W || Toggles the display of underwear on the character.<br />
|-<br />
| [[UNEQUIP]] ''item_uid'' || W || Unequips an item from the character, placing it in their backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the character to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the character to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the character, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[USEITEM]] ''object_uid'' || W || Double clicks an object, with the character as SRC.<br />
|-<br />
| [[VISUALRANGE]] || RW || Gets or sets the character's sight range.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the character.<br />
|-<br />
| [[WHERE]] || W || Describes the character's location to SRC.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the character.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all character triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Attack]] || Fires when the character begins attacking another.<br />
|-<br />
| [[@CallGuards]] || Fires when the character calls for guards.<br />
|-<br />
| [[@CharAttack]] || Fires when the character is attacked by another character.<br />
|-<br />
| [[@CharClick]] || Fires when the character is clicked by another character.<br />
|-<br />
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.<br />
|-<br />
| [[@CharDClick]] || Fires when the character double clicks another character.<br />
|-<br />
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.<br />
|-<br />
| [[@CombatAdd]] || Fires when someone is being added to my attacker list.<br />
|-<br />
| [[@CombatDelete]] || Fires when someone is deleted from my attacker list.<br />
|-<br />
| [[@CombatEnd]] || Fires when someone is being deleted from my attacker list.<br />
|-<br />
| [[@CombatStart]] || Fires when adding first attacker to my list.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Criminal]] || Fires when the character becomes a criminal.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Death]] || Fires when the character's hitpoints reaches zero.<br />
|-<br />
| [[@DeathCorpse]] || Fires when a corpse is created for the character.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@Dismount]] || Fires when the character dismounts their ride.<br />
|-<br />
| [[@Dye]] || Fires when the character is about to change their color or the color of an object.<br />
|-<br />
| [[@Eat]] || Fires when the character eats something.<br />
|-<br />
| [[@EnvironChange]] || Fires when the environment changes for the character.<br />
|-<br />
| [[@ExpChange]] || Fires when the character's experience points change.<br />
|-<br />
| [[@ExpLevelChange]] || Fires when the character's experience level changes.<br />
|-<br />
| [[@FameChange]] || Fires when the character's fame changes.<br />
|-<br />
| [[@GetHit]] || Fires when the character receives damage.<br />
|-<br />
| [[@Hit]] || Fires when the character hits another in combat.<br />
|-<br />
| [[@HitMiss]] || Fires when the character fails to hit another in combat.<br />
|-<br />
| [[@HitParry]] || Fires when the character successfully parries a hit.<br />
|-<br />
| [[@HitTry]] || Fires when the character tries to hit another in combat.<br />
|-<br />
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.<br />
|-<br />
| [[@HouseDesignExit]] || Fires when the character exits house design mode.<br />
|-<br />
| [[@Hunger]] || Fires when the character's food level decreases.<br />
|-<br />
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.<br />
|-<br />
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.<br />
|-<br />
| [[@ItemClick]] || Fires when the character single-clicks an item.<br />
|-<br />
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.<br />
|-<br />
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.<br />
|-<br />
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.<br />
|-<br />
| [[@ItemCreate]] || Fires when an item is initially created, before it is placed in the world, and the character is in some way responsible for it.<br />
|-<br />
| [[@ItemDamage]] || Fires when the character damages an item.<br />
|-<br />
| [[@ItemDClick]] || Fires when the character double-clicks an item.<br />
|-<br />
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.<br />
|-<br />
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.<br />
|-<br />
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.<br />
|-<br />
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.<br />
|-<br />
| [[@ItemEquip]] || Fires when the character equips an item.<br />
|-<br />
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.<br />
|-<br />
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.<br />
|-<br />
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.<br />
|-<br />
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.<br />
|-<br />
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.<br />
|-<br />
| [[@ItemSell]] || Fires when the character sells an item to a vendor.<br />
|-<br />
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.<br />
|-<br />
| [[@ItemStep]] || Fires when the character steps on an item.<br />
|-<br />
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.<br />
|-<br />
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.<br />
|-<br />
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.<br />
|-<br />
| [[@ItemUnEquip]] || Fires when the character unequips an item.<br />
|-<br />
| [[@Jailed]] || Fires when the character is sent to jail.<br />
|-<br />
| [[@KarmaChange]] || Fires when the character's karma changes.<br />
|-<br />
| [[@Kill]] || Fires when the character kills another character.<br />
|-<br />
| [[@Login]] || Fires when the character logs in.<br />
|-<br />
| [[@Logout]] || Fires when the character logs out.<br />
|-<br />
| [[@Mount]] || Fires when the character mounts a ride.<br />
|-<br />
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.<br />
|-<br />
| [[@MurderMark]] || Fires when the character is about to gain a kill.<br />
|-<br />
| [[@NotoSend]] || Fires the status bar/character notoriety color is sent to another players.<br />
|-<br />
| [[@NPCAcceptItem]] || Fires when the NPC receives an item.<br />
|-<br />
| [[@NPCActFight]] || Fires when the NPC makes a combat decision.<br />
|-<br />
| [[@NPCActFollow]] || Fires when the NPC follows another character.<br />
|-<br />
| [[@NPCAction]] || Fires when the NPC is about to perform an AI action.<br />
|-<br />
| [[@NPCActWander]] || X branch only. Fires each step an NPC does while wandering.<br />
|-<br />
| [[@NPCHearGreeting]] || Fires when the NPC hears a character for the first time.<br />
|-<br />
| [[@NPCHearUnknown]] || Fires when the NPC hears something they don't understand.<br />
|-<br />
| [[@NPCLookAtChar]] || Fires then the NPC looks at a character.<br />
|-<br />
| [[@NPCLookAtItem]] || Fires when the NPC looks at an item.<br />
|-<br />
| [[@NPCLostTeleport]] || Fires when the NPC is lost and is about to be teleported back to their [[HOME]].<br />
|-<br />
| [[@NPCRefuseItem]] || Fires when the NPC refuses an item being given to them.<br />
|-<br />
| [[@NPCRestock]] || Fires when the NPC is having their items restocked.<br />
|-<br />
| [[@NPCSeeNewPlayer]] || Fires when the NPC first sees a player.<br />
|-<br />
| [[@NPCSeeWantItem]] || Fires when the NPC sees an item they want.<br />
|-<br />
| [[@NPCSpecialAction]] || Fires when the NPC is about to perform a special action (leaving fire trail, dropping web).<br />
|-<br />
| [[@PayGold]] || Fires when the character receives a payment. (Experimental Build Only)<br />
|-<br />
| [[@PersonalSpace]] || Fires when the character is stepped on.<br />
|-<br />
| [[@PetDesert]] || Fires when the character deserts its owner.<br />
|-<br />
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.<br />
|-<br />
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.<br />
|-<br />
| [[@RegenStat]] || Fires when a character is going to regenerate any stat point.<br />
|-<br />
| [[@RegionEnter]] || Fires when the character enters a region.<br />
|-<br />
| [[@RegionLeave]] || Fires when the character leaves a region.<br />
|-<br />
| [[@RegionResourceFound]] || Fires after a resource has been selected and the resource bit has been created.<br />
|-<br />
| [[@Rename]] || Fires when the character renames another.<br />
|-<br />
| [[@Resurrect]] || Fires when the character is being resurrected.<br />
|-<br />
| [[@SeeCrime]] || Fires when the character sees a crime take place.<br />
|-<br />
| [[@SeeHidden]] || Fires when this character is about to see a hidden character.<br />
|-<br />
| [[@SkillAbort]] || Fires when the character aborts a skill.<br />
|-<br />
| [[@SkillChange]] || Fires when the character's skill level changes.<br />
|-<br />
| [[@SkillFail]] || Fires when the character fails a skill.<br />
|-<br />
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.<br />
|-<br />
| [[@SkillMakeItem]] || Fires when the character crafts an item.<br />
|-<br />
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.<br />
|-<br />
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.<br />
|-<br />
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.<br />
|-<br />
| [[@SkillStart]] || Fires when the character starts a skill.<br />
|-<br />
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.<br />
|-<br />
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.<br />
|-<br />
| [[@SkillWait]] || Fires when Sphere wants to check if a character must wait before starting a skill.<br />
|-<br />
| [[@SpellBook]] || Fires when the character opens their spellbook.<br />
|-<br />
| [[@SpellCast]] || Fires when the character casts a spell.<br />
|-<br />
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.<br />
|-<br />
| [[@SpellFail]] || Fires when the character fails to cast a spell.<br />
|-<br />
| [[@SpellSelect]] || Fires when the character selects a spell to cast.<br />
|-<br />
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.<br />
|-<br />
| [[@SpellTargetCancel]] || Fires when the character cancels target selection for a spell they have just cast.<br />
|-<br />
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.<br />
|-<br />
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.<br />
|-<br />
| [[@ToggleFlying]] || Fires when a Gargoyle Player is going to Fly or to Land.<br />
|-<br />
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.<br />
|-<br />
| [[@TradeAccepted]] || Fires when the character accepts a trade with another player.<br />
|-<br />
| [[@TradeClose]] || Fires when a trade window is closed.<br />
|-<br />
| [[@TradeCreate]] || Fires when a player begins a trade with another player.<br />
|-<br />
| [[@UserBugReport]] || Fires when the player submits a bug report.<br />
|-<br />
| [[@UserChatButton]] || Fires when the player presses the Chat button on the paperdoll.<br />
|-<br />
| [[@UserExtCmd]] || Fires when the player sends an extended command packet. (used by some macros)<br />
|-<br />
| [[@UserExWalkLimit]] || Fires when the player's movement is restricted by the movement speed settings in Sphere.ini<br />
|-<br />
| [[@UserGuildButton]] || Fires when the player presses the Guild button on the paperdoll.<br />
|-<br />
| [[@UserKRToolbar]] || Fires when the player presses a button on the toolbar.<br />
|-<br />
| [[@UserMailBag]] || Fires when the player drags the mail bag on to another character.<br />
|-<br />
| [[@UserQuestArrowClick]] || Fires when the player clicks the quest arrow.<br />
|-<br />
| [[@UserQuestButton]] || Fires when the player presses the Quest button on the paperdoll.<br />
|-<br />
| [[@UserSkills]] || Fires when the player opens their skill menu, or a skill update is sent to the player.<br />
|-<br />
| [[@UserSpecialMove]] || Fires when the player uses a special move.<br />
|-<br />
| [[@UserStats]] || Fires when the player opens the status window.<br />
|-<br />
| [[@UserUltimaStoreButton]] || Fires when click on 'Ultima Store' button on new clients 7.0.62+<br />
|-<br />
| [[@UserVirtue]] || Fires when the player presses on the Virtue button.<br />
|-<br />
| [[@UserVirtueInvoke]] || Fires when the player invokes a virtue through macros.<br />
|-<br />
| [[@UserWarmode]] || Fires when the player switches between war and peace mode.<br />
|}<br />
<br />
==Players==<br />
Characters that are attached to an account become Player Characters. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GUILD]] || R || Gets the [[Special Items#Guild.2FTown_Stones|guild stone]] that the player belongs to.<br />
|-<br />
| [[SKILLCLASS (Reference)|SKILLCLASS]] || RW || Gets or sets the player's [[SKILLCLASS|skillclass]].<br />
|-<br />
| [[TOWN]] || R || Gets the [[Special Items#Guild.2FTown_Stones|town stone]] that the player belongs to.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all player properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[DEATHS]] || RW || Gets or sets the number of times the player has died.<br />
|-<br />
| [[DSPEECH]] ''+/-speech_id'' || RW || Gets a list of attached speech handlers, or adds or removes a speech handler to or from the player.<br />
|-<br />
| [[GMPAGE]]''.n.DELETE'' || W || Deletes the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.HANDLE'' || W || Sets the player as the handler for the nth GM page. (zero-based)<br />
|-<br />
| [[GMPAGE]]''.n.key'' || W || Executes the .page command with ''key'' as the arguments.<br />
|-<br />
| [[ISDSPEECH]]''.speech_id'' || R || Returns 1 if the player has the given speech handler attached.<br />
|-<br />
| [[KICK]] || W || Disconnects and blocks the player's account.<br />
|-<br />
| [[KILLS]] || RW || Gets the number of murders the player has committed.<br />
|-<br />
| [[KRTOOLBARSTATUS]] || RW || Gets or sets whether or not the KR toolbar is enabled for this player.<br />
|-<br />
| [[LASTUSED]] || RW || Gets the length of time since the player was last attached to a client, in seconds.<br />
|-<br />
| [[PASSWORD]] || W || Sets or clears the player's password.<br />
|-<br />
| [[PFLAG]] || RW || Gets or sets the player's PFLAG value.<br />
|-<br />
| [[PROFILE]] || RW || Gets or sets the text to display on the player's profile.<br />
|-<br />
| [[SKILLLOCK]]''.skill_id'' || RW || Gets or sets the lock state of the player's skill. 0 is Up. 1 is Down. 2 is Locked.<br />
|-<br />
| [[SPEEDMODE]] || RW || Gets or sets the speed that the player moves at. (0=Normal, 1=Double Speed on Foot, 2=Always walk, 3=Always Run on Foot/Always Walk on Mount, 4=Can not Walk or Run)<br />
|-<br />
| [[STATLOCK]]''.stat_id || RW || Gets or sets the lock state of the player's STR (0), DEX (2) or INT (1). [0 = up, 1 = down, 2 = locked]<br />
|}<br />
<br />
==NPCs==<br />
Characters that are not attached to an account are NPCs and are controlled by Sphere's AI. In addition to the basic character references, properties and functions they also receive the following:<br />
<br />
===Properties and Functions===<br />
Here is a list of all NPC properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ACTPRI]] || RW || Gets or sets the NPC's motivation towards their current action.<br />
|-<br />
| [[BUY]] || W || Displays the shop window to SRC, in buy mode.<br />
|-<br />
| [[BYE]] || W || Ends the NPC's current action.<br />
|-<br />
| [[FLEE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[GOTO]] ''location'' || W || Begins moving the NPC towards the specified location.<br />
|-<br />
| [[HIRE]] || W || Begins the hiring process between the NPC and SRC.<br />
|-<br />
| [[LEAVE]] ''distance'' || W || Begins moving the NPC away from its current location.<br />
|-<br />
| [[NPC]] || RW || Gets or sets the NPC's AI type.<br />
|-<br />
| [[HOMEDIST]] || RW || Gets or sets the distance that the NPC can wander from its [[HOME]] position.<br />
|-<br />
| [[PETRETRIEVE]] || W || Enables SRC to retrieve their stabled pets from the NPC.<br />
|-<br />
| [[PETSTABLE]] || W || Enables SRC to stable their pet with the NPC.<br />
|-<br />
| [[RESTOCK]] ''force'' || W || Clears all of the NPC's stock, repopulating it when it is next accessed (or immediately if ''force''=1)<br />
|-<br />
| [[RUN]] ''direction'' || W || Forces the NPC to run one tile in the specified direction.<br />
|-<br />
| [[SELL]] || W || Displays the shop window to SRC, in sell mode.<br />
|-<br />
| [[SHRINK]] || W || Shrinks the NPC into a figurine item.<br />
|-<br />
| [[SPEECH]] ''+/-speech_id'' || RW || Gets the list of speech handlers attached to the NPC, or adds or removes a speech handler to or from the NPC.<br />
|-<br />
| [[SPEECHCOLOR]] || RW || Gets or sets the colour of the NPC's speech.<br />
|-<br />
| [[THROWDAM]] ''min,max'' || RW || Gets or sets a range of damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWDAM]] ''dam'' || RW || Gets or sets the constant damage used for thrown objects. (overrides chardef property)<br />
|-<br />
| [[THROWOBJ]] ''id'' || RW || Gets or sets the ID of an object to be thrown by NPCs. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''min,max'' || RW || Gets or sets the range that an object can be thrown at. (overrides chardef property)<br />
|-<br />
| [[THROWRANGE]] ''max'' || RW || Gets or sets the range that an object can be thrown at with a default min of 2. (overrides chardef property)<br />
|-<br />
| [[TRAIN]] ''skill'' || W || Initiates training between the NPC and SRC.<br />
|-<br />
| [[VENDCAP]] || RW || Gets or sets the amount of gold a vendor will restock to.<br />
|-<br />
| [[VENDGOLD]] || RW || Gets or sets the amount of gold a vendor has.<br />
|-<br />
| [[WALK]] ''direction'' || W || Forces the NPC to walk one tile in the specified direction.<br />
|}<br />
<br />
==Clients==<br />
When a client is controlling a character, the following references, properties and functions will be available:<br />
<br />
===References===<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[GMPAGEP]] || R || Gets the [[GM Pages|GM page]] that the client is currently handling.<br />
|-<br />
| [[HOUSEDESIGN]] || R || Gets the [[Special Items#Customizable Multis|building]] that is currently being designed by the client.<br />
|-<br />
| [[PARTY]] || R || Gets the [[Parties|party]] that the client is a member of.<br />
|-<br />
| [[TARG]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client has targeted.<br />
|-<br />
| [[TARGP]] || RW || Gets or sets the [[Map Points|location]] that the client has targeted.<br />
|-<br />
| [[TARGPROP]] || RW || Gets or sets the character whose skills are shown in the client's skill menu.<br />
|-<br />
| [[TARGPRV]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the client previously targeted.<br />
|}<br />
<br />
<br />
===Properties and Functions===<br />
Here is a list of all client properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[ADD]] ''item_defname'' || W || Prompts the client to target a location to add the specified item at.<br />
|-<br />
| [[ADDBUFF]] ''icon, cliloc1, cliloc2, time, arg1, arg2, arg3'' || W || Displays a buff icon in the client's buff icon bar.<br />
|-<br />
| [[ADDCLILOC]] ''cliloc, args'' || W || Adds a cliloc to the tooltip being sent to the client. Only valid in @ClientTooltip triggers.<br />
|-<br />
| [[ADDCONTEXTENTRY]] ''entry_id, cliloc, flags, colour'' || W || Adds an entry to the context menu being sent to the client. Only valid in @ContextMenuRequest triggers.<br />
|-<br />
| [[ALLMOVE]] || RW || Gets or sets whether or not the client has ALLMOVE privileges.<br />
|-<br />
| [[ALLSHOW]] || RW || Gets or sets whether or not the client is able to see disconnected characters.<br />
|-<br />
| [[ARROWQUEST]] ''x, y, id'' || W || Displays an arrow on the client's screen that points to the specified world coordinates. If id is supplied multiple arrows can be displayed on the client at once (Newer clients only - 3.x+ clients confirm?). You can cancel the arrow by passing 0 for x and y and your id. Using ARROWQUEST without any arguments will cancel arrow with id 0 if present.<br />
|-<br />
| [[BADSPAWN]] || W || Teleports the client to the first invalid spawn point in the world.<br />
|-<br />
| [[BANKSELF]] || W || Opens up the client's bankbox.<br />
|-<br />
| [[CAST]] ''spell_id' || W || Begins casting a spell.<br />
|-<br />
| [[CHARLIST]] || W || Displays the client's character list screen.<br />
|-<br />
| [[CLEARCTAGS]] || W || Removes all of the client's CTAGs.<br />
|-<br />
| [[CLIENTIS3D]] || R || Returns 1 if the client is using the 3D client.<br />
|-<br />
| [[CLIENTISKR]] || R || Returns 1 if the client is using the KR client.<br />
|-<br />
| [[CLIENTVERSION]] || R || Gets the client version the client is using, based on the encryption keys being used (unencrypted clients return 0).<br />
|-<br />
| [[CTAG]] || RW || Gets or sets the value of a CTAG.<br />
|-<br />
| [[CTAGCOUNT]] || R || Gets the number of CTAGs stored on the client.<br />
|-<br />
| [[CTAGLIST]] || W || Displays a list of the client's CTAGs to SRC.<br />
|-<br />
| [[CTAGLIST]] LOG || W || Displays a list of the client's CTAGs on the server console.<br />
|-<br />
| [[DEBUG]] || RW || Gets or sets whether or not the client is in debug mode.<br />
|-<br />
| [[DETAIL]] || RW || Gets or sets whether or not the client receives additional detail, such as combat messages.<br />
|-<br />
| [[EVERBTARG]] ''command'' || W || Prompts the client to enter a command, or arguments to the command if specified. The complete command with arguments is then executed on TARG.<br />
|-<br />
| [[EXTRACT]] ''file, template_id'' || W || Extracts static items from a targeted area on the map and saves them into the specified file.<br />
|-<br />
| [[FLUSH]] || W || Forces queued network data to be immediately sent to the client.<br />
|-<br />
| [[GM]] || RW || Gets or sets whether or not the client is in GM mode.<br />
|-<br />
| [[GMPAGE]] ''ADD message'' || W || Sends a GM page from the client with the specified message, or if no arguments provided will prompt the client for a message.<br />
|-<br />
| [[GOTARG]] || W || Teleports the client to their targeted item.<br />
|-<br />
| [[HEARALL]] || RW || Gets or sets whether or not the client can hear all player speech regardless of location.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog to the client for an object they target.<br />
|-<br />
| [[INFORMATION]] || W || Displays server information to the client.<br />
|-<br />
| [[LAST]] || W || Forces the client to target the object referenced by [[ACT]].<br />
|-<br />
| [[LASTEVENT]] || RW || Returns the time when data was last received from the client.<br />
|-<br />
| [[LINK]] || W || Allows the client to target two objects to link them together.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_id'' || W || Displays a menu to the client.<br />
|-<br />
| [[MIDILIST]] ''music1, music2, ...'' || W || Selects a random music id from the given list and tells the client to play it.<br />
|-<br />
| [[NUDGE]] ''dx, dy, dz'' || W || Allows the client to nudge an area of items by the given coordinates, relative to the items' position.<br />
|-<br />
| [[NUKE]] ''command'' || W || Allows the client to execute ''command'' on all items in a targeted area.<br />
|-<br />
| [[NUKECHAR]] ''command'' || W || Allows the client to execute ''command'' on all NPCs in a targeted area.<br />
|-<br />
| [[PAGE]] || W || Displays the GM page menu to the client.<br />
|-<br />
| [[PRIVSHOW]] || W || Gets or sets whether or not the client's privilege level should show in their name.<br />
|-<br />
| [[REMOVEBUFF]] ''icon'' || W || Removes a buff icon from the client's buff icon bar.<br />
|-<br />
| [[REPAIR]] || W || Prompts the client to target an item for them to repair.<br />
|-<br />
| [[REPORTEDCLIVER]] || R || Gets the client version the client is using, based on what it has identified itself as to the server.<br />
|-<br />
| [[REPORTEDCLIVER]].FULL || R || Gets the client version the client is using, based on what it has identified itself as to the server, including the 4th digit.<br />
|-<br />
| [[RESEND]] || W || Forces a full refresh of the client's screen.<br />
|-<br />
| [[SAVE]] ''immediate'' || W || Begins a world save. If background saving is enabled then ''[[SAVE]] 1'' will force a foreground save.<br />
|-<br />
| [[SCREENSIZE]] || R || Gets the client's screen size. (width,height)<br />
|-<br />
| [[SCREENSIZE]].X || R || Gets the width of the client's screen size.<br />
|-<br />
| [[SCREENSIZE]].Y || R || Gets the height of the client's screen size.<br />
|-<br />
| [[SCROLL]] ''scroll_id'' || W || Displays a message scroll to the client.<br />
|-<br />
| [[SELF]] || W || Forces the client to target itself.<br />
|-<br />
| [[SENDPACKET]] ''data'' || W || Sends a raw data packet to the client.<br />
|-<br />
| [[SET]] ''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|-<br />
| [[SHOWSKILLS]] || W || Refreshes the client's skills for the skill menu.<br />
|-<br />
| [[SKILLMENU (Function)|SKILLMENU]] ''skillmenu_id'' || W || Displays a skillmenu to the client.<br />
|-<br />
| [[SKILLSELECT]] ''skill_id'' || W || Simulates the client selecting a skill from their skill menu.<br />
|-<br />
| [[SUMMON]] ''character_id'' || W || Casts the summon spell, with ''character_id'; being the character to summon.<br />
|-<br />
| [[SYSMESSAGE]] ''text'' || W || Displays a system message to the client.<br />
|-<br />
| [[SYSMESSAGELOC]] ''hue, cliloc, args'' || W || Displays a localized system message to the client.<br />
|-<br />
| [[SYSMESSAGELOCEX]] ''hue, cliloc, flags, affix, args'' || W || Displays a localized system message to the client with affixed text.<br />
|-<br />
| [[SYSMESSAGEUA]] ''hue, font, mode, language, text'' || W || Displays a UNICODE system message to the client.<br />
|-<br />
| [[TARGETTEXT]] || RW || Gets or sets the client's target text.<br />
|-<br />
| [[TELE]] || W || Casts the teleport spell.<br />
|-<br />
| [[TILE]] ''z, item1, item2, ...'' || W || Tiles the ground within a targeted area with the listed items, at the given Z level.<br />
|-<br />
| [[UNEXTRACT]] ''file'' || W || Unextracts previously extracted statics, as dynamic items at a targeted location.<br />
|-<br />
| [[VERSION]] || W || Displays the server description to the client.<br />
|-<br />
| [[WEBLINK]] ''url'' || W || Opens the client's web browser to send them to the specified url.<br />
|-<br />
| [[X]]''command'' || W || Prompts the client to target an object to execute ''command'' on.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@Redeed&diff=7937@Redeed2022-05-01T19:39:54Z<p>Gorgo: Created page with "==Description== This trigger fires when a multi is about to redeed. Valid for t_multi, t_ship, t_multi_custom and t_addon. Fires on: * Items ==References== The followi..."</p>
<hr />
<div>==Description==<br />
This trigger fires when a multi is about to redeed. Valid for t_multi, t_ship, t_multi_custom and t_addon.<br />
<br />
<br />
Fires on:<br />
* [[Items]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[ARGO]] || The deed<br />
|-<br />
| [[I]] || The multi<br />
|-<br />
| [[SRC]] || Player doing the redeed (If Any). When the multi is being removed there is no SRC (also when an Addon is being redeeded from internal functions).<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARGN1 || I || ID of the deed (Default=i_deed)<br />
|-<br />
| ARGN2 || I || (Default = 1). If set to 1 all items will be moved to the Moving Crate (and Addons redeeded).<br />
|-<br />
| ARGN3 || I || If set to 1 the Moving Crate will be transfered to Owner's Bank (if there is any).<br />
Note: the crate is moved to the OWNER's bank, not SRC.<br />
If argn2 = 0 then argn3 will be not used regardless of the value it has.<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 1 || Prevents the deed from being created, but will not block the code from argn2 and argn3<br />
|}<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Items&diff=7936Items2022-05-01T19:32:03Z<p>Gorgo: </p>
<hr />
<div>{{Languages|Items}}<br />
<br />
__FORCETOC__<br />
Generally speaking, there are two types of "things" in the game; characters and items. Compared to characters, items are very complex. Items have a number of different uses, for example a sword is an item that players can see and equip to increase the damage they can do in combat. Some items in the game can not be seen by the players, but they have as much impact on the player as their sword, for example, a memory item is equipped every time a player is under the effects of a spell. Some [[Special Items|special types of item]] also have additional properties that can be accessed via scripts. The following tables detail the various properties of items in SphereServer:<br />
<br />
<br />
==References==<br />
References return pointers to other objects (e.g. the REGION reference allows you to access the REGION that an object is in). These can either be accessed by using ''&lt;REFNAME&gt;'' to return the [[UID]] (1 for object types that don't have UIDs) of the object or 0 if it doesn't exist, or by using ''&lt;REFNAME.KEY&gt;'' where KEY is a valid property/function/reference for the ''REFNAME'' object. Click on the name for more detailed information such as usage and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[CONT]] || RW || Gets or sets the [[Characters|character]] or [[Special Items#Containers|container item]] that the object is inside. When an item's CONT is changed, it bypasses the typical behavior (for example, you can force an item to be "in" a container and bypass @dropon triggers, or force an item to be equipped to a player and bypass @equiptest and @equip triggers -- but be careful, because in this second scenario it may end up in an invalid layer.)<br />
|-<br />
| [[LINK]] || RW || Gets or sets the [[Characters|character]] or [[Items|item]] that the item is linked to. Note, you can make circular LINK's, but a single item cannot be linked to more than one other item.<br />
|-<br />
| [[Regions|REGION]] || R || Gets the [[Regions|region]] that the object is in.<br />
|-<br />
| [[ROOM]] || R || Gets the [[Rooms|room]] that the object is in.<br />
|-<br />
| [[P]] || RW || Gets or sets the [[Map Points|position]] that the object is at.<br />
|-<br />
| [[Sectors|SECTOR]] || R || Gets the [[Sectors|sector]] that the object is in.<br />
|-<br />
| [[TOPOBJ]] || R || Gets the top-most [[Characters|character]] or [[Items|item]] in the world that contains the item.<br />
|-<br />
| [[TYPEDEF (Reference)|TYPEDEF]] || R || Gets the [[ITEMDEF]] that defines the item.<br />
|}<br />
<br />
==Properties and Functions==<br />
Here is a list of all item properties and functions. If a function is marked as readable then it can return a value when used as <KEY>. Click on the name for more detailed information such as usage and examples. If an attempt is made to access a property that does not exist on the item, the property from the [[ITEMDEF]] will be accessed instead.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
! Name !! '''Read/Write''' !! '''Description'''<br />
|-<br />
| [[ADDCIRCLE]] ''spell_circle'' || W || Adds all of the spells in the given Magery circle to the spellbook.<br />
|-<br />
| [[ADDSPELL]] ''spell_id'' || RW || Gets whether or not a spell exists in the spellbook, or adds a spell to the spellbook.<br />
|-<br />
| [[AMMOANIM]] || RW || Overrides TDATA4 for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMHUE]] || RW || Sets the color of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOANIMRENDER]] || RW || Sets the render mode of the effect when firing bow/crossbow type weapons.<br />
|-<br />
| [[AMMOCONT]] || RW || Sets the container UID or ID where to search for ammos for bow/crossbow type weapons.<br />
|-<br />
| [[AMMOSOUNDHIT]] || RW || Overrides the hit sound on weapons.<br />
|-<br />
| [[AMMOSOUNDMISS]] || RW || Overrides the miss sound on weapons.<br />
|-<br />
| [[AMMOTYPE]] || RW || Overrides TDATA3 for bow/crossbow type weapons.<br />
|-<br />
| [[AMOUNT]] || RW || Gets the amount of items this icon represents (e.g. a pile of gold or any stacked item).<br />
|-<br />
| [[ATTR]] || RW || Gets or sets the item's attribute flags.<br />
|-<br />
| [[BOUNCE]] || W || Moves the item to SRC's backpack (triggering the ''you put the item in your pack'' message.<br />
|-<br />
| [[CAN]] || RW || Gets or Sets the can_flags (Setting can be only done in the Itemdef itself). Only readable in X branch.<br />
|-<br />
| [[CANMASK]] || RW || Stores the CAN flags to be dynamically switched on or off from the base CAN property.<br />
|-<br />
| [[CANSEE]] || R || Returns 1 if SRC can see the item.<br />
|-<br />
| [[CANSEELOS]] ''point_or_uid'' || R || Returns 1 if SRC has line of sight to the item or character (uid) or point (location).<br />
|-<br />
| [[CANSEELOSFLAG]] ''flags,point_or_uid'' || R || Returns 1 if SRC has line of sight to the item. The ''flags'' are defined in the los_flags section of the sphere_defs.scp file and can be used to modify what tests take place. The ''point_or_uid'' is an object or position that can be used to test line of sight to something other than SRC. Note, the delimiter for FLAG values is ;<br />
|-<br />
| [[CLEARTAGS]] ''prefix'' || W || Removes all TAGs from the item that start with the given prefix.<br />
|-<br />
| [[COLOR]] || RW || Gets or sets the object's hue.<br />
|-<br />
| [[CONSUME]] ''amount'' || W || Deducts an amount from the item, deleting it at 0.<br />
|-<br />
| [[CONTCONSUME]] ''resource_list'' || W || Deletes items from inside the container.<br />
|-<br />
| [[CONTGRID]] || RW || If in a container, gets or sets the grid number that the item occupies (in KR's grid view)<br />
|-<br />
| [[CONTP]] || RW || Gets or sets the position of the item within its container.<br />
|-<br />
| [[DAMAGE]] ''chance, type, source'' || W || If ''chance'' is greater than (Rand(maxhits*16)), inflicts damage of ''type'' (the damage type flags are defined in the sphere_defs.scp file) upon the item. You can optionally specify the ''source'' of the damage.<br />
|-<br />
| [[DCLICK]] || W || Double clicks the item, with SRC as the source of the event.<br />
|-<br />
| [[DECAY]] ''time'' || W || Sets the decay timer (in tenths of a second) for the item.<br />
|-<br />
| [[DESTROY]] || W || Deletes the object, not stopped by a return 1 in [[@Destroy]]<br />
|-<br />
| [[DIALOG (Function)|DIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC.<br />
|-<br />
| [[DISPID]] || RW || Gets or sets the ID that the item will appear as to players.<br />
|-<br />
| [[DISPIDDEC]] || RW || Same as [[DISPID]], except it returns the ID as a decimal number.<br />
|-<br />
| [[DISTANCE]] ''point_or_uid'' || R || Gets the distance between this object and SRC. If ''point_or_uid'' is used, SRC can be replaced with a map location or another object.<br />
|-<br />
| [[DMGCOLD]] || RW || Gets or sets the amount of cold damage the weapon will give.<br />
|-<br />
| [[DMGENERGY]] || RW || Gets or sets the amount of energy damage the weapon will give.<br />
|-<br />
| [[DMGFIRE]] || RW || Gets or sets the amount of fire damage the weapon will give.<br />
|-<br />
| [[DMGPOISON]] || RW || Gets or sets the amount of poison damage the weapon will give.<br />
|-<br />
| [[DROP]] || W || Drops the item to the ground.<br />
|-<br />
| [[DUPE]] || W || Clones the item.<br />
|-<br />
| [[EDIT]] || W || Displays an editing dialog for the item to SRC.<br />
|-<br />
| [[EFFECT]] ''type, item_id, speed, loop, explode, colour, rendermode'' || W || Displays an effect to nearby clients.<br />
|-<br />
| [[EMOTE]] ''message'' || W || Displays a *You see* message to all nearby clients.<br />
|-<br />
| [[EQUIP]] || W || Equips the item to SRC.<br />
|-<br />
| [[EVENTS (Property)|EVENTS]] ''event_defname'' || RW || Gets a list of events attached to the object, or adds or removes an event to or from the object.<br />
|-<br />
| [[FIX]] || W || Re-aligns the item or character's Z level to ground level (if items are on the ground, the top item's ''Z+HEIGHT'' is used).<br />
|-<br />
| [[FLIP]] || W || Rotates the item clockwise.<br />
|-<br />
| [[FRUIT]] || RW || Gets or sets the fruit that will be produced by the crops.<br />
|-<br />
| [[HEIGHT]] || R || Gets the height of the item.<br />
|-<br />
| [[HITS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[HITPOINTS]] || RW || Gets or sets the number of hitpoints the item has.<br />
|-<br />
| [[ID]] || RW || Gets or sets the ID of the item.<br />
|-<br />
| [[INFO]] || W || Displays an information dialog about the item to SRC.<br />
|-<br />
| [[ISARMOR]] ''object_uid'' || R || Returns 1 if the object is armour.<br />
|-<br />
| [[ISCHAR]] || R || Returns 1 if the object is a character.<br />
|-<br />
| [[ISCONT]] || R || Returns 1 if the object is a container.<br />
|-<br />
| [[ISEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to it.<br />
|-<br />
| [[ISITEM]] || R || Returns 1 if the object is an item.<br />
|-<br />
| [[ISNEARTYPE]] ''type, distance, flags'' || R || Returns 1 if a nearby item has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISNEARTYPETOP]] ''type, distance, flags'' || R || Returns a nearby world location of a nearby item which has the given TYPE and is within ''distance''.<br />
|-<br />
| [[ISPLAYER]] || R || Returns 1 if the object is a player character.<br />
|-<br />
| [[ISTEVENT]]''.event_defname'' || R || Returns 1 if the object has an event attached to its ITEMDEF.<br />
|-<br />
| [[ISTIMERF]]''.function'' || R || Returns the number of seconds left on the specified timerf if it exists.<br />
|-<br />
| [[ISWEAPON]] ''object_uid'' || R || Returns 1 if the object is a weapon.<br />
|-<br />
| [[LAYER]] || RW || Gets or sets the layer that the item occupies when equipped (possible layers are defined in the sphere_defs.scp file).<br />
|-<br />
| [[MAP]] || RW || Gets or sets the map that this object is located.<br />
|-<br />
| [[MAXHITS]] || RW || Gets or sets the maximum number of hitpoints the item can have.<br />
|-<br />
| [[MENU (Function)|MENU]] ''menu_defname'' || W || Displays a menu to SRC.<br />
|-<br />
| [[MESSAGE]] ''message'' || W || Displays a message above this item to SRC.<br />
|-<br />
| [[MESSAGEUA]] ''colour, talkmode, font, lang_id, message'' || W || Displays a UNICODE message above this item to SRC.<br />
|-<br />
| [[MODAR]] || RW || Gets or sets a modifier for the item's armour rating if it is clothing, armor, or a shield. This gets or sets a modifier for the item's damage if it is a weapon type.<br />
|-<br />
| [[MORE1]] || RW || Gets or sets the MORE1 value for the item.<br />
|-<br />
| [[MORE1H]] || RW || Gets or sets the upper 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE1L]] || RW || Gets or sets the lower 4 bytes of the item's MORE1 value.<br />
|-<br />
| [[MORE2]] || RW || Gets or sets the MORE2 value for the item.<br />
|-<br />
| [[MORE2H]] || RW || Gets or sets the upper 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MORE2L]] || RW || Gets or sets the lower 4 bytes of the item's MORE2 value.<br />
|-<br />
| [[MOREM]] || RW || Gets or sets the MOREM value for the item.<br />
|-<br />
| [[MOREX]] || RW || Gets or sets the MOREX value for the item.<br />
|-<br />
| [[MOREY]] || RW || Gets or sets the MOREY value for the item.<br />
|-<br />
| [[MOREZ]] || RW || Gets or sets the MOREZ value for the item.<br />
|-<br />
| [[MOREP]] || RW || Gets or sets the MOREP value for the item.<br />
|-<br />
| [[MOVE]] ''direction amount''<br /> [[MOVE]] ''x y'' || W || Moves the object relative to its current position. Possible ''direction'' values are N,S,W, or E. Note, you can combine directions (like: MOVE SW 1) but nonsensical directions (like: MOVE WE 2) have the nonsense removed.<br />
|-<br />
| [[MOVENEAR]] ''object_uid, distance'' || W || Moves the object to a random location near another object within a certain distance.<br />
|-<br />
| [[MOVETO]] ''location'' || W || Moves the object to a specific location (note, the AREADEF or ROOMDEF must have a P defined).<br />
|-<br />
| [[NAME]] || RW || Gets or sets the object's name.<br />
|-<br />
| [[NUDGEDOWN]] ''amount'' || W || Decreases the object's Z level.<br />
|-<br />
| [[NUDGEUP]] ''amount'' || W || Increases the object's Z level.<br />
|-<br />
| [[PROMPTCONSOLE]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function.<br />
|-<br />
| [[PROMPTCONSOLEU]] ''function, prompt_message'' || W || Displays a prompt message to SRC and passes their response into a specified function, supporting UNICODE response.<br />
|-<br />
| [[REMOVE]] || W || Deletes the object.<br />
|-<br />
| [[REMOVEFROMVIEW]] || W || Removes the object from nearby clients' screens.<br />
|-<br />
| [[RESCOUNT]] ''item_defname'' || R || Returns the total amount of a specific item inside a container.<br />
|-<br />
| [[RESENDTOOLTIP]] || W || Forces Sphere to update the tooltips for nearby clients.<br />
|-<br />
| [[SAY]] ''message'' || W || Makes the object speak a message.<br />
|-<br />
| [[SAYU]] ''message'' || W || Makes the object speak a UTF-8 message<br />
|-<br />
| [[SAYUA]] ''colour, talkmode, font, lang_id, text'' || W || Makes the object speak a UNICODE message.<br />
|-<br />
| [[SDIALOG]] ''dialog_id, page, parameters'' || W || Displays a dialog to SRC, providing that it is not already open.<br />
|-<br />
| [[SERIAL]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[SEXTANTP]] ''location'' || R || Converts the item's location or a specified location into sextant coordinates.<br />
|-<br />
| [[SOUND]] ''sound_id, repeat'' || W || Plays a sound from this object.<br />
|-<br />
| [[SPELLEFFECT]] ''spell_id, strength, source_character_uid, source_item_uid'' || W || Causes the item to be affected by a spell.<br />
|-<br />
| [[TAG]]''.name'' || RW || Gets or sets the value of a TAG.<br />
|-<br />
| [[TAGAT]]''.index'' || R || Gets a TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.KEY || R || Gets the name of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGAT]]''.index''.VAL || R || Gets the value of the TAG at the given zero-based index.<br />
|-<br />
| [[TAGCOUNT]] || R || Gets the number of TAGs stored on the item.<br />
|-<br />
| [[TAGLIST]] || W || Outputs a list of the object's TAGs.<br />
|-<br />
| [[TARGET]]''FGMW'' ''function'' || W || Displays a targeting cursor to SRC. ''F'' makes the ''function'' available, and when added, the function name must be the 1st argument. ''M'' allows you to place a ''multi'' item, in which case the multi number must be passed as an argument. ''G'' forces the target to only be the ground. ''W'' checks the criminal status of the player before (or after?) the target selection is made.<br />
|-<br />
| [[TIMER]] || RW || Gets or sets the length of time before the item's timer expires, in seconds.<br />
|-<br />
| [[TIMERD]] || RW || Gets or sets the length of time before the item's timer expires, in tenths of a second.<br />
|-<br />
| [[TIMERF]] ''time, function'' || W || Schedules a function to be executed on this object in ''time'' seconds.<br />
|-<br />
| [[TIMERF]] ''CLEAR'' || W || Clears all scheduled functions from the object.<br />
|-<br />
| [[TIMERF]] ''STOP, function'' || W || Stops the specified function from the item. (On X version wild character * is available for defining the function name or the argument)<br />
|-<br />
| [[TRIGGER]] ''trig_name, trigger_argtype, argument1, argument2, ...'' || R || Fires a custom trigger (trig_name), allowing you to define the behavior of the arguments (the types are defined under trigger_argtype in the sphere_defs.scp file). The result of the trigger's RETURN value is returned. For example:<br />
LOCAL.result=<TRIGGER @CustomTrigger,<DEF.tat_as_argn>,1,2,3><br />
|-<br />
| [[TYPE]] || RW || Gets or sets the item type. You can use built-in or custom [[TYPEDEF]]s as a value.<br />
|-<br />
| [[UID]] || R || Gets the item's unique ID in the world.<br />
|-<br />
| [[UNEQUIP]] || W || Unequips the item and places it in SRC's backpack.<br />
|-<br />
| [[UPDATE]] || W || Updates the state of the item to nearby clients.<br />
|-<br />
| [[UPDATEX]] || W || Updates the state of the item to nearby clients, removing it from their view first to ensure a full refresh.<br />
|-<br />
| [[USESCUR]] || W || X branch only. Gets or sets the current uses of an item. Only partially supported.<br />
|-<br />
| [[USESMAX]] || W || X branch only. Gets or sets the maximum uses of an item. Only partially supported.<br />
|-<br />
| [[USE]] ''check_los'' || W || Uses the item, as if SRC had double clicked it.<br />
|-<br />
| [[USEITEM]] || W || Double clicks the item, with SRC as the source of the event, without checking for line of sight.<br />
|-<br />
| [[WEIGHT]] || R || Gets the weight of the item.<br />
|-<br />
| [[Z]] || R || Gets the Z position of the item.<br />
|}<br />
<br />
==Triggers==<br />
Here is a list of all item triggers. Click on the trigger name for more detailed information such as arguments and examples.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.<br />
|-<br />
| [[@Buy]] || Fires when the item is being bought from a vendor.<br />
|-<br />
| [[@Click]] || Fires when the object has been single-clicked.<br />
|-<br />
| [[@ClientTooltip]] || Fires when tooltips are about to be sent to a client.<br />
|-<br />
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.<br />
|-<br />
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.<br />
|-<br />
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.<br />
|-<br />
| [[@Damage]] || Fires when the item receives damage.<br />
|-<br />
| [[@DClick]] || Fires when the object is double-clicked.<br />
|-<br />
| [[@Destroy]] || Fires when the object is being deleted.<br />
|-<br />
| [[@DropOn_Char]] || Fires when the item has been dropped on to a character.<br />
|-<br />
| [[@DropOn_Ground]] || Fires when the item has been dropped on to the ground.<br />
|-<br />
| [[@DropOn_Item]] || Fires when the item is dropped on to another item.<br />
|-<br />
| [[@DropOn_Self]] || Fires when an item has been dropped on to this item.<br />
|-<br />
| [[@DropOn_Trade]] || Fires when an item is being dropped on a Trade Window.<br />
|-<br />
| [[@Dye]] || Fires when an item is having its colored changed.<br />
|-<br />
| [[@Equip]] || Fires when the item has been equipped.<br />
|-<br />
| [[@EquipTest]] || Fires when the item is about to be equipped.<br />
|-<br />
| [[@PickUp_Ground]] || Fires when the item ihas been picked up from the ground.<br />
|-<br />
| [[@PickUp_Pack]] || Fires when the item is picked up from inside a container.<br />
|-<br />
| [[@PickUp_Self]] || Fires when an item has been picked up from inside the item.<br />
|-<br />
| [[@PickUp_Stack]] || Fires when the item is picked up from a stack.<br />
|-<br />
| [[@Redeed]] || Fires when multi item is about to redeed (t_multi, t_ship, t_multi_custom, t_addon).<br />
|-<br />
| [[@Sell]] || Fires when the item is sold to a vendor.<br />
|-<br />
| [[@SpellEffect]] || Fires when the object is hit by the effects of a spell.<br />
|-<br />
| [[@Step]] || Fires when a character steps on the item.<br />
|-<br />
| [[@TargOn_Cancel]] || Fires when a target is cancelled from the item.<br />
|-<br />
| [[@TargOn_Char]] || Fires when a character is targeted from the item.<br />
|-<br />
| [[@TargOn_Ground]] || Fires when the ground is targeted from the item.<br />
|-<br />
| [[@TargOn_Item]] || Fires when an item is targeted from this item.<br />
|-<br />
| [[@Timer]] || Fires when the item's timer expires.<br />
|-<br />
| [[@ToolTip]] || Fires when old-style tooltips are requested for the item.<br />
|-<br />
| [[@UnEquip]] || Fires when the item is unequipped.<br />
|}<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Objects]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=SPELL&diff=7935SPELL2022-05-01T19:14:24Z<p>Gorgo: </p>
<hr />
<div>{{Languages|SPELL}}<br />
<br />
__FORCETOC__<br />
A spell block defines the basic properties and behaviours of a spell.<br />
<br />
<br />
==Properties==<br />
The following properties are available when defining a spell:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Read/Write''' || '''Description'''<br />
|-<br />
| [[CAST_TIME]] || RW || Gets or sets the length of time it takes to cast the spell, in tenths of a second. Accepts multiple values to adjust based on skill level.<br />
|-<br />
| [[DEFNAME]] || RW || Gets or sets the spell's defname.<br />
|-<br />
| [[DURATION]] || RW || Gets or sets the duration of the spell's affect in tenths of a second, if applicable. Accepts multiple values to adjust based on skill level.<br />
|-<br />
| [[EFFECT]] || RW || Gets or sets the strength of the spell. Accepts multiple values to adjust based on skill level.<br />
|-<br />
| [[EFFECT_ID]] || RW || Gets or sets the ID of the spell's visual effect.<br />
|-<br />
| [[FLAGS]] || RW || Gets or sets the spell's attribute flags.<br />
|-<br />
| [[GROUP]] || RW || Gets or sets the spell's group flags.<br />
|-<br />
| [[INTERRUPT]] || RW || Gets or sets the chance of a character being interrupted when hit in combat while casting the spell. Accepts multiple values to adjust based on skill level.<br />
|-<br />
| [[MANAUSE]] || Rw || Gets or sets the number of mana points needed to cast the spell.<br />
|-<br />
| [[NAME]] || RW || Gets or sets the name of the spell.<br />
|-<br />
| [[PROMPT_MSG]] || RW || Gets or sets the message shown when a character casts the spell, and also forces characters to select a target when non-empty.<br />
|-<br />
| [[RESOURCES]] || RW || Gets or sets the resources that are needed to cast the spell.<br />
|-<br />
| [[RESOURCES]]''.n.KEY'' || R || Gets the [[BASEID]] of the nth resource needed to cast the spell. (zero-based)<br />
|-<br />
| [[RESOURCES]]''.n.VAL'' || R || Gets the amount of the nth resource needed to cast the spell. (zero-based)<br />
|-<br />
| [[RUNE_ITEM]] || RW || Gets or sets the [[BASEID]] of the item that should be equipped when a spell has a duration.<br />
|-<br />
| [[RUNES]] || RW || Gets or sets the spell's words of power.<br />
|-<br />
| [[SCROLL_ITEM]] || RW || Gets or sets the [[BASEID]] of the scroll that casts the spell.<br />
|-<br />
| [[SKILLREQ]] || RW || Gets or sets a list of skills that are needed to cast the spell.<br />
|-<br />
| [[SOUND]] || RW || Gets or sets the ID of the sound that will be played when the spell is cast.<br />
|}<br />
<br />
<br />
<br />
==Triggers==<br />
The following table lists all of the triggers that can be placed under a spell definition. All of the triggers here have an equivalent @Spell trigger on the [[Characters|character]] object.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@Effect]] || Fires when a character or item is hit by the spell.<br />
|-<br />
| [[@EffectAdd]] || Fires when a spell memory item is being added.<br />
|-<br />
| [[@EffectRemove]] || Fires when a spell memory item is removed.<br />
|-<br />
| [[@Fail (Spell Trigger)|@Fail]] || Fires when a character fails to cast the spell.<br />
|-<br />
| [[@Select (Spell Trigger)|@Select]] || Fires when a character selects to cast the spell, or when Sphere checks if a character is capable of casting it.<br />
|-<br />
| [[@Start (Spell Trigger)|@Start]] || Fires when a character starts to cast the spell.<br />
|-<br />
| [[@Success (Spell Trigger)|@Success]] || Fires when a character successfully casts the spell.<br />
|-<br />
| [[@TargetCancel]] || Fires when a character cancels target selection for a spell they are casting.<br />
|}<br />
<br />
==Examples==<br />
<br />
<spherescript><br />
//<br />
// Clumsy spell from the default script pack.<br />
//<br />
[SPELL 1]<br />
DEFNAME=s_clumsy<br />
NAME=Clumsy<br />
SOUND=snd_SPELL_CLUMSY<br />
RUNES=UJ<br />
CAST_TIME=1.0<br />
RESOURCES=i_reag_blood_moss,i_reag_nightshade<br />
RUNE_ITEM=i_rune_CLUMSY<br />
SCROLL_ITEM=i_scroll_CLUMSY<br />
FLAGS=SPELLFLAG_TARG_CHAR | SPELLFLAG_DIR_ANIM | SPELLFLAG_HARM | SPELLFLAG_FX_TARG | SPELLFLAG_RESIST<br />
EFFECT_ID=i_fx_curse<br />
EFFECT=3,15<br />
DURATION=2*60.0,3*60.0<br />
MANAUSE=4<br />
SKILLREQ=MAGERY 10.0<br />
INTERRUPT=100.0,100.0<br />
</spherescript><br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Definitions]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@EffectRemove&diff=7934@EffectRemove2022-05-01T19:13:17Z<p>Gorgo: Created page with "==Description== This trigger fires when a spell memory item is removed (and after the @Destroy trigger of the item). Fires on: * Spells ==References== The follow..."</p>
<hr />
<div>==Description==<br />
This trigger fires when a spell memory item is removed (and after the @Destroy trigger of the item).<br />
<br />
<br />
Fires on:<br />
* [[SPELL|Spells]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[ARGO]] || The memory item.<br />
|-<br />
| [[I]] || The [[Characters|character]] affected by the effect.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] responsible for the spell.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARGN1 || I || The spell ID<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 0 || prevents default spell behaviour be executed when the spell item get removed. This is necessary when return 0 is used in @EffectAdd of the same spell.<br />
For Summoning spells, returning 0 in @EffectRemove will prevent the summon to disappear. <br />
|}<br />
<br />
<br />
'''Note:''' Poisoning spells are not affected by this trigger<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=@EffectAdd&diff=7933@EffectAdd2022-05-01T19:05:05Z<p>Gorgo: Created page with "==Description== This trigger fires when any type of effect memory is being added, like stat changes for s_bless, s_cunning... s_weaken ... Fires on: * Spells ==R..."</p>
<hr />
<div>==Description==<br />
This trigger fires when any type of effect memory is being added, like stat changes for s_bless, s_cunning... s_weaken ...<br />
<br />
<br />
Fires on:<br />
* [[SPELL|Spells]]<br />
<br />
<br />
==References==<br />
The following object references are explicitly available for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[ARGO]] || The memory item.<br />
|-<br />
| [[I]] || The [[Characters|character]] affected by the effect.<br />
|-<br />
| [[SRC]] || The [[Characters|character]] responsible for the spell.<br />
|}<br />
<br />
<br />
==Arguments==<br />
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Argument''' || '''In/Out''' || '''Description'''<br />
|-<br />
| ARGN1 || I || The spell ID<br />
|}<br />
<br />
==Return Values==<br />
The following return values are explicitly defined for this trigger:<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Return Value''' || '''Description'''<br />
|-<br />
| 0 || Let the memory exist but block default checks, perfect to override default effects and do some custom stuff.<br />
|-<br />
| 1 || Blocks any action and stops everything, also deletes the memory (Blocking any changes, this will cause also the effect to do not have duration).<br />
|}<br />
<br />
<br />
'''Note:''' Poisoning spells are not affected by this trigger<br />
<br />
<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]</div>Gorgohttps://wiki.spherecommunity.net/index.php?title=Category:Spells&diff=7932Category:Spells2022-05-01T18:51:39Z<p>Gorgo: </p>
<hr />
<div>{{DISPLAYTITLE:Spell Triggers}}<br />
==Spells==<br />
The following table lists all of the triggers that can be placed under a spell definition. All of the triggers here have an equivalent @Spell trigger on the [[Characters|character]] object.<br />
<br />
{| border="1" cellspacing="4" cellpadding="4"<br />
| '''Name''' || '''Description'''<br />
|-<br />
| [[@Effect]] || Fires when a character or item is hit by the spell.<br />
|-<br />
| [[@EffectAdd]] || Fires when a spell memory item is being added.<br />
|-<br />
| [[@EffectRemove]] || Fires when a spell memory item is removed.<br />
|-<br />
| [[@Fail (Spell Trigger)|@Fail]] || Fires when a character fails to cast the spell.<br />
|-<br />
| [[@Select (Spell Trigger)|@Select]] || Fires when a character selects to cast the spell, or when Sphere checks if a character is capable of casting it.<br />
|-<br />
| [[@Start (Spell Trigger)|@Start]] || Fires when a character starts to cast the spell.<br />
|-<br />
| [[@Success (Spell Trigger)|@Success]] || Fires when a character successfully casts the spell.<br />
|}<br />
[[Category: Reference Compendium]]<br />
[[Category: Triggers]]</div>Gorgo