BIS fnc VREffectKilled: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (example)
m (Text replacement - ">\[ +(.*) *\] +(call|spawn)" to ">[$1] $2")
 
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma 3 |= Game name
|game1= arma3
|version1= 1.24


|1.24|= Game version
|exec= spawn
____________________________________________________________________________________________
|gr1= VR


| Delete body of a virtual soldier after he's killed. |= Description
|descr= Delete body of a virtual soldier after he's killed.
____________________________________________________________________________________________


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


|p1= object: [[Object]] - Object|= Parameter 1
|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|= Parameter 2
|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|= Parameter 3
|p3= delay: [[Number]] - (Optional, default 10) time in seconds before the body disappears
____________________________________________________________________________________________


| [[Boolean]]|= Return value
|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>


| [[Arma3: Virtual Reality Custom Courses]], [[:Category:Function Group: VR|VR functions]] |= See also
|seealso= [[Arma 3: Virtual Reality Custom Courses|Arma 3 VR Custom Courses]] [[:Category:Function Group: VR|VR functions]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: VR|{{uc:VREffectKilled}}]]
[[Category:Functions|{{uc:VREffectKilled}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:VREffectKilled}}]]

Latest revision as of 17:27, 8 November 2023

Arma 3 logo black.png1.24
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_VREffectKilled&oldid=349396"