IsValidObject: Difference between revisions

Revision as of 15:10, 19 November 2019

IsValidObject

Type: Function
Context: Server
Introduced: v1.0

Check if the specified object is valid or not.

IsValidObject(object)

if IsValidObject(objectid) then
    DestroyObject(objectid)
end

@@ Line 1: / Line 1: @@
 {{Info|Function|Server|1.0}}
-{{FuncDescription|__EDIT_ME__}}
+{{FuncDescription|Check if the specified object is valid or not.}}
 {{FuncSyntax|IsValidObject(object)}}
 {{FuncParameters}}
-{{FuncParam|object|__EDIT_ME__}}
+{{FuncParam|object|The object identifier.}}
-{{FuncReturnValue|__EDIT_ME__}}
+{{FuncReturnValue|Returns '''true''' on success.}}
 == Example ==
-__EDIT_ME__
+<syntaxhighlight lang="Lua>
+if IsValidObject(objectid) then
+    DestroyObject(objectid)
+end
+</syntaxhighlight>
 {{RelatedFunctions}}
-__EDIT_ME__
+{{Template:ObjectFunctions}}