DestroyObject: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|DestroyObject(object)}} {{FuncParameters}} {{FuncParam|object|__EDIT_ME__}} {{FuncReturnValue|__E...")
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Destroy an object created with [[CreateObject]].}}


{{FuncSyntax|DestroyObject(object)}}
{{FuncSyntax|DestroyObject(object)}}


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


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


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua">
local obj = CreateObject(1, 0.0, 0.0, 0.0)
DestroyObject(obj)
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[CreateObject]]
* [[IsValidObject]]

Latest revision as of 20:55, 31 August 2020

DestroyObject

Type: Function
Context: Server
Introduced: v1.0

Description

Destroy an object created with CreateObject.

Syntax

DestroyObject(object)

Parameters

  • object
    The object identifier.

Return Value

  • Returns true on success.

Example

local obj = CreateObject(1, 0.0, 0.0, 0.0)
DestroyObject(obj)

See also