World

@param map — The optional name of a map to initially load with the world

Runs whenever the menu is closed

Enables following for all of the player's current followers and causes them to walk to their positions

@param return_speed — The walking speed of the followers while they return to the player

Enables following for all of the player's current followers, and immediately teleports them to their positions

Checks whether the input collider is colliding with anything in the world

@param collider — The collider to check collision for

@param enemy_check — Whether to include the enemy collision map in the check

@return collided — Whether a collision was found

@return with — The object that was collided with

Closes the menu

Creates the main overworld menu if it does not exist
The event createMenu is called by this function, which can return a custom menu to use instead of the default Light/Dark menu

Disables following for all of the player's current followers

Fades the world out and into another piece of content

@param callback — The callback that is run in the middle of the fade (fully faded out) to load the next piece of content

Gets the action box instance for a member of the party

Gets the object that the camera is currently targetting

Gets the value of a cell flag (a special flag which normally starts at -1 and increments by 1 at the start of every call, named after the call cutscene)

Gets a specific character currently present in the world

@param id — The actor id of the character to search for

@param index — The character's index, if they have multiple instances in the world. (Defaults to 1)

@return chara — The character instance, or nil if it was not found

Gets the collision map for the world

@param enemy_check — Whether to include the enemy collision map (defaults to false)

Gets a specific event present in the current map

@param id — The unique numerical id of an event OR the text id of an event type to get the first instance of

@return event — The event instnace, or nil if it was not found

Gets a list of all instances of one type of event in the current maps

@param name — The text id of the event to search for, fetches every event if nil

@return events — A table containing every instance of the event in the current map

Gets the Character in the world of a party member

@param party — The party member to get the character for

Gets the Follower or Player of a character currently in the party

@param party — The party member to get the character for

Whether the world has a currently active cutscene

Heals a member of the party

@param target — The party member to heal

@param amount — The amount of HP to restore

@param text — An optional text to display when HP is resotred in the Light World, before the HP restoration message

Hides party member health bars

Hurts the party member battler by amount, or hurts the whole party for amount

@param battler — The Character to hurt

@param amount — The amount of damage to deal

@return killed — Whether all targetted characters were knocked out by this damage

Whether the player is currently in a world battle

Checks whether there is currently a textbox open

Loads into a new map file.

@param map — The name of the map file to load

@param x — The x-coordinate the player will spawn at in the new map

@param y — The y-coordinate the player will spawn at in the new map

@param marker — The name of the marker the player will spawn at in the new map (Defaults to "spawn")

@param facing — The direction the party should be facing when they spawn in the new map

@param callback — A callback to run once the map has finished loading (Post Map:onEnter())

@param ... — Additional arguments that will be passed forward into Map:onEnter()

Loads a new map and starts the transition effects for world music, borders, and the screen as a whole

@param ... — Additional arguments that will be passed into World:loadMap() See: World - World:loadMap()

Called whenever the state of the world changes

Opens the main overworld menu

@param menu — An optional menu instance to open

@param layer — The layer to create the menu on (defaults to WORLD_LAYERS["ui"] or 600)

Parses a variable-type layer specification into a recognised layer

Creates a reaction text on a party member's healthbar (usually used for equipment and items)

@param party_member — The party member who will react

@param text — The text to display for the reaction

@param display_time — The display time, in seconds, of the reaction (defaults to 5/3 seconds)

Registers a phone call in the Light World CELL menu

@param name — The name of the call as it will show in the CELL menu

@param scene — The cutscene to play when the call is selected

Removes a follower

@param chara — The Follower or the follower's actor id to remove

@return follower — The follower that was removed

Replaces a phone call in the Light World CELL menu with another

@param name — The name of the call as it will show in the CELL menu

@param index — The index of the call to replace

@param scene — The cutscene to play when the call is selected

Sets whether the player is currently in battle - cannot override being inside a battle area

Sets whether the camera should be attached to its target for each axis

@param attached_x — Whether the camera's x-axis position should follow its target

@param attached_y — Whether the camera's y-axis position should follow its target

Sets whether the camera should follow its target on the x-axis

Sets whether the camera should follow its target on the y-axis

Sets the object the camera should target

Sets the value of a cell flag (a special flag which normally starts at -1 and increments by 1 at the start of every call, named after the call cutscene)

@param name — The name of the flag to set

@param value — The value to set the flag to

Changes the state of the world

Sets up several variables for a new map

@param map — The Map object, name, or data to load

@param ... — Additional arguments that will be passed forward into Map:onEnter()

Transitions from the world into a shop

@param shop — The shop to enter

@param options — An optional table of leave_options for exiting the shop

Shows party member health bars

Shows a textbox with the input text

@param after — A callback to run when the textbox is closed, receiving the cutscene instance used to display the text

Spawns a new WorldBullet to the world

@param bullet — The bullet to add to the world, if left unspecified, spawns the basic WorldBullet

@param ... — Additional arguments to pass to the bullet's init() function

@return bullet — The newly created bullet

Spawns a follower into the world

@param chara — The character to spawn as a follower

@param options — A table defining additional properties to control the new follower

options:
    | "x" -- The position of the follower
    | "y" -- The position of the follower
    | "index" -- The index of the follower in the list of followers
    | "temp" -- Whether the follower is temporary and disappears when the current map is exited (defaults to `true`)
    | "party" -- The id of the party member associated with this follower

Spawns a new NPC object in the world

@param actor — The actor to use for the new NPC, either an id string or an actor object

@param x — The x-coordinate to place the NPC at

@param y — The y-coordinate to place the NPC at

@param properties — A table of additional properties for the new NPC. Supports all the same values as an npc map event

@return npc — The newly created npc.

Spawns an object to the world

@param obj — The object to add to the world

@param layer — The layer to place the object on

Spawns characters in the world for the current party

@param marker — The marker or co-ordinates to spawn the player at

@param party — A table of party members to spawn (Defaults to Game.party)

@param extra — Additional followers to add that are not in the party (defaults to Game.temp_followers)

@param facing — The direction the party should be facing when they spawn

facing:
    | "up"
    | "down"
    | "left"
    | "right"

Spawns the player into the world

@param ... — Arguments detailing how the player spawns

@param party — The party member ID associated with the player

...(param):
    | "x, y, chara" -- The co-ordinates of the player spawn and the Actor (instance or id) to use for the player
    | "marker, chara" -- The marker name to spawn the player at and the Actor (instance or id) to use for the player

Starts a cutscene in the world

@param group — The name of the group the cutscene is a part of

@param id — The id of the cutscene

@param ... — Additional arguments that will be passed to the cutscene function

@return The — cutscene object that was created

Stops the current cutscene
An error will be thrown when trying to stop a cutscene if none are active

Transitions the music from the current track to the next

@param music — The name of the file to play next

@param next — The filename, volume, and pitch of the next track

@param fade_out — Whether to fade out the currently playing track before playing the next track

The current alpha value of world battle content

(unused? See Map.battle_borders)

A table of currently active bullets

A list of calls available on the cell phone in the Light World CELL menu

The camera object used to display the world

Whether the player can open their menu

The object that all controllers are parented to

The WorldCutscene object of the currently active cutscene, if present

(Used internally) Timer variable for door transition sounds

A table of all followers currently present in the world

Whether the player is currently in a world battle set through `World:setBattle() (affects the visibility of world battle content)

Whether the player is currently standing inside a battlearea of the map (affects the visibility of world battle content)

The currently loaded map instance

The Menu object of the menu, if it is open

The Music instance that controls audio playback for this World

The player character

The soul of the player

The current state that this World is in - should never be set manually, see World:setState() instead

An object that manages the state of this World

(unused?)

Always sort