Difference between revisions of "VN fnc log pickupLogisticItem"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Lou Montana moved page VN fnc log pickuplogisticitem to VN fnc log pickupLogisticItem: name standard)
(Page filling)
Line 1: Line 1:
[[Category:TODO]]
 
 
{{Function
 
{{Function
  
Line 8: Line 7:
 
|a=
 
|a=
  
|e=
+
|e= global
  
 
|g1= Logistics
 
|g1= Logistics
  
|d= <pre>/*
+
|d= Picks up object the player is looking at. Creates a loop that moves the object in the direction of the players camera.
        FILE: fn_log_pickuplogisticitem.sqf
+
Stops when player dies, places object, gets into a vehicle or becomes incapacitated.
        DATE: 27-07-2019
 
        AUTHOR: Ethan Johnson
 
  
        DESCRIPTION:
+
|s= [player, cursorObject] call [[VN_fnc_log_pickupLogisticItem]]
                Picks up object the player is looking at. Creates a loop that moves the object in the direction of the players camera.
 
                Stops when player dies, places object, gets into a vehicle or becomes incapacitated.
 
        PARAMETERS:
 
                (0): OBJECT - Player object.
 
                (1): NUMBER - Cursor object that the player is looking at.
 
        RETURNS:
 
                BOOLEAN
 
*/
 
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
 
  
|s= [] call [[VN_fnc_log_pickuplogisticitem]];
+
|p1n= player
 
+
|p1t= object
|p1n=
+
|p1d= unit picking the item up
|p1t=
 
|p1d=
 
 
|p1v=
 
|p1v=
  
|p2n=
+
|p2n= cursorObject
|p2t=
+
|p2t= object
|p2d=
+
|p2d= picked-up item
 
|p2v=
 
|p2v=
  
|r1t=
+
|r1t= boolean
|r1d=
+
|r1d= {{Biki|true}} on success, {{Biki|false}} on error
  
|x1= <code>-</code>
+
|x1= <code>[player, sogJeep] call VN_fnc_log_pickupLogisticItem</code>
 
}}
 
}}

Revision as of 20:54, 20 January 2021

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

Description

Picks up object the player is looking at. Creates a loop that moves the object in the direction of the players camera. Stops when player dies, places object, gets into a vehicle or becomes incapacitated.

Syntax

Syntax
[player, cursorObject] call VN_fnc_log_pickupLogisticItem
Parameters
player: Object - unit picking the item up
cursorObject: Object - picked-up item
Return value
Boolean - true on success, false on error

Examples

Example 1
[player, sogJeep] call VN_fnc_log_pickupLogisticItem