Difference between revisions of "TeleportEntity"

From Nomad DB
m
m
Line 7: Line 7:
 
* '''targetEntityId''' (string): [[EntityId|ID]] of the entity to be teleported
 
* '''targetEntityId''' (string): [[EntityId|ID]] of the entity to be teleported
 
* '''destinationEntityId''' (string): [[EntityId|ID]] of the entity to teleport to
 
* '''destinationEntityId''' (string): [[EntityId|ID]] of the entity to teleport to
* '''useLoadingScreen''' (boolean): Whether to show a loading screen if the player teleports into a new map area
+
* '''useLoadingScreen''' (number): Whether to show a loading screen if the player teleports into a new map area (0 = false; 1 = true)
* '''useFadeToBlack''' (boolean): Whether to use a fade to black animation before teleporting the player
+
* '''useFadeToBlack''' (number): Whether to use a fade to black animation before teleporting the player (0 = false; 1 = true)
  
 
== Example ==
 
== Example ==
Line 16: Line 16:
  
 
== Related Pages ==
 
== Related Pages ==
 +
* [[Entity]]
 
* [[EntityId]]
 
* [[EntityId]]
  
 
[[Category:WD2 Lua]] [[Category: WD2 Entity]]
 
[[Category:WD2 Lua]] [[Category: WD2 Entity]]

Revision as of 20:11, 16 April 2020

Teleports the target entity to the destination entity.

Syntax

TeleportEntity(targetEntityId, destinationEntityId, useLoadingScreen, useFadeToBlack)
  • targetEntityId (string): ID of the entity to be teleported
  • destinationEntityId (string): ID of the entity to teleport to
  • useLoadingScreen (number): Whether to show a loading screen if the player teleports into a new map area (0 = false; 1 = true)
  • useFadeToBlack (number): Whether to use a fade to black animation before teleporting the player (0 = false; 1 = true)

Example

TeleportEntity(GetLocalPlayerEntityId(), "2083162933598368435", 0, 0)

Related Pages