Verse API reference page for the teleporter_device class | Fortnite Documentation

Customizable rift that allows agents and creative_props to move instantly between locations. You can use this to move players around your island, or create multi-island experiences with teleporters that take players from one island to another.


Verse `using` statement	`using { /Fortnite.com/Devices }`

Inheritance Hierarchy

This class is derived from the following hierarchy, starting with creative_object:

Name	Description
`creative_object`	Base class for creative devices and props.
`creative_device_base`	Base class for creative_device.

Exposed Interfaces

This class exposes the following interfaces:

Name	Description
`enableable`	Implemented by classes whose instances can be enabled and disabled.

Members

This class has both data members and functions.

Data

Data Member Name	Type	Description
`EnterEvent`	`listenable(payload)`	Signaled when an `agent` enters this device. Sends the `agent` that entered this device.
`EnterPropEvent`	`listenable(payload)`	Signaled when a 'creative_prop' enters this device. Sends the 'creative_prop' that entered this device.
`TeleportedEvent`	`listenable(payload)`	Signaled when an `agent` emerges from this device. Sends the `agent` that emerged from this device.
`TeleportPropEvent`	`listenable(payload)`	Signaled when a `creative_prop` emerges from this device. Sends the `creative_prop` that emerged from this device.

Functions

Function Name	Description
`Activate`	Teleport `Agent` to the target group using this device.
`Activate`	Teleport `Prop` to the target group using this device.
`ActivateLinkToTarget`	When a link is activated, the current destination teleporter will be able to bring the `agent` back to this origin teleporter. Both origin and destination teleporters need to have this activated to work as expected.
`AddTag`	Adds a `tag` instance to this object. Returns a `tag_key` that is uniquely associated with the added instance.
`ContainsAllTags`	Fails if at least one type in `tag_types` cannot be found on this object, succeeds otherwise. Note that this means that if `tag_types` is empty this call succeeds.
`ContainsAnyTag`	Succeeds if at least one of the types in `tag_types` is found on this object, fails otherwise. Note that this means that if `tag_types` is empty this call fails.
`ContainsTag`	Succeeds if at least one tag of type `tag_type` is found on this object, fails otherwise.
`DeactivateLinkToTarget`	Deactivates any currently active Link. The current destination teleporter will no longer be able to return the agent to this origin teleporter.
`Disable`
`Enable`
`GetGlobalTransform`	Gets the global transform of this object.
`GetTransform`	Returns the transform of the `creative_object` with units in cm. You must check `creative_object.IsValid` before calling this if there is a possibility the object has been disposed or destroyed by gameplay. Otherwise a runtime error will result.
`IsEnabled`
`MoveTo`	Moves the `creative_object` to the specified `Position` and `Rotation` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`MoveTo`	Moves the `creative_object` to the specified `Transform` over the specified time, in seconds. If an animation is currently playing on the `creative_object` it will be stopped and put into the `AnimationNotSet` state.
`MoveTo`	Moves the `creative_device` to the specified `Transform` over the specified time, in seconds. If an animation is currently playing on the `creative_device` it will be stopped and put into the `AnimationNotSet` state.
`RemoveAllTags`	Removes all tag instances of type `tag_type`, succeeds if at least one instance was removed, fails otherwise.
`RemoveAllTagsExcept`	Removes all tag instances that are not of type `tag_type`, succeeds if at least one instance was removed, fails otherwise.
`RemoveAllTagsExcept`	Removes all tag instances that are not of any of the types in `tag_types`, succeeds if at least one instance was removed, fails otherwise.
`RemoveTag`	Removes the tag instance associated with the `tag_key`, succeeds if an instance was removed, fails otherwise.
`ResetLinkToTarget`	Resets the currently selected destination teleporter, and selects an eligible destination. If the target is a Teleporter Group, this may be another randomly chosen `teleporter_device` from that group.
`SetGlobalTransform`	Sets the global transform of this object.
`Teleport`	Teleport `Agent` to this device.
`Teleport`	Teleport `Prop` to this device.
`TeleportTo`	Teleports the `creative_object` to the specified `Position` and `Rotation`.
`TeleportTo`	Teleports the `creative_object` to the specified location defined by `Transform`, also applies rotation and scale accordingly.
`TeleportTo`	Teleports the `creative_device` to the specified location defined by `Transform`, also applies rotation and scale accordingly.