WarpDoor

┗> Event > Object > Class


Warp Doors allow for fast travel between Overworld locations.
WarpDoor is an Event - naming an object warpdoor on an objects layer in a map creates this object.
See this object's Fields for the configurable properties on this object.


Constructor


WarpDoor(x: number, y: number, properties: number)

Arguments:

x: number
y: number
properties: number




Methods


WarpDoor:onInteract(chara: Player, facing: string)

Arguments:

chara: Player

The character controlled by the player when in the Overworld.

facing: string

Returns:

1: boolean


WarpDoor:updateOpen()

Updates the state of the door based on its open_flag, and accordingly adjusts it's own sprite and its light




Fields



WarpDoor.flags: string[]

[Property list flag] A list of flags checked to decide whether a map can be warped to


WarpDoor.light: Sprite

Sprite instance for the light that appears under an active door


WarpDoor.maps: string[]

[Property list map] A list of available maps to travel to


WarpDoor.markers: string[]

[Property list marker] A list of markers used when warping to each map


WarpDoor.names: string[]

[Property list name] A list of display names for each map in the warp choice


WarpDoor.open: boolean

[Property open] Whether the door is open (Defaults to true)


WarpDoor.open_flag: string

[Property openflag] The name of a flag that will be used to control the state of the door