Difference between revisions of "VN fnc revive action undragPlayer"

Latest revision as of 17:37, 30 January 2021

Introduced in S.O.G. Prairie Fire v1.00
by Ethan Johnson

Argument(s):	n/a
Effect(s):	global

Main player undragging action function.

Syntax

[] call VN_fnc_revive_action_undragPlayer

Parameters

draggedUnit: Object - (Optional, unused) the unit that the action is being performed on

type: Number - the type of performed action:

Return value

Boolean - true when done

@@ Line 1: / Line 1: @@
 {{Function
 |v= 1.00
-|a= Ethan Johnson
+|author= Ethan Johnson
-|e=
+|a=
+|e= global
 |g1= advanced_revive_functions
-|d= <pre>/*
+|d= Main player undragging action function.
-        FILE: fn_revive_action_undragplayer.sqf
-        DATE: 18-05-2020
-        AUTHOR: Ethan Johnson
-        DESCRIPTION:
-                Main player undragging action function
-        PARAMETERS:
-                (0): OBJECT - The unit that the action is being performed on
-                (1): NUMBER - The type of action that is being performed
-        RETURNS:
-                BOOL
-*/
-</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
-|s= [] call [[VN_fnc_revive_action_undragplayer]];
+|s= [] call [[VN_fnc_revive_action_undragPlayer]]
-|p1n=
+|p1n= draggedUnit
-|p1t=
+|p1t= object
-|p1d=
+|p1d= (Optional, unused) the unit that the action is being performed on
 |p1v=
-|p2n=
+|p2n= type
-|p2t=
+|p2t= number
-|p2d=
+|p2d= the type of performed action:
+* 1: action started
+* 2: action tick (see [[VN_fnc_holdActionAdd]])
+* 3: action completed
+* 4: action interrupted
 |p2v=
-|r1t=
+|r1t= boolean
-|r1d=
+|r1d= {{Biki|true}} when done
-|x1= <code>-</code>
+|x1= <code>[objNull, 3] call [[VN_fnc_revive_action_undragPlayer]];</code>
 }}