IsValidObject: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|IsValidObject(object)}} {{FuncParameters}} {{FuncParam|object|__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|Check if the specified object is valid or not.}}


{{FuncSyntax|IsValidObject(object)}}
{{FuncSyntax|IsValidObject(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>
if IsValidObject(objectid) then
    DestroyObject(objectid)
end
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
{{Template:ObjectFunctions}}

Revision as of 15:10, 19 November 2019

IsValidObject

Type: Function
Context: Server
Introduced: v1.0

Description

Check if the specified object is valid or not.

Syntax

IsValidObject(object)

Parameters

  • object
    The object identifier.

Return Value

  • Returns true on success.

Example

if IsValidObject(objectid) then
    DestroyObject(objectid)
end

See also

Retrieved from "https://dev.playonset.com/index.php?title=IsValidObject&oldid=2903"