BIS fnc VREffectKilled: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |s1=[" to " |s1= [")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )T([a-z])" to "$1t$3")
Line 13: Line 13:
|p1= object: [[Object]] - Object
|p1= object: [[Object]] - Object
|p2= instant: [[Boolean]] - (Optional, default [[false]]) [[true]] to delete the body right away, [[false]] to add '''killed''' [[addEventHandler|EH]] which will delete it after death
|p2= instant: [[Boolean]] - (Optional, default [[false]]) [[true]] to delete the body right away, [[false]] to add '''killed''' [[addEventHandler|EH]] which will delete it after death
|p3= delay: [[Number]] - (Optional, default 10) Time in seconds before the body disappears
|p3= delay: [[Number]] - (Optional, default 10) time in seconds before the body disappears


|r1= [[Boolean]] - [[true]] when the function is done
|r1= [[Boolean]] - [[true]] when the function is done

Revision as of 12:32, 8 November 2023

Hover & click on the images for description

Description

Description:
Delete body of a virtual soldier after he's killed.
Execution:
spawn
Groups:
VR

Syntax

Syntax:
[object, instant, delay] call BIS_fnc_VREffectKilled
Parameters:
object: Object - Object
instant: Boolean - (Optional, default false) true to delete the body right away, false to add killed EH which will delete it after death
delay: Number - (Optional, default 10) time in seconds before the body disappears
Return Value:
Boolean - true when the function is done

Examples

Example 1:
[ player ] call BIS_fnc_VREffectKilled;
Example 2:
[ player, true, 5 ] spawn BIS_fnc_VREffectKilled;

Additional Information

See also:
Arma 3 VR Custom Courses VR functions

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