Difference between revisions of "VN fnc log unloadLogisticItem"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - "logistics_functions" to "Logistics")
m (Some wiki formatting)
 
(4 intermediate revisions by the same user not shown)
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= Logistics
 
|g1= Logistics
  
|d= <pre>/*
+
|d= Adds actions for players for the logistics module.
        FILE: fn_log_unloadlogisticitem.sqf
 
        DATE: 27-07-2019
 
        AUTHOR: Ethan Johnson
 
  
        DESCRIPTION:
+
|s= [cursorObject, listIndex] call [[VN_fnc_log_unloadLogisticItem]]
                Adds actions for players for the logistics module.
 
        PARAMETERS:
 
                (0): OBJECT - Object that has the object loaded into it
 
                (1): NUMBER - Index for the item in the listbox. Used for unloading & removal from the vehicle's virtual inventory.
 
        RETURNS:
 
                BOOLEAN
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
 
  
|s= [] call [[VN_fnc_log_unloadlogisticitem]];
+
|p1n= cursorObject
 
+
|p1t= object
|p1n=
+
|p1d= object that has the object loaded into it
|p1t=
 
|p1d=
 
 
|p1v=
 
|p1v=
  
|p2n=
+
|p2n= listIndex
|p2t=
+
|p2t= number
|p2d=
+
|p2d= index for the item in the listbox. Used for unloading & removal from the vehicle's virtual inventory
 
|p2v=
 
|p2v=
  
|r1t=
+
|r1t= boolean
|r1d=
+
|r1d= {{Biki|true}} on success, {{Biki|false}} on failure
  
|x1= <code>-</code>
+
|x1= <code>[sogJeep, 3] call [[VN_fnc_log_unloadLogisticItem]];</code>
 
}}
 
}}

Latest revision as of 20:19, 26 February 2021

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

Description

Adds actions for players for the logistics module.

Syntax

Syntax
[cursorObject, listIndex] call VN_fnc_log_unloadLogisticItem
Parameters
cursorObject: Object - object that has the object loaded into it
listIndex: Number - index for the item in the listbox. Used for unloading & removal from the vehicle's virtual inventory
Return value
Boolean - true on success, false on failure

Examples

Example 1
[sogJeep, 3] call VN_fnc_log_unloadLogisticItem;