GetPickupLocation: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Client|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|GetPickupLocation(pickupid)}} {{FuncParameters}} {{FuncParam|pickupid|__EDIT_ME__}} {{FuncReturnV...")
 
No edit summary
 
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Get the specified pickup's XYZ vectors (location).}}


{{FuncSyntax|GetPickupLocation(pickupid)}}
{{FuncSyntax|GetPickupLocation(pickupid)}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|pickupid|__EDIT_ME__}}
{{FuncParam|pickupid|The pickup identifier.}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|This function returns the XYZ vectors for the specified vectors.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
local x, y, z = GetPickupLocation(pickupid)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:PickupFunctions}}

Latest revision as of 13:28, 19 November 2019

GetPickupLocation

Type: Function
Context: Client
Introduced: v1.0

Description

Get the specified pickup's XYZ vectors (location).

Syntax

GetPickupLocation(pickupid)

Parameters

  • pickupid
    The pickup identifier.

Return Value

  • This function returns the XYZ vectors for the specified vectors.

Example

local x, y, z = GetPickupLocation(pickupid)

See also