RespawnObject: Difference between revisions

Latest revision as of 12:10, 4 September 2024

This function respawns a specific object.

ADDED/UPDATED IN VERSION 1.6.0 r22708:

This function is now also available on the server side.

bool respawnObject ( object theObject )

OOP Syntax Help! I don't understand this!

Method: object:respawn(...)

This example prevents objects from despawning. When an object breaks, it gets respawned right away.

addEventHandler ( "onClientObjectBreak", getRootElement(),
    function ()
        respawnObject ( source )
    end
)

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{client function}}
+{{Shared function}}
 This function respawns a specific object.
-Note: Only breakable objects can respawn.
+{{New feature/item|3.0161|1.6.0|22708|This function is now also available on the server side.}}
 ==Syntax==
-<syntaxhighlight lang="lua">bool respawnObject ( theObject )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool respawnObject ( object theObject )</syntaxhighlight>
+{{OOP||[[object]]:respawn}}
 ===Required Arguments===
-*'''theObject:''' A [[object]] element
+*'''theObject:''' an [[object]] element
 ===Returns===
-Returns 'true' if the object sucessfully respawned.
+* ''true'' if the object was sucessfully respawned.
-'false' if the object is not breakable, or a wrong object was given.
+* ''false'' if the object is not breakable, or a wrong object was given.
+==Example==
+This example prevents objects from despawning. When an object breaks, it gets respawned right away.
+<syntaxhighlight lang="lua">
+addEventHandler ( "onClientObjectBreak", getRootElement(),
+    function ()
+        respawnObject ( source )
+    end
+)</syntaxhighlight>
 ==See Also==
-{{Client_object_functions}}
+{{Shared_object_functions}}