SetDoorLocation: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
{{FuncDescription|Teleports a door to a specified location.}}
{{FuncDescription|Teleports a door to a specified location.}}


{{FuncSyntax|SetDoorLocation(door, x, y, z)}}
{{FuncSyntax|SetDoorLocation(door, x, y, z, rotation)}}


{{FuncParameters}}
{{FuncParameters}}
Line 10: Line 10:
{{FuncParam|y|World Y location.}}
{{FuncParam|y|World Y location.}}
{{FuncParam|z|World Z location.}}
{{FuncParam|z|World Z location.}}
{{FuncParam|rotation|The yaw rotation of this door.}}


{{FuncReturnValue|Returns '''true''' on success. '''false''' if the door does not exist.}}
{{FuncReturnValue|Returns '''true''' on success. '''false''' if the door does not exist.}}
Line 15: Line 16:
== Example ==
== Example ==
<syntaxhighlight lang="Lua">
<syntaxhighlight lang="Lua">
SetDoorLocation(doorId, 0.0, 0.0, 0.0)
SetDoorLocation(doorId, 0.0, 0.0, 0.0, 90.0)
</syntaxhighlight>
</syntaxhighlight>


{{RelatedFunctions}}
{{RelatedFunctions}}
{{DoorFunctions}}
{{DoorFunctions}}

Latest revision as of 10:15, 1 July 2021

SetDoorLocation

Type: Function
Context: Server
Introduced: v1.0

Description

Teleports a door to a specified location.

Syntax

SetDoorLocation(door, x, y, z, rotation)

Parameters

  • door
    The door identifier.
  • x
    World X location.
  • y
    World Y location.
  • z
    World Z location.
  • rotation
    The yaw rotation of this door.

Return Value

  • Returns true on success. false if the door does not exist.

Example

SetDoorLocation(doorId, 0.0, 0.0, 0.0, 90.0)

See also