BIS fnc VREffectKilled: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(function has to be scheduled when instant param is true)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(10 intermediate revisions by 2 users not shown)
Line 9: Line 9:
|descr= Delete body of a virtual soldier after he's killed.
|descr= Delete body of a virtual soldier after he's killed.


|s1=[object, instant, delay] call [[BIS_fnc_VREffectKilled]]
|s1= [object, instant, delay] call [[BIS_fnc_VREffectKilled]]


|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]]
|r1= [[Boolean]] - [[true]] when the function is done


|x1= <code>[ [[player]], [[true]], 5 ] [[call]] [[BIS_fnc_VREffectKilled]];</code>
|x1= <sqf>[player] call BIS_fnc_VREffectKilled;</sqf>
|x2= <sqf>[player, true, 5] spawn BIS_fnc_VREffectKilled;</sqf>


|seealso= [[Arma 3: Virtual Reality Custom Courses|Arma 3 VR Custom Courses]], [[:Category:Function Group: VR|VR functions]]
|seealso= [[Arma 3: Virtual Reality Custom Courses|Arma 3 VR Custom Courses]] [[:Category:Function Group: VR|VR functions]]
}}
}}

Latest revision as of 17:27, 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