setDamage: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Add setDammage alias)
 
(74 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1=  


|1.5|= Game version
|game2= arma1
|version2= 1.00


|game3= arma2
|version3= 1.00


|eff= global|= Effects in MP
|game4= arma2oa
|arg= global|= Arguments in MP
|version4= 1.50
____________________________________________________________________________________________


| Damage / repair object. Damage 0 means fully functional, damage 1 means completely destroyed / dead. (This function is an alias of [[setDammage]] and was introduced to fix the obvious spelling error in the original function name)<br><br>
|game5= tkoh
Since Arma 3 v1.67 there is an alternative syntax to this command allowing to switch off destruction effects. |DESCRIPTION=
|version5= 1.00
____________________________________________________________________________________________


| object '''setDamage''' damage |SYNTAX=
|game6= arma3
|version6= 0.50


|p1= object: [[Object]] |PARAMETER1=
|eff= global
|p2= damage: [[Number]] |PARAMETER2=


| [[Nothing]] |RETURNVALUE=
|arg= global


|s2= object '''setDamage''' [damage, useEffects] &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''Since Arma 3 v1.67''|SYNTAX=
|gr1= Object Manipulation


|p21= object: [[Object]] |PARAMETER2=1
|alias= [[setDammage]]
|p22= [damage, useEffects]: [[Array]] |PARAMETER2=2
|p23= damage: [[Number]] |PARAMETER2=3
|p24= useEffects: [[Boolean]] - [[false]] to skip destruction effects. Default: [[true]] |PARAMETER2=4


|r2= [[Nothing]] |RETURNVALUE=
|descr=
____________________________________________________________________________________________
{{{!}} class="wikitable float-right align-center-col-2"
 
{{!}}+
|x1= <code>_soldier1 [[setDamage]] 1;</code> |EXAMPLE1=
! {{Link|:Category: Event Handlers|Event Handler}}
! Triggered
{{!}}-
{{!}} {{hl|Hit}}
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} {{hl|HandleDamage}}
{{!}} {{Icon|unchecked}}
{{!}}-
{{!}} {{hl|Killed}}
{{!}} {{Icon|checked}}
{{!}}-
{{!}} {{hl|MPKilled}}
{{!}} {{Icon|checked}}
{{!}}}


|x2= <code>_house1 [[setDamage]] [1, [[false]]];</code> |EXAMPLE2=
Sets the damage (or lack thereof) of an object/unit. The alternative syntax allows to skip destruction effects for vehicles and buildings.
___________________________________________________________________________________________
{{Feature|arma3|
Since {{arma3}} v2.12 it is possible to influence trees, poles and walls fall direction by supplying the ''killer'' entity param - the fall direction will then be away from ''killer''<nowiki/>'s position.
In multiplayer, the ''killer'' argument is ignored if the command is not executed on the server unless it targets trees, walls or poles - see {{Link|#Syntax 2}} and {{Link|#Example 3}}.
}}


| [[setDammage]], [[setVehicleArmor]], [[damage]], [[getDammage]], [[setHit]], [[getHit]], [[getHitIndex]], [[setHitIndex]], [[getHitPointDamage]], [[setHitPointDamage]] |SEEALSO=
|s1= object [[setDamage]] damage


}}
|p1= object: [[Object]]
 
|p2= damage: [[Number]] - range 0..1, 0 = pristine/healthy condition, 1 = entirely destroyed/killed
 
|r1= [[Nothing]]
 
|s2= object [[setDamage]] [damage, useEffects, killer, instigator]
 
|s2since= arma3 1.68
 
|p21= object: [[Object]]
 
|p22= damage: [[Number]] - range 0..1, 0 = pristine/healthy condition, 1 = entirely destroyed/killed
 
|p23= useEffects: [[Boolean]] (Optional, default [[true]]) - [[false]] to skip destruction effects
 
|p24= {{Icon|serverExec|28}} killer: [[Object]] - (Optional, default [[objNull]]) the entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill.
* it can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled).
* it will alter the killer's [[rating]] as if the killer directly killed the unit
* it will be listed as <sqf inline>_killer</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler
* MP restricted similar to [[setShotParents]], will be ignored unless executed on the server or headless client in MP
|p24since= arma3 2.12
 
|p25= {{Icon|serverExec|28}} instigator: [[Object]] - (Optional, default [[objNull]]) the person that instigated the damage.
* if a tank is a killer, the tank gunner that pulled the trigger is instigator
* it will be listed as <sqf inline>_instigator</sqf> parameter in the [[Arma 3: Event Handlers#Killed|Killed]] event handler
* MP restricted similar to [[setShotParents]], will be ignored unless executed on the server or headless client in MP
** the above MP restriction does not apply to trees, poles and walls
|p25since= arma3 2.12
 
|r2= [[Nothing]]
 
|x1= <sqf>_soldier1 setDamage 1;</sqf>


<h3 style="display:none">Notes</h3>
|x2= <sqf>_house1 setDamage [1, false];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


|x3= <sqf>
// executed on a client
_remoteVehicle setDamage [1, true, player]; // killer is not considered if the command is not called on the server - the vehicle still gets destroyed
_tree setDamage [1, true, player]; // the tree is destroyed and falls away from the player
</sqf>


<dd class="notedate">
|seealso= [[setVehicleArmor]] [[damage]] [[setHit]] [[getHit]] [[getHitIndex]] [[setHitIndex]] [[getHitPointDamage]] [[setHitPointDamage]]
<dt class="note">'''[[User:Ceeeb|Ceeeb]]'''
}}
<dd class="note">In '''OFP''', setting a unit's damage to a negative value will set it's health to full, but impair their aim.


<!-- Note Section END -->
{{Note
</dl>
|user= Fragorl
|timestamp= 20060417073600
|text= In '''{{ofp}}''', setting a unit's damage to a negative value will set it is health to full, but impair their aim.
|game= ofp
}}


<h3 style="display:none">Bottom Section</h3>
{{Note
[[Category:Scripting Commands|SETDAMAGE]]
|user= KamikazXeX
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
|timestamp= 20150529112300
[[Category:Scripting Commands OFP 1.96|SETDAMAGE]]
|text= Using this possible overrides individual hit damages such as [[setHitPointDamage]] ["HitHead", _value]; if you're having issues try setting hitdamage ''after'' setdamage.
[[Category:Scripting Commands ArmA|SETDAMAGE]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Object_Manipulation|{{uc:{{PAGENAME}}}}]]
[[Category:Notes: Improper Formatting|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Sarogahtyp
<dd class="notedate">Posted on May 29, 2015 - 11:23 (UTC)</dd>
|timestamp= 20210624103100
<dt class="note">[[User:KamikazeXeX|KamikazeXeX]]</dt>
|text= You are able to repair buildings with this command if you just store the original object and use setDamage on this and not on the wreck which is shown after the building was destroyed. This works in debug console when pointing a house:
<dd class="note">
<sqf>[] spawn
Using this possible overrides individual hit damages such as setHitPointDamage ["HitHead", _value]; if you're having issues try setting hitdamage after setdamage
{
</dd>
private _house = cursorObject;
</dl>
_house setDamage 1;
<!-- DISCONTINUE Notes -->
sleep 5;
_house setDamage 0;
};</sqf>
}}

Latest revision as of 00:55, 7 December 2023

Hover & click on the images for description

Description

Description:
Event Handler Triggered
Hit Unchecked
HandleDamage Unchecked
Killed Checked
MPKilled Checked

Sets the damage (or lack thereof) of an object/unit. The alternative syntax allows to skip destruction effects for vehicles and buildings.

Arma 3
Since Arma 3 v2.12 it is possible to influence trees, poles and walls fall direction by supplying the killer entity param - the fall direction will then be away from killer's position. In multiplayer, the killer argument is ignored if the command is not executed on the server unless it targets trees, walls or poles - see Syntax 2 and Example 3.
Alias:
setDammage
Groups:
Object Manipulation

Syntax

Syntax:
object setDamage damage
Parameters:
object: Object
damage: Number - range 0..1, 0 = pristine/healthy condition, 1 = entirely destroyed/killed
Return Value:
Nothing

Alternative Syntax

Syntax:
object setDamage [damage, useEffects, killer, instigator]
Parameters:
object: Object
damage: Number - range 0..1, 0 = pristine/healthy condition, 1 = entirely destroyed/killed
useEffects: Boolean (Optional, default true) - false to skip destruction effects
since Arma 3 logo black.png2.12
SEServer killer: Object - (Optional, default objNull) the entity that caused the damage. If the damage leads to the death of the unit, the killer will be used as the object that caused the kill.
  • it can be used to show "killed by player" in debriefing statistics and kill messages in the chat (if death messages are enabled).
  • it will alter the killer's rating as if the killer directly killed the unit
  • it will be listed as _killer parameter in the Killed event handler
  • MP restricted similar to setShotParents, will be ignored unless executed on the server or headless client in MP
since Arma 3 logo black.png2.12
SEServer instigator: Object - (Optional, default objNull) the person that instigated the damage.
  • if a tank is a killer, the tank gunner that pulled the trigger is instigator
  • it will be listed as _instigator parameter in the Killed event handler
  • MP restricted similar to setShotParents, will be ignored unless executed on the server or headless client in MP
    • the above MP restriction does not apply to trees, poles and walls
Return Value:
Nothing

Examples

Example 1:
_soldier1 setDamage 1;
Example 2:
_house1 setDamage [1, false];
Example 3:
// executed on a client _remoteVehicle setDamage [1, true, player]; // killer is not considered if the command is not called on the server - the vehicle still gets destroyed _tree setDamage [1, true, player]; // the tree is destroyed and falls away from the player

Additional Information

See also:
setVehicleArmor damage setHit getHit getHitIndex setHitIndex getHitPointDamage setHitPointDamage

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
Fragorl - c
Posted on Apr 17, 2006 - 07:36 (UTC)

In Operation Flashpoint, setting a unit's damage to a negative value will set it is health to full, but impair their aim.

KamikazXeX - c
Posted on May 29, 2015 - 11:23 (UTC)
Using this possible overrides individual hit damages such as setHitPointDamage ["HitHead", _value]; if you're having issues try setting hitdamage after setdamage.
Sarogahtyp - c
Posted on Jun 24, 2021 - 10:31 (UTC)
You are able to repair buildings with this command if you just store the original object and use setDamage on this and not on the wreck which is shown after the building was destroyed. This works in debug console when pointing a house:
[] spawn { private _house = cursorObject; _house setDamage 1; sleep 5; _house setDamage 0; };