allowDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Prepare the page for the first new Arma2 command.)
 
m (Some wiki formatting)
 
(61 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|ALLOWDAMAGE]]
{{RV|type=command


{{Command|=
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| Arma2 |=
|game2= arma2oa
|version2= 1.50


|1.00|=
|game3= tkoh
|version3= 1.00


|arg= |= MPARGUMENTS
|game4= arma3
|version4= 0.50


|eff= |= MPEFFECTS
|arg= local
____________________________________________________________________________________________


| Allow an object to be damaged (or injured, or killed). |=
|eff= global
____________________________________________________________________________________________


| object '''allowDamage''' allow |=
|gr1= Object Manipulation


|p1= object: [[Object]] - |= PARAMETER1
|descr= Enables / disables an entity's ability to receive damage. This command does not prevent the entity from taking scripted damage from commands such as [[setDamage]], [[setHit]], [[setHitIndex]] or [[setHitPointDamage]].
{{Feature|informative|This command only supports entities ({{hl|Entity}} is a [[Class Inheritance|child class]] of {{hl|Object}}, i.e. all entities are objects, but not all objects are entities). Consequently, there are objects that are not affected by this command, for example terrain vegetation such as trees.}}


|p2= allow: [[Boolean]] - |= PARAMETER2
|mp= {{Feature | important | This command has to be executed where the object is [[Multiplayer Scripting#Locality|local]]. Its effect will only last as long as the object does not change locality. If the object changes locality, the command needs to be executed again on the new [[owner]]'s machine to maintain the effect.}}


|alias= [[allowDammage]]


| [[Nothing]] |= RETURNVALUE
|s1= entity [[allowDamage]] allow


|p1= entity: [[Object]]


|x1= <pre>player allowDamage false</pre> |= EXAMPLE1
|p2= allow: [[Boolean]]
____________________________________________________________________________________________


| |= SEEALSO
|r1= [[Nothing]]


| |= MPBEHAVIOUR
|x1= <sqf>player allowDamage false;</sqf>
____________________________________________________________________________________________
 
|seealso= [[isDamageAllowed]] [[setDamage]] [[setHit]] [[setHitIndex]] [[setHitPointDamage]] [[damage]]
}}
}}


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= AgentRev01
<!-- Note Section BEGIN -->
|timestamp= 20130902182600
|text=
<sqf>_object allowDamage false;</sqf>
has the same effect as
<sqf>_object addEventHandler ["HandleDamage", {0}];</sqf>


<!-- Note Section END -->
'''except for buildings that are native to the map'''; for those, the effects of HandleDamage will not sync properly across all clients, even if added to the building on every client and the server.
</dl>
}}
 
<h3 style='display:none'>Bottom Section</h3>
 
[[Category:Scripting Commands Arma2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:16, 4 May 2024

Hover & click on the images for description

Description

Description:
Enables / disables an entity's ability to receive damage. This command does not prevent the entity from taking scripted damage from commands such as setDamage, setHit, setHitIndex or setHitPointDamage.
This command only supports entities (Entity is a child class of Object, i.e. all entities are objects, but not all objects are entities). Consequently, there are objects that are not affected by this command, for example terrain vegetation such as trees.
Multiplayer:
This command has to be executed where the object is local. Its effect will only last as long as the object does not change locality. If the object changes locality, the command needs to be executed again on the new owner's machine to maintain the effect.
Alias:
allowDammage
Groups:
Object Manipulation

Syntax

Syntax:
entity allowDamage allow
Parameters:
entity: Object
allow: Boolean
Return Value:
Nothing

Examples

Example 1:
player allowDamage false;

Additional Information

See also:
isDamageAllowed setDamage setHit setHitIndex setHitPointDamage damage

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
AgentRev01 - c
Posted on Sep 02, 2013 - 18:26 (UTC)
_object allowDamage false;
has the same effect as
_object addEventHandler ["HandleDamage", {0}];
except for buildings that are native to the map; for those, the effects of HandleDamage will not sync properly across all clients, even if added to the building on every client and the server.