DestroyPickup: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|DestroyPickup(pickup)}} {{FuncParameters}} {{FuncParam|pickup|__EDIT_ME__}} {{FuncReturnValue|__E...")
 
No edit summary
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Destroy a pickup created with [[CreatePickup]].}}


{{FuncSyntax|DestroyPickup(pickup)}}
{{FuncSyntax|DestroyPickup(pickup)}}


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


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns '''true''' on success.}}


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
local pickupId = CreatePickup(818, 130222.4296875, 80253.5859375, 1659.2888183594)
DestroyPickup(pickupId)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[CreatePickup]]
* [[IsValidPickup]]

Revision as of 15:43, 17 November 2019

DestroyPickup

Type: Function
Context: Server
Introduced: v1.0

Description

Destroy a pickup created with CreatePickup.

Syntax

DestroyPickup(pickup)

Parameters

  • pickup
    The pickup identifier.

Return Value

  • Returns true on success.

Example

local pickupId = CreatePickup(818, 130222.4296875, 80253.5859375, 1659.2888183594)
DestroyPickup(pickupId)

See also