Difference between revisions of "@Hit"

From SphereWiki
Jump to: navigation, search
(Created page with '==Description== This trigger fires when a character hits someone using a combat skill. Fires on: * Characters ==References== The following object references are explicitl...')
 
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
{{Languages|@Hit}}
 +
 
==Description==
 
==Description==
 
This trigger fires when a character hits someone using a combat skill.
 
This trigger fires when a character hits someone using a combat skill.
Line 19: Line 21:
 
| [[SRC]] || The [[Characters|character]] being hit.
 
| [[SRC]] || The [[Characters|character]] being hit.
 
|}
 
|}
 
  
 
==Arguments==
 
==Arguments==
Line 28: Line 29:
 
|-
 
|-
 
| ARGN1 || IO || The amount of damage being dealt.
 
| 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==
 
==Return Values==
Line 37: Line 45:
 
| '''Return Value''' || '''Description'''
 
| '''Return Value''' || '''Description'''
 
|-
 
|-
| 1 || Prevents the message from being displayed.
+
| 1 || Cancels the combat swing.
 
|}
 
|}
  
Line 43: Line 51:
 
[[Category: Reference Compendium]]
 
[[Category: Reference Compendium]]
 
[[Category: Triggers]]
 
[[Category: Triggers]]
 +
[[Category: Characters]]
 +
[[Category: Combat]]

Latest revision as of 14:19, 7 May 2015

Help
Available languages


Description

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


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
ARGO The weapon being used (can be nothing, if fists are used).
I The character doing the hitting.
SRC The 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:

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:

Return Value Description
1 Cancels the combat swing.