SetObjectMoveTo: Difference between revisions

From Onset Developer Wiki
(Created page with "{{Info|Function|Server|1.0}} {{FuncDescription|__EDIT_ME__}} {{FuncSyntax|SetObjectMoveTo(object, x, y, z [, speed])}} {{FuncParameters}} {{FuncParam|object|__EDIT_ME__}} {...")
 
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Server|1.0}}
{{Info|Function|Server|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Set the object to move to the specified coordinates.}}


{{FuncSyntax|SetObjectMoveTo(object, x, y, z [, speed])}}
{{FuncSyntax|SetObjectMoveTo(object, x, y, z [, speed])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|object|__EDIT_ME__}}
{{FuncParam|object|The object identifier.}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|The X axis}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|The Y axis}}
{{FuncParam|z |__EDIT_ME__}}
{{FuncParam|z|The Z axis}}
{{FuncParamOptional|speed|__EDIT_ME__}}
{{FuncParamOptional|speed|The speed as a floating point number. (Centimeter per second)}}


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


== Example ==
== Example ==
__EDIT_ME__
<syntaxhighlight lang="Lua>
SetObjectMoveTo(object, 100, 100, 100, 2)
</syntaxhighlight>


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

Latest revision as of 14:32, 26 June 2021

SetObjectMoveTo

Type: Function
Context: Server
Introduced: v1.0

Description

Set the object to move to the specified coordinates.

Syntax

SetObjectMoveTo(object, x, y, z [, speed])

Parameters

  • object
    The object identifier.
  • x
    The X axis
  • y
    The Y axis
  • z
    The Z axis
  • speed (optional)
    The speed as a floating point number. (Centimeter per second)

Return Value

  • Returns true on success.

Example

SetObjectMoveTo(object, 100, 100, 100, 2)

See also

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