Warper Object

Warper

Description

This Level Object is used to warp the Player to a specified destination outside the current level. It can warp the player to a different floor in the Dungeon or to a different Dungeon entirely.

Location

Right-click on an empty space in the Layout Scene Manager and choose Logic > Warper from the list.

Properties

Name	Type	Description	Read Only
ORIENTATION
FORWARD	CVector3	Forward by X,Y,Z.
RIGHT	CVector3	Right by X,Y,Z.
UP	CVector3	Up by X,Y,Z.
POSITION
POSITION	CVector3	Position by X, Y, Z world coordinates.
PROPERTIES
DUNGEON NAME	string	Set the Dungeon to warp to.
ENABLED	bool	Set the Warper enabled or disabled.
LEVEL ABSOLUTE	int	Set the absolute floor depth to warp the Player to.
LEVEL DELTA	int	Set the number of floors up or down to warp the player to. Negative values warp the Player up while positive values warp the Player down.
VISIBLE	bool	Set the Warper visible or not.
WARP NAME	string	The warp name to look for on the level warping to.
WARP OUT OF DUNGEON	bool	If True the Warper will warp the Player out of the current Dungeon. Note: This overrides "Level Absolute" and "Level Delta".
WAYPOINT	bool	If True the Warper activates a Waypoint.

Input Events

Show

Set the Warper object to be visible.

Hide

Set the Warper object to be invisible.

Activate Warper

Warp the Player to the specified destination.

Enable

Enable the Warper object.

Disable

Disable the Warper object.

Output Events

On Visible

This event will be fired when the Warper object receives a "Show" Input event.

On Invisible

This event will be fired when the Warper object receives a "Hide" Input event.