SphereWiki - User contributions [en]

TARGETF

2018-05-08T16:45:17Z

XuN:

Targetf is a command you can use to directly target a character or item and using a function on it without manually creating an memory item or such. Using the targetf itself works like calling an ordinary function and you can put arguments after the function normally.

ex. targetf f_hello or targetf f_hello 1,2

In targetf:

SRC= player using the function

ARGO= target's UID

local.id stores the ID of the targeted object
[[Category:Reference Compendium]]
[[Category: Properties and Functions]]

@Kill

2018-04-07T21:55:08Z

XuN: Undo revision 7865 by XuN (talk)

==Description==
This trigger fires on all characters who are responsible for another character's death.

The trigger is fired based on the Attacker list, @Death is called before it and @DeathCorpse after, so the @Death trigger can pre-handle who will receive this trigger by adding or removing attackers.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Characters|character]] who has been killed.
|-
| [[I]] || The [[Characters|character]] doing the killing.
|-
| [[SRC]] || The [[Characters|character]] doing the killing.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The total number of characters involved in the character's death.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the killer from receiving credit for the kill.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@Kill

2018-04-07T21:04:50Z

XuN: /* References */

==Description==
This trigger fires on all characters who are responsible for another character's death.

The trigger is fired based on the Attacker list, @Death is called before it and @DeathCorpse after, so the @Death trigger can pre-handle who will receive this trigger by adding or removing attackers.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] doing the killing.
|-
| [[SRC]] || The [[Characters|character]] that has been killed.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The total number of characters involved in the character's death.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the killer from receiving credit for the kill.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CombatAdd

2016-04-20T20:59:55Z

XuN: /* Arguments */

==Description==
This trigger fires when someone is being added to my attacker list.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || Myself, someone is being entering in combat with me (or I am entering in combat with
|-
| [[SRC]] || The character entering in my list.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| ARGN1 || Threat set to this SRC, if enabled on ini and I'm not a player.
|-
| ARGN2 || Sets wether to add SRC as ignored or not.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents src of being added to my list, however I will try to add him each time I can.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CallGuards

2016-04-15T07:55:37Z

XuN: /* Arguments */

==Description==
This trigger fires when a character calls for the guards to attack a criminal.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The guard [[Characters|character]] who is going to attack the criminal (if one exists in the area).
|-
| [[I]] || The [[Characters|character]] calling for guards.
|-
| [[REF1]] || The [[Characters|criminal]] who the guards are being called upon.
|-
| [[SRC]] || The [[Characters|criminal]] who the guards are being called upon.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The [[BASEID]] of the [[Characters|character]] to spawn as a guard.
|-
| ARGN2 || O || If set to 1, a new guard will be spawned regardless of whether a nearby guard is available.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the guards from reacting. (When firing on a player, will prevent the guards attacking the next possible targets)
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@Buy

2016-02-28T16:31:08Z

XuN: /* Arguments */

==Description==
This trigger fires when an item is bought from a vendor. The trigger fires on each item that is bought in the transaction.

Fires on:
* [[Items]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Characters#NPCs|vendor]] the item is being bought from.
|-
| [[I]] || The [[Items|item]] being bought.
|-
| [[SRC]] || The [[Characters|character]] buying the item.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The amount of the item being bought.
|-
| ARGN2 || I || The final cost of the item (amount * value).
|-
| LOCAL.TOTALCOST || I || The total cost for the whole transaction ( the sum of the final prizes of all items ).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from buying the item (blocks the entire transaction).
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

@NPCActFight

2015-11-02T08:30:17Z

XuN: /* Arguments */

==Description==
This trigger fires periodically whilst an NPC is fighting.

Fires on:
* [[Characters#NPCs|NPCs]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#NPCs|NPC]] who is fighting.
|-
| [[SRC]] || The [[Characters|character]] the NPC is fighting with.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The distance between the NPC and its target.
|-
| ARGN2 || IO || The NPC's motivation level to fight. '''Note:''' NPCs, excluding pets, with a motivation less than zero will flee from their target.
|-
| local.Skill || O || Force the NPC to stop current checks and start this skill.
|-
| local.Spell || O || Force to cast an specific spell in case LOCAL.SKILL is set to a SKF_MAGIC skill.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 0 || Allows the NPC to fight, but skips making a decision to use a special action such as fire breathing or rock throwing.
|-
| 1 || Stops the NPC from taking any action.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: NPCS]]

@SeeHidden

2015-08-24T11:57:47Z

XuN: /* Arguments */

==Description==
This trigger fires when character is going to see a hidden character so it can control wether to see it or not.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] viewing.
|-
| [[SRC]] || The [[Characters|character]] hidden.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || 0 will remain invisible for the viewer/ 1 the viewer will see this character grayed (like an Admin sees an invisible GM).
|}

==Notes==
This trigger is being fired a lot, keep it clean.

==Return Values==
The following return values are explicitly defined for this trigger:

''This trigger doesn't have return values, characters must be send always.''

[[Category: Reference Compendium]]
[[Category: Triggers]]

@SeeHidden

2015-08-24T11:57:13Z

XuN: /* Description */

==Description==
This trigger fires when character is going to see a hidden character so it can control wether to see it or not.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] viewing.
|-
| [[SRC]] || The [[Characters|character]] hidden.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || 0 will remain invisible for the viewer/ 1 the viewer will see this character grayed.
|}

==Notes==
This trigger is being fired a lot, keep it clean.

==Return Values==
The following return values are explicitly defined for this trigger:

''This trigger doesn't have return values, characters must be send always.''

[[Category: Reference Compendium]]
[[Category: Triggers]]

@GetHit

2015-07-30T16:15:43Z

XuN: /* Arguments */

{{Languages|@GetHit}}

==Description==
This trigger fires when a character receives damage.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] being damaged.
|-
| [[SRC]] || The [[Characters|character]] responsible for the damage.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being applied.
|-
| ARGN2 || IO || The type of damage being applied.
|-
| ARGN3 || IO || Hits will be fixed to this amount after the hit if the value is greater than it, default = maxhits.
|-
| LOCAL.ITEMDAMAGECHANCE || IO || Sets the chance for the hitted part of the body (Armor or shield, if any) to be damaged (Default: 40).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents damage from being applied.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@PersonalSpace

2015-07-30T16:13:58Z

XuN: /* Arguments */

==Description==
This trigger fires when a character is stepped on by another character.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] being stepped on.
|-
| [[SRC]] || The [[Characters|character]] doing the stepping.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of stamina needed to step on to the character.
|-
| ARGN2 || O || Setting it to 1 allow NPCs to pass over another NPCs, 0 reject the movement.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from being stepped on.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]

Armor Calculation

2015-07-23T10:47:14Z

XuN: /* Body parts and Percents */

{{Languages|Armor_Calculation}}

Have you ever wondered why your handmade set of platemail where each part has an AR value of "40" only gives you an overall armor rating of "36"? Well, here is the answer.

Sphere follows OSI's armor rating system. That means, that each armor part will show you an AR value what it will give you if you wear a complete set of armor where each part has this AR value. Depending on what body parts a selected armor part is covering it adds a procentual share to the overall armor.

Furthermore, armor pieces theoretically can be stacked. So a platemail chest covers chest and back, and a cloak covers the chest. But that does not mean that your back now is double protected: Like on OSI, Sphere only uses the covering part with the highest AR property. Therefore, if you wear a chain tunic under your plate, id adds to weight, but not to your character's AR.

===Body parts and Percents===

<tt>15 percent from    ARMOR_HEAD 
7 percent from    ARMOR_NECK 
5 percent from    ARMOR_BACK 
25 percent from    ARMOR_CHEST 
14 percent from    ARMOR_ARMS 
7 percent from    ARMOR_HANDS 
22 percent from    ARMOR_LEGS 
5 percent from    ARMOR_FEET </tt>

===What layer covers what?===

<tt>LAYER_HELM                                                         gives ARMOR_HEAD 
LAYER_COLLAR                                                       gives ARMOR_NECK 
LAYER_SHIRT, LAYER_CHEST, LAYER_TUNIC, LAYER_CAPE, LAYER_ROBE      gives ARMOR_BACK 
LAYER_SHIRT, LAYER_CHEST, LAYER_TUNIC, LAYER_ROBE                  gives ARMOR_CHEST 
LAYER_ARMS, LAYER_CAPE, LAYER_ROBE                                 gives ARMOR_ARMS 
LAYER_GLOVES                                                       gives ARMOR_HANDS 
LAYER_PANTS, LAYER_SKIRT, LAYER_HALF_APRON, LAYER_ROBE, LAYER_LEGS gives ARMOR_LEGS 
LAYER_SHOES, LAYER_LEGS                                            gives ARMOR_FEET </tt>

===Or, if you're preferring it the other way around: ===

<tt>A helmet, hat ect. will only cover the head, thus adding 10 percent to the total AR. 
A gorget, but also a necklace will cover the neck, adding 5 percent to total AR. 
A shirt (LAYER_SHIRT) can cover the back and the chest, adding up to 40 percent of total AR. 
Items on LAYER_CHEST and LAYER_TUNIC behave like LAYER_SHIRT. 
A cape may cover the back and the arms, adding up to 20 percent to total AR. 
A robe may cover back, chest, arms and legs, adding up to 70 percent to total AR. 
Armwear (LAYER_ARMS) only covers the arms, thus adding 10 percent to total AR. 
Gloves and gauntlets are covering the hands, adding 10 percent. 
LAYER_PANTS, LAYER_SKIRT, LAYER_HALF_APRON are covering the legs (20 percent of total AR). 
LAYER_LEGS (like plate legs) and LAYER_SHOES are covering the feet (5 percent of total AR) </tt>

Do not forget that multiple coverings will _not_ stack; only the item with the highest AR property will be taken into account!

If you prefer it all in a combined table:

{| border="1"
|
| '''Hit Zones'''
|-
|
| head
| throat
| chest
| back
| arms
| hands
| legs
| feet
|-
| '''layer'''
| 10%
| 5%
| 30%
| 10%
| 10%
| 10%
| 20%
| 5%
| total
|-
| helm
| X
| -
| -
| -
| -
| -
| -
| -
| 10%
|-
| collar
| -
| X
| -
| -
| -
| -
| -
| -
| 5%
|-
| shirt
| -
| -
| X
| X
| -
| -
| -
| -
| 40%
|-
| chest
| -
| -
| X
| X
| -
| -
| -
| -
| 40%
|-
| tunic
| -
| -
| X
| X
| -
| -
| -
| -
| 40%
|-
| cape
| -
| -
| -
| X
| X
| -
| -
| -
| 20%
|-
| robe
| -
| -
| X
| X
| X
| -
| X
| -
| 70%
|-
| arms
| -
| -
| -
| -
| X
| -
| -
| -
| 10%
|-
| gloves
| -
| -
| -
| -
| -
| X
| -
| -
| 10%
|-
| pants
| -
| -
| -
| -
| -
| -
| X
| -
| 20%
|-
| skirt
| -
| -
| -
| -
| -
| -
| X
| -
| 20%
|-
| half apron
| -
| -
| -
| -
| -
| -
| X
| -
| 20%
|-
| legs
| -
| -
| -
| -
| -
| -
| X
| X
| 25%
|-
| shoes
| -
| -
| -
| -
| -
| -
| -
| X
| 5%
|}

[[Category: Articles]]

Armor Calculation

2015-07-23T10:46:38Z

XuN: /* Body parts and Percents */

{{Languages|Armor_Calculation}}

Have you ever wondered why your handmade set of platemail where each part has an AR value of "40" only gives you an overall armor rating of "36"? Well, here is the answer.

Sphere follows OSI's armor rating system. That means, that each armor part will show you an AR value what it will give you if you wear a complete set of armor where each part has this AR value. Depending on what body parts a selected armor part is covering it adds a procentual share to the overall armor.

Furthermore, armor pieces theoretically can be stacked. So a platemail chest covers chest and back, and a cloak covers the chest. But that does not mean that your back now is double protected: Like on OSI, Sphere only uses the covering part with the highest AR property. Therefore, if you wear a chain tunic under your plate, id adds to weight, but not to your character's AR.

===Body parts and Percents===

<tt>15 percent from    ARMOR_HEAD 
 7 percent from    ARMOR_NECK 
5 percent from    ARMOR_BACK 
25 percent from    ARMOR_CHEST 
14 percent from    ARMOR_ARMS 
7 percent from    ARMOR_HANDS 
22 percent from    ARMOR_LEGS 
 5 percent from    ARMOR_FEET </tt>

===What layer covers what?===

<tt>LAYER_HELM                                                         gives ARMOR_HEAD 
LAYER_COLLAR                                                       gives ARMOR_NECK 
LAYER_SHIRT, LAYER_CHEST, LAYER_TUNIC, LAYER_CAPE, LAYER_ROBE      gives ARMOR_BACK 
LAYER_SHIRT, LAYER_CHEST, LAYER_TUNIC, LAYER_ROBE                  gives ARMOR_CHEST 
LAYER_ARMS, LAYER_CAPE, LAYER_ROBE                                 gives ARMOR_ARMS 
LAYER_GLOVES                                                       gives ARMOR_HANDS 
LAYER_PANTS, LAYER_SKIRT, LAYER_HALF_APRON, LAYER_ROBE, LAYER_LEGS gives ARMOR_LEGS 
LAYER_SHOES, LAYER_LEGS                                            gives ARMOR_FEET </tt>

===Or, if you're preferring it the other way around: ===

<tt>A helmet, hat ect. will only cover the head, thus adding 10 percent to the total AR. 
A gorget, but also a necklace will cover the neck, adding 5 percent to total AR. 
A shirt (LAYER_SHIRT) can cover the back and the chest, adding up to 40 percent of total AR. 
Items on LAYER_CHEST and LAYER_TUNIC behave like LAYER_SHIRT. 
A cape may cover the back and the arms, adding up to 20 percent to total AR. 
A robe may cover back, chest, arms and legs, adding up to 70 percent to total AR. 
Armwear (LAYER_ARMS) only covers the arms, thus adding 10 percent to total AR. 
Gloves and gauntlets are covering the hands, adding 10 percent. 
LAYER_PANTS, LAYER_SKIRT, LAYER_HALF_APRON are covering the legs (20 percent of total AR). 
LAYER_LEGS (like plate legs) and LAYER_SHOES are covering the feet (5 percent of total AR) </tt>

Do not forget that multiple coverings will _not_ stack; only the item with the highest AR property will be taken into account!

If you prefer it all in a combined table:

{| border="1"
|
| '''Hit Zones'''
|-
|
| head
| throat
| chest
| back
| arms
| hands
| legs
| feet
|-
| '''layer'''
| 10%
| 5%
| 30%
| 10%
| 10%
| 10%
| 20%
| 5%
| total
|-
| helm
| X
| -
| -
| -
| -
| -
| -
| -
| 10%
|-
| collar
| -
| X
| -
| -
| -
| -
| -
| -
| 5%
|-
| shirt
| -
| -
| X
| X
| -
| -
| -
| -
| 40%
|-
| chest
| -
| -
| X
| X
| -
| -
| -
| -
| 40%
|-
| tunic
| -
| -
| X
| X
| -
| -
| -
| -
| 40%
|-
| cape
| -
| -
| -
| X
| X
| -
| -
| -
| 20%
|-
| robe
| -
| -
| X
| X
| X
| -
| X
| -
| 70%
|-
| arms
| -
| -
| -
| -
| X
| -
| -
| -
| 10%
|-
| gloves
| -
| -
| -
| -
| -
| X
| -
| -
| 10%
|-
| pants
| -
| -
| -
| -
| -
| -
| X
| -
| 20%
|-
| skirt
| -
| -
| -
| -
| -
| -
| X
| -
| 20%
|-
| half apron
| -
| -
| -
| -
| -
| -
| X
| -
| 20%
|-
| legs
| -
| -
| -
| -
| -
| -
| X
| X
| 25%
|-
| shoes
| -
| -
| -
| -
| -
| -
| -
| X
| 5%
|}

[[Category: Articles]]

Testchangelog

2015-05-15T14:54:21Z

XuN: Blanked the page

Testchangelog

2015-05-15T14:52:41Z

XuN: Created page with "{{#widget:Iframe |url=http://docs.google.com/present/embed?id=dcn37mcz_22cmnwnwf8 |width=410 |height=342 |border=0 }}"

{{#widget:Iframe
|url=http://docs.google.com/present/embed?id=dcn37mcz_22cmnwnwf8
|width=410
|height=342
|border=0
}}

@CombatAdd

2015-05-09T07:04:37Z

XuN:

==Description==
This trigger fires when someone is being added to my attacker list.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || Myself, someone is being entering in combat with me (or I am entering in combat with
|-
| [[SRC]] || The character entering in my list.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| ARGN1 || Threat set to this character, if enabled on ini and SRC is not a player.
|-
| ARGN2 || Sets wether to add SRC as ignored or not.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents src of being added to my list, however I will try to add him each time I can.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CombatEnd

2015-05-07T14:12:59Z

XuN:

==Description==
This trigger fires when I don't have any more viable targets.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || Myself.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values allowed for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CombatStart

2015-05-07T14:12:48Z

XuN:

==Description==
This trigger fires when i'm in peace and i'm to begin a combat.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || Myself.
|-
| [[SRC]] || The character forcing me to start a combat.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the 'engage' however I will try again soon.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CombatDelete

2015-05-07T14:12:38Z

XuN:

==Description==
This trigger fires when someone is being deleted from my attacker list.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || Myself.
|-
| [[SRC]] || The character being removed from my list.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || Shows if the deletion was forced by your scripts (1) or called by Sphere (0)
|-
| ARGN2 || I ||
{| cellpadding="4"
| '''Type description''' || '''Values'''
|-
| Forced (Blocked attack, default uncategorized actions...) || 0
|-
| Max fight time has reached (Elapsed) || 1
|-
| Distance/LOS || 2
|-
| The character is no longer existing || 3
|-
| Forced via attacker.delete methods (ingame/script) || 4
|}
|-
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents src of leaving my list, however I'll try to delete him as soon as possible.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CombatAdd

2015-05-07T14:12:19Z

XuN:

==Description==
This trigger fires when someone is being added to my attacker list.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || Myself, someone is being entering in combat with me (or I am entering in combat with
|-
| [[SRC]] || The character entering in my list.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents src of being added to my list, however I will try to add him each time I can.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

Category:Characters

2015-05-07T13:24:33Z

XuN: /* Characters */

==Characters==
Here is a list of all [[Characters|character]] triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@CallGuards]] || Fires when the character calls for guards.
|-
| [[@CharClick]] || Fires when the character is clicked by another character.
|-
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.
|-
| [[@CharDClick]] || Fires when the character double clicks another character.
|-
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Criminal]] || Fires when the character becomes a criminal.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@Dismount]] || Fires when the character dismounts their ride.
|-
| [[@EnvironChange]] || Fires when the environment changes for the character.
|-
| [[@ExpChange]] || Fires when the character's experience points change.
|-
| [[@ExpLevelChange]] || Fires when the character's experience level changes.
|-
| [[@FameChange]] || Fires when the character's fame changes.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@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.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|}
[[Category: Reference Compendium]]
[[Category: Triggers]]

@MurderMark

2015-05-07T13:21:13Z

XuN:

==Description==
This trigger fires when a character's murder count ([[KILLS]] property) is about to increase.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] whose murder count is changing.
|-
| [[SRC]] || The [[Characters|character]] whose murder count is changing.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The new murder count that will be set.
|-
| ARGN2 || IO || If non-zero, the character will be flagged as a criminal.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@MurderDecay

2015-05-07T13:21:07Z

XuN:

==Description==
This trigger fires when a character's murder count ([[KILLS]] property) is about to decrease.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] whose murder count is changing.
|-
| [[SRC]] || The [[Characters|character]] whose murder count is changing.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The new murder count that will be set.
|-
| ARGN2 || IO || The length of time until the murder count will next decay, in tenths of a second.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled by this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@Kill

2015-05-07T13:20:59Z

XuN:

@Hunger

2015-05-07T13:20:20Z

XuN: Replaced content with "==Description== This trigger was removed and merged in @RegenStat"

==Description==
This trigger was removed and merged in [[@RegenStat]]

@HitMiss

2015-05-07T13:19:39Z

XuN:

==Description==
This trigger fires when a character is about to miss a combat swing.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|weapon]] being used (can be nothing, if fists are used).
|-
| [[I]] || The [[Characters|character]] doing the hitting.
|-
| [[SRC]] || The [[Characters|character]] who was missed.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| LOCAL.ARROWHANDLED || IO || if set to !=0, you can do whatever you want with local.arrow
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Cancels the attack swing.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@Hit

2015-05-07T13:19:31Z

XuN:

{{Languages|@Hit}}

==Description==
This trigger fires when a character hits someone using a combat skill.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Items|weapon]] being used (can be nothing, if fists are used).
|-
| [[I]] || The [[Characters|character]] doing the hitting.
|-
| [[SRC]] || The [[Characters|character]] being hit.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being dealt.
|-
| ARGN2 || IO || The type(s) of damage.
|-
| LOCAL.ARROW || I || UID of the arrow used (Archery only)
|-
| LOCAL.ARROWHANDLED || IO || if set to !=0, you can do whatever you want with local.arrow
|-
| LOCAL.ITEMDAMAGECHANCE || IO || Sets the chance for the weapon to be damaged (Default: 40).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Cancels the combat swing.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@GetHit

2015-05-07T13:19:23Z

XuN:

{{Languages|@GetHit}}

==Description==
This trigger fires when a character receives damage.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] being damaged.
|-
| [[SRC]] || The [[Characters|character]] responsible for the damage.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The amount of damage being applied.
|-
| ARGN2 || IO || The type of damage being applied.
|-
| LOCAL.ITEMDAMAGECHANCE || IO || Sets the chance for the hitted part of the body (Armor or shield, if any) to be damaged (Default: 40).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents damage from being applied.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@DeathCorpse

2015-05-07T13:18:57Z

XuN:

==Description==
This trigger fires when a character dies and a corpse has been created.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The character's corpse.
|-
| [[I]] || The [[Characters|character]] who died.
|-
| [[SRC]] || The [[Characters|character]] who died.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@Death

2015-05-07T13:18:51Z

XuN:

==Description==
This trigger fires when a character's health reaches zero and they are about to die.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] about to die.
|-
| [[SRC]] || The [[Characters|character]] about to die.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the death from taking place. '''Note:''' The trigger will fire again unless the script changes the character's health to above zero.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CharAttack

2015-05-07T13:18:29Z

XuN:

==Description==
This trigger fires when one character initiates an attack on another.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ACT]] || The [[Characters|character]] initiating the attack.
|-
| [[I]] || The [[Characters|character]] being attacked.
|-
| [[SRC]] || The [[Characters|character]] initiating the attack.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from attacking.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

@CallGuards

2015-05-07T13:18:23Z

XuN:

==Description==
This trigger fires when a character calls for the guards to attack a criminal.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The guard [[Characters|character]] who is going to attack the criminal (if one exists in the area).
|-
| [[I]] || The [[Characters|character]] calling for guards.
|-
| [[REF1]] || The [[Characters|criminal]] who the guards are being called upon.
|-
| [[SRC]] || The [[Characters|criminal]] who the guards are being called upon.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || IO || The [[BASEID]] of the [[Characters|character]] to spawn as a guard.
|-
| ARGN2 || O || If set to 1, a new guard will be spawned regardless of whether a nearby guard is available.
|-
| ARGN3 || O || (Only used if the trigger is called by a player) If set to 1, SRC will be attacked by the guard(s).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the guards from reacting. (When firing on a player, will prevent the guards attacking the next possible targets)
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

Category:Combat

2015-05-07T13:02:51Z

XuN:

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]

@Attack

2015-05-07T13:01:49Z

XuN:

==Description==
This trigger fires when one character initiates an attack on another.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] initiating the attack.
|-
| [[SRC]] || The [[Characters|character]] being attacked.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGN1]] || Threat being assigned to the target after starting the fight (Only for NPCs).
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character from attacking.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Combat]]

Category:Combat

2015-05-07T13:01:10Z

XuN: Created page with "Category: Reference Compendium Category: Triggers"

[[Category: Reference Compendium]]
[[Category: Triggers]]

@ClientTooltip

2015-05-07T11:51:36Z

XuN:

==Description==
This trigger fires when tooltips are about to be sent to a client. the [[ADDCLILOC]] function can be called on the [[SRC]] object to send custom tooltips to the client.

Fires on:
* [[Characters]]
* [[Items]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] or [[Items|item]] whose tooltips are to be sent.
|-
| [[SRC]] || The [[Characters#Clients|client]] who is receiving tooltips.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents Sphere from sending its own tooltips.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Items]]

Category:Characters

2015-05-07T09:49:44Z

XuN: /* Characters */

==Characters==
Here is a list of all [[Characters|character]] triggers. Click on the trigger name for more detailed information such as arguments and examples.

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[@AfterClick]] || Fires when the object has been single-clicked, just before the overhead name is shown.
|-
| [[@Attack]] || Fires when the character begins attacking another.
|-
| [[@CallGuards]] || Fires when the character calls for guards.
|-
| [[@CharAttack]] || Fires when the character is attacked by another character.
|-
| [[@CharClick]] || Fires when the character is clicked by another character.
|-
| [[@CharClientTooltip]] || Fires when the tooltips are about to be sent to the character.
|-
| [[@CharDClick]] || Fires when the character double clicks another character.
|-
| [[@CharTradeAccepted]] || Fires when another character accepts trade with the character.
|-
| [[@Click]] || Fires when the object has been single-clicked.
|-
| [[@ClientTooltip]] || Fires when tooltips for this character are about to be sent to a client.
|-
| [[@ContextMenuRequest]] || Fires when a client requests the context menu options for the object.
|-
| [[@ContextMenuSelect]] || Fires when a client selects a context menu option for the object.
|-
| [[@Create]] || Fires when the object is initially created, before it is placed in the world.
|-
| [[@Criminal]] || Fires when the character becomes a criminal.
|-
| [[@DClick]] || Fires when the object is double-clicked.
|-
| [[@Death]] || Fires when the character's hitpoints reaches zero.
|-
| [[@DeathCorpse]] || Fires when a corpse is created for the character.
|-
| [[@Destroy]] || Fires when the object is being deleted.
|-
| [[@Dismount]] || Fires when the character dismounts their ride.
|-
| [[@EnvironChange]] || Fires when the environment changes for the character.
|-
| [[@ExpChange]] || Fires when the character's experience points change.
|-
| [[@ExpLevelChange]] || Fires when the character's experience level changes.
|-
| [[@FameChange]] || Fires when the character's fame changes.
|-
| [[@GetHit]] || Fires when the character receives damage.
|-
| [[@Hit]] || Fires when the character hits another in combat.
|-
| [[@HitMiss]] || Fires when the character fails to hit another in combat.
|-
| [[@HouseDesignCommit]] || Fires when the character commits a new house design.
|-
| [[@HouseDesignExit]] || Fires when the character exits house design mode.
|-
| [[@Hunger]] || Fires when the character's food level decreases.
|-
| [[@ItemAfterClick]] || Fires when the character single-clicks an item, just before the overhead name is shown.
|-
| [[@ItemBuy]] || Fires when the character buys an item from a vendor.
|-
| [[@ItemClick]] || Fires when the character single-clicks an item.
|-
| [[@ItemClientTooltip]] || Fires when the tooltips are about to be sent to the client for an item.
|-
| [[@ItemContextMenuRequest]] || Fires when the character requests the context menu options for an item.
|-
| [[@ItemContextMenuSelect]] || Fires when the character selects a context menu option for an item.
|-
| [[@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.
|-
| [[@ItemDamage]] || Fires when the character damages an item.
|-
| [[@ItemDClick]] || Fires when the character double-clicks an item.
|-
| [[@ItemDropOn_Char]] || Fires when the character drops an item on to a character.
|-
| [[@ItemDropOn_Ground]] || Fires when the character drops an item on to the ground.
|-
| [[@ItemDropOn_Item]] || Fires when the character drops an item on to another item.
|-
| [[@ItemDropOn_Self]] || Fires when the character drops an item inside another item.
|-
| [[@ItemEquip]] || Fires when the character equips an item.
|-
| [[@ItemEquipTest]] || Fires when the characer is about to equip an item.
|-
| [[@ItemPickUp_Ground]] || Fires when the character picks an item up from the ground.
|-
| [[@ItemPickUp_Pack]] || Fires when the character picks an item up from inside a container.
|-
| [[@ItemPickUp_Self]] || Fires when the character picks an item up from inside another item.
|-
| [[@ItemPickUp_Stack]] || Fires when the character picks up an item from a stack.
|-
| [[@ItemSell]] || Fires when the character sells an item to a vendor.
|-
| [[@ItemSpellEffect]] || Fires when the character hits an item with a spell.
|-
| [[@ItemStep]] || Fires when the character steps on an item.
|-
| [[@ItemTargOn_Cancel]] || Fires when the character cancels an item's target cursor.
|-
| [[@ItemTargOn_Char]] || Fires when the character targets a character with an item's target cursor.
|-
| [[@ItemTargOn_Ground]] || Fires when the character targets the ground with an item's target cursor.
|-
| [[@ItemTargOn_Item]] || Fires when the character targets an item with an item's target cursor.
|-
| [[@ItemToolTip]] || Fires when the character requests old-style tooltips for an item.
|-
| [[@ItemUnEquip]] || Fires when the character unequips an item.
|-
| [[@Jailed]] || Fires when the character is sent to jail.
|-
| [[@KarmaChange]] || Fires when the character's karma changes.
|-
| [[@Kill]] || Fires when the character kills another character.
|-
| [[@Login]] || Fires when the character logs in.
|-
| [[@Logout]] || Fires when the character logs out.
|-
| [[@Mount]] || Fires when the character mounts a ride.
|-
| [[@MurderDecay]] || Fires when one of the character's kills is about to decay.
|-
| [[@MurderMark]] || Fires when the character is about to gain a kill.
|-
| [[@PersonalSpace]] || Fires when the character is stepped on.
|-
| [[@PetDesert]] || Fires when the character deserts its owner.
|-
| [[@Profile]] || Fires when a player attempts to read the character's profile from the paperdoll.
|-
| [[@ReceiveItem]] || Fires when the NPC receives an item from another character, before they decide if they want it or not.
|-
| [[@RegionEnter]] || Fires when the character enters a region.
|-
| [[@RegionLeave]] || Fires when the character leaves a region.
|-
| [[@Rename]] || Fires when the character renames another.
|-
| [[@SeeCrime]] || Fires when the character sees a crime take place.
|-
| [[@SkillAbort]] || Fires when the character aborts a skill.
|-
| [[@SkillChange]] || Fires when the character's skill level changes.
|-
| [[@SkillFail]] || Fires when the character fails a skill.
|-
| [[@SkillGain]] || Fires when the character has a chance to gain in a skill.
|-
| [[@SkillMakeItem]] || Fires when the character crafts an item.
|-
| [[@SkillMenu]] || Fires when a skill menu is shown to the character.
|-
| [[@SkillPreStart]] || Fires when the character starts a skill, before any hardcoded action takes place.
|-
| [[@SkillSelect]] || Fires when the character selects a skill on their skill menu.
|-
| [[@SkillStart]] || Fires when the character starts a skill.
|-
| [[@SkillSuccess]] || Fires when the character succeeds at a skill.
|-
| [[@SkillUseQuick]] || Fires when the character quickly uses a skill.
|-
| [[@SpellBook]] || Fires when the character opens their spellbook.
|-
| [[@SpellCast]] || Fires when the character casts a spell.
|-
| [[@SpellEffect]] || Fires when the character is hit by the effects of a spell.
|-
| [[@SpellFail]] || Fires when the character fails to cast a spell.
|-
| [[@SpellSelect]] || Fires when the character selects a spell to cast.
|-
| [[@SpellSuccess]] || Fires when the character successfully casts a spell.
|-
| [[@StatChange]] || Fires when the character's STR, DEX or INT is changed through skill gain.
|-
| [[@StepStealth]] || Fires when the character takes a step whilst hidden.
|-
| [[@ToolTip]] || Fires when a player requests old-style tooltips for this character.
|}
[[Category: Reference Compendium]]
[[Category: Triggers]]

@UserWarmode

2015-05-07T09:49:25Z

XuN:

==Description==
This trigger fires when a player attempts to switch between war and peace mode.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] changing between war and peace mode.
|-
| [[SRC]] || The [[Characters#Players|player]] changing between war and peace mode.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || If 0, the player is entering peace mode. If 1, the player is entering war mode.
|-
| ARGN2 || I || If 1 will trigger skill fail for the current skill.
|-
| ARGN3 || I || Setting it to 1 will force a attacker's cleanup.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the player from changing to the requested mode.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserVirtueInvoke

2015-05-07T09:49:13Z

XuN:

==Description==
This trigger fires when a player attempts to invoke a virtue by using a macro.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Characters#Players|player]] invoking the virtue.
|-
| [[I]] || The [[Characters#Players|player]] invoking the virtue.
|-
| [[SRC]] || The [[Characters#Players|player]] invoking the virtue.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The virtue being invoked. Known values are:
{| cellpadding="2"
| '''Value''' || '''Description'''
|-
| 1 || Honor
|-
| 2 || Sacrifice
|-
| 3 || Valor
|}
|}

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserVirtue

2015-05-07T09:49:02Z

XuN:

==Description==
This trigger fires when a client attempts to access the virtue dialog for a character, or double clicks a virtue icon on the dialog.

Fires on:
* [[Characters#Clients|Clients]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[ARGO]] || The [[Characters|character]] whose virtue dialog is being requested.
|-
| [[I]] || The [[Characters#Clients|client]] attempting to access or use the virtue dialog.
|-
| [[SRC]] || The [[Characters#Clients|client]] attempting to access or use the virtue dialog.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The action that the client is attempting. Known values are:
{| cellpadding="2"
| '''Action''' || '''Description'''
|-
| 1 || Requesting [[ARGO]]'s virtue dialog.
|-
| 105 || Compassion button double clicked.
|-
| 106 || Honesty button double clicked.
|-
| 107 || Honoe button double clicked.
|-
| 108 || Humility button double clicked.
|-
| 109 || Justice button double clicked.
|-
| 110 || Sacrifice button double clicked.
|-
| 111 || Spirituality button double clicked.
|-
| 112 || Virtue button double clicked.
|}
|}

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserStats

2015-05-07T09:48:51Z

XuN:

==Description==
This trigger fires when a status update is sent to a player.

Fires on:
* [[Characters#Clients|Clients]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Clients|client]] receiving the status update.
|-
| [[SRC]] || The [[Characters|character]] whose status they are receiving.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN3 || I || If 1, then the client requested the update (i.e. opened their status window)
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the status update from being sent.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserSpecialMove

2015-05-07T09:48:40Z

XuN:

==Description==
This trigger fires when a player attempts to use a special move.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] using the special move.
|-
| [[SRC]] || The [[Characters#Players|player]] using the special move.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The special move being used.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserSkills

2015-05-07T09:48:30Z

XuN:

==Description==
This trigger fires when a skill update is sent to a client. This normally fires when the player accesses their skill menu, or when they receive a skill gain. It can also fire when the [[INFO]] command is used.

Fires on:
* [[Characters#Clients|Clients]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Clients|client]] receiving the skill update.
|-
| [[SRC]] || The [[Characters|character]] whose skill(s) they are receiving.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The skill number they are receiving an update for. (-1 = All skills)
|-
| ARGN2 || I || If 1, then the skills update is being sent due to the [[INFO]] command being used.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the skills update from being sent.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserQuestButton

2015-05-07T09:48:20Z

XuN:

==Description==
This trigger fires when a player clicks on the Quest button on their paperdoll.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] pressing the button.
|-
| [[SRC]] || The [[Characters#Players|player]] pressing the button.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserQuestArrowClick

2015-05-07T09:48:10Z

XuN:

==Description==
This trigger fires when a player clicks on the quest arrow that is displayed using the [[ARROWQUEST]] command.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] clicking the quest arrow.
|-
| [[SRC]] || The [[Characters#Players|player]] clicking the quest arrow.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The mouse button that was used. (0 = Left Click, 1 = Right Click)
|}

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserMailBag

2015-05-07T09:48:00Z

XuN:

==Description==
This trigger fires when a player has a mail bag dropped on to them by another character.

Fires on:
* [[Characters]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters|character]] who the mail bag was dropped on.
|-
| [[SRC]] || The [[Characters#Players|player]] dropping the mail bag.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents the character being notified about the action.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserKRToolbar

2015-05-07T09:47:49Z

XuN:

==Description==
This trigger fires when a player presses a button on a Kingdom Reborn toolbar.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] pressing the button.
|-
| [[SRC]] || The [[Characters#Players|player]] pressing the button.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The button command type. Known values are:
{|
| '''Type''' || '''Description'''
|-
| 1 || Cast spell
|-
| 2 || Weapon ability
|-
| 3 || Use skill
|-
| 4 || Use item
|-
| 5 || Scroll
|}
|-
| ARGN2 || I || The button's command parameter.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents Sphere from processing the command.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserGuildButton

2015-05-07T09:47:37Z

XuN:

==Description==
This trigger fires when a player presses on the Guild button on their paperdoll.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] pressing the button.
|-
| [[SRC]] || The [[Characters#Players|player]] pressing the button.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

''No return values are handled for this trigger.''

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserExWalkLimit

2015-05-07T09:47:27Z

XuN:

==Description==
This trigger fires when a player exceeds the walking limit defined by the WALKBUFFER and WALKREGEN settings in Sphere.ini. This could indicate that the player is using a cheat to run faster than they should (i.e. speedhacking) or it could be a result of a poor connection between the server and client.

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] exceeding the walk limit.
|-
| [[SRC]] || The [[Characters#Players|player]] exceeding the walk limit.
|}

==Arguments==
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:

''No arguments are set for this trigger.''

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Allows the player to continue moving without being restricted.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]

@UserExtCmd

2015-05-07T09:47:17Z

XuN:

==Description==
This trigger fires when a player sends an extended command packet (packet 0x12).

Fires on:
* [[Characters#Players|Players]]

==References==
The following object references are explicitly available for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Name''' || '''Description'''
|-
| [[I]] || The [[Characters#Players|player]] sending the command.
|-
| [[SRC]] || The [[Characters#Players|player]] sending the command.
|}

==Arguments==
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:

{| border="1" cellspacing="4" cellpadding="4"
| '''Argument''' || '''In/Out''' || '''Description'''
|-
| ARGN1 || I || The command type. Known commands are:
{| cellpadding="2"
| '''Command''' || '''Description'''
|-
| 0x24 || Use Skill macro
|-
| 0x27 || Cast spell from book
|-
| 0x2F || Auto targeting macro
|-
| 0x43 || Open Spellbook macro
|-
| 0x56 || Cast Spell macro
|-
| 0x88 || Open Door macro
|-
| 0x6B || God Client command
|-
| 0xC7 || Bow or Salute macro
|-
| 0xF4 || Invoke Virtue macro
|}
|-
| ARGS || IO || The command text.
|}

==Return Values==
The following return values are explicitly defined for this trigger:

{| border="1" cellspacing="4" cellpadding="4"
| '''Return Value''' || '''Description'''
|-
| 1 || Prevents Sphere from processing the command.
|}

[[Category: Reference Compendium]]
[[Category: Triggers]]
[[Category: Characters]]
[[Category: Players]]