Difference between revisions of "VN fnc revive action unloadPlayers"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - "]]; |p1n=" to "]] |p1n=")
(Page filling)
Line 1: Line 1:
[[Category:TODO]]
 
 
{{Function
 
{{Function
  
Line 6: Line 5:
 
|author= Ethan Johnson
 
|author= Ethan Johnson
  
|a=
+
|a= global
  
|e=
+
|e= global
  
 
|g1= advanced_revive_functions
 
|g1= advanced_revive_functions
  
|d= <pre>/*
+
|d= Main player unloading action function.
        FILE: fn_revive_action_unloadplayer.sqf
 
        DATE: 18-05-2020
 
        AUTHOR: Ethan Johnson
 
  
        DESCRIPTION:
+
|s= [vehicle, type] call [[VN_fnc_revive_action_unloadPlayers]]
                Main player unloading 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_unloadplayers]]
+
|p1n= vehicle
 
+
|p1t= object
|p1n=
+
|p1d= the vehicle on which the action is performed
|p1t=
 
|p1d=
 
 
|p1v=
 
|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=
 
|p2v=
  
|r1t=
+
|r1t= boolean
|r1d=
+
|r1d= {{Biki|true}} when done
  
|x1= <code>-</code>
+
|x1= <code>[sogJeep, 3] call [[VN_fnc_revive_action_unloadPlayers]];</code>
 
}}
 
}}

Revision as of 17:40, 30 January 2021

← back to Functions Introduced in S.O.G. Prairie Fire v1.00
by Ethan Johnson
Argument(s): global
Effect(s): global

Description

Main player unloading action function.

Syntax

Syntax
[vehicle, type] call VN_fnc_revive_action_unloadPlayers
Parameters
vehicle: Object - the vehicle on which the action is performed
type: Number - the type of performed action:
  • 1: action started
  • 2: action tick (see VN_fnc_holdActionAdd)
  • 3: action completed
  • 4: action interrupted
Return value
Boolean - true when done

Examples

Example 1
[sogJeep, 3] call VN_fnc_revive_action_unloadPlayers;