IsObjectMoving: Difference between revisions

Latest revision as of 21:42, 23 May 2024

This function checks if an object is moving.

ADDED/UPDATED IN VERSION 1.6.0 r22430:

This function is now also available on the server side.

Syntax

bool isObjectMoving ( object theObject )

OOP Syntax Help! I don't understand this!

Method: object:isMoving(...)

Variable: .moving

Required Arguments

theObject: The object element.

Returns

Returns true if the object is moving, false otherwise.

Example

This example creates an object when the resource starts and checks if the object is moving:

addEventHandler ("onClientResourceStart", resourceRoot,
    function ()
        local x, y, z = getElementPosition (localPlayer)
        object = createObject (1239, x, y, z)

        moveObject (object, 5000, x, y, z + 5)
    end
)

addCommandHandler ("getmoving",
    function (commandName)
        outputChatBox ("Is object "..(isObjectMoving(object) and "moving" or "not moving"))
    end
)

Requirements

Minimum server version	1.6.0-9.22430
Minimum client version	1.5.8-9.20811

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.6.0-9.22430" client="1.5.8-9.20811" />

@@ Line 1: / Line 1: @@
-#REDIRECT [[IsElementMoving]]
+__NOTOC__
+{{Shared function}}
+{{Added feature/item|1.5.9|1.5.8|20811|This function checks if an [[object]] is moving.}} {{New feature/item|3.0161|1.6.0|22430|This function is now also available on the server side.}}
+==Syntax==
+<syntaxhighlight lang="lua">bool isObjectMoving ( object theObject )</syntaxhighlight>
+{{OOP||[[object]]:isMoving|moving}}
+===Required Arguments===
+*'''theObject:''' The [[object]] [[element]].
+===Returns===
+* Returns ''true'' if the [[object]] is moving, ''false'' otherwise.
+==Example==
+This example creates an object when the resource starts and checks if the object is moving:
+<syntaxhighlight lang="lua">
+addEventHandler ("onClientResourceStart", resourceRoot,
+    function ()
+        local x, y, z = getElementPosition (localPlayer)
+        object = createObject (1239, x, y, z)
+        moveObject (object, 5000, x, y, z + 5)
+    end
+)
+addCommandHandler ("getmoving",
+    function (commandName)
+        outputChatBox ("Is object "..(isObjectMoving(object) and "moving" or "not moving"))
+    end
+)
+</syntaxhighlight>
+==Requirements==
+{{Requirements|1.6.0-9.22430|1.5.8-9.20811|}}
+==See Also==
+{{Client_object_functions}}