allowDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
m (Some wiki formatting)
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Introduced in game=
|game1= arma2
|version1= 1.00


|1.00|Version=
|game2= arma2oa
|version2= 1.50


|arg= local |MPARGUMENTS=  
|game3= tkoh
|version3= 1.00


|eff= global |MPEFFECTS=  
|game4= arma3
____________________________________________________________________________________________
|version4= 0.50


| Allow or prevent an object being damaged (or injured, or killed). The command does not prevent object from taking scripted damage such as [[setHit]], [[setHitIndex]], [[setHitPointDamage]] or [[setDamage]]. To check if damage is allowed at current locality, see [[isDamageAllowed]].<br>
|arg= local


{{Important | This command has to be executed where object is [[local]] and as long as object does not change locality the effect of this command will be global. If object changes locality, the command needs to be executed again on the new [[owner]]'s machine to maintain the effect}} |DESCRIPTION=
|eff= global
____________________________________________________________________________________________


| object [[allowDamage]] allow |SYNTAX=
|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.}}


| [[Nothing]] |RETURNVALUE=
|alias= [[allowDammage]]


|x1= <code>[[player]] [[allowDamage]] [[false]];</code> |EXAMPLE1=
|s1= entity [[allowDamage]] allow
____________________________________________________________________________________________


| [[isDamageAllowed]], [[setDamage]], [[setHit]], [[setHitIndex]], [[setHitPointDamage]]  |SEEALSO=
|p1= entity: [[Object]]


|mp= |MPBEHAVIOUR=
|p2= allow: [[Boolean]]
}}


<h3 style='display:none'>Notes</h3>
|r1= [[Nothing]]
<dl class='command_description'>
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on September 2, 2013
|x1= <sqf>player allowDamage false;</sqf>
<dt class="note">[[User:AgentRev01|AgentRev]]<dd class="note">
<code>_object [[allowDamage]] [[false]];</code>
has the same effect as
<code>_object [[addEventHandler]] ["HandleDamage", {0}];</code>


'''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
|seealso= [[isDamageAllowed]] [[setDamage]] [[setHit]] [[setHitIndex]] [[setHitPointDamage]] [[damage]]
}}


<!-- Note Section END -->
{{Note
</dl>
|user= AgentRev01
|timestamp= 20130902182600
|text=
<sqf>_object allowDamage false;</sqf>
has the same effect as
<sqf>_object addEventHandler ["HandleDamage", {0}];</sqf>


<h3 style='display:none'>Bottom Section</h3>
'''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.
 
}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:16, 4 May 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
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.
Retrieved from "https://community.bistudio.com/wiki?title=allowDamage&oldid=364134"