Difference between revisions of "LUA:AddWard"

Latest revision as of 12:07, 30 January 2021

LUA:AllFunctions - AddWard

Adds a ward with the given amount

Syntax

AddWard(param1, [opt param1], [opt param2], [opt param3])

Required - param1 (in32): param1 is the amount of the ward
Optional - opt param1 (bool), opt param2 (int8), opt param3 (int8): opt param1 is if we want to keep the spell active or remove it when the ward is depleted; opt param2 is the type of ward; opt param3 is the damage type to absorb if ward type is magical

function cast(Caster, Target)
    AddWard(25)
end

Adds a ward that will absorb 25 damage

Can only be used in a spell script

The ward will be applied to the targets of the spell that uses this spell script

0 - all

1 - physical

2 - magical

damage type is the magical damage to absorb

@@ Line 1: / Line 1: @@
-= LUA Functions: HasGroup() =
+{{LUAFunction
-Checks to see if the given spawn has a group
+|Name = AddWard
+|Description =  Adds a ward with the given amount
+|Param1 = in32
+|Param1Desc = is the amount of the ward
+|OptionalParam1 = bool
+|OptionalParam1Desc = is if we want to keep the spell active or remove it when the ward is depleted
+|OptionalParam2 = int8
+|OptionalParam2Desc = is the type of ward
+|OptionalParam3 = int8
+|OptionalParam3Desc = is the damage type to absorb if ward type is magical
+|Example =
+<pre>
+function cast(Caster, Target)
+    AddWard(25)
+end
+</pre>
+|ExampleDesc = Adds a ward that will absorb 25 damage
+|Notes = Can only be used in a spell script
-==== Syntax ====
+The ward will be applied to the targets of the spell that uses this spell script
-HasGroup(param1)
+=== Ward Type ===
-==== Parameters ====
+- all
-; Required - ''param1'' (Spawn)
-: ''param1'' is the spawn we want to check
-==== Usage ====
+- physical
-<pre>
-function hailed(NPC, Spawn)
-    if HasGroup(NPC) then
-        Say(NPC, "I have friends!")
-    else
-        Say(NPC, "I am a loner!")
-    end
-end
-</pre>
-This will cause the spawn to say if they are in a group or not when hailed
+- magical
-== Notes ==
+damage type is the magical damage to absorb
-This will work on both NPC's and player's
+}}