Interface Scene

Represents a scene in the LBA game. Provides access to the scene life cycle events. Allows to do the scene setup operations with objects, zones and waypoints. Provides access to the LBA2 classic scene and game variables.

This object is globally accessible through scene.

interface Scene {
    Events: SceneEvents;
    GameVariables: GameVariables;
    LoadModes: SceneLoadModes;
    objects: GameObject[];
    waypoints: number[][];
    zones: Zone[];
    addEventListener(
        event: "beforeLoadScene",
        callback: BeforeLoadSceneCallback,
        name?: string,
    ): void;
    addEventListener(
        event: "afterLoadScene",
        callback: AfterLoadSceneCallback,
        name?: string,
    ): void;
    addEventListener(
        event: "afterLoadSavedState",
        callback: AfterLoadSavedStateCallback,
        name?: string,
    ): void;
    addObjects(count?: number): number;
    addWaypoints(count?: number): number;
    addZones(count?: number): number;
    findFreeZoneValue(zoneType: ZoneType, exceptZoneId?: number): number;
    getCurrentMoney(): number;
    getForeignMoney(): number;
    getGameVariable(variableIndex: number): number;
    getGold(): number;
    getId(): number;
    getIsland(): number;
    getMagicLevel(): number;
    getMagicPoints(): number;
    getNumKeys(): number;
    getNumObjects(): number;
    getNumWaypoints(): number;
    getNumZones(): number;
    getObject(objectIndex: number): GameObject;
    getPlanet(): number;
    getStartPos(): number[];
    getVariable(variableIndex: number): number;
    getWaypoint(waypointIndex: number): number[];
    getZlitos(): number;
    getZone(zoneIndex: number): Zone;
    removeEventListener(
        event: AllSceneEvents,
        callbackOrName: string | ((...args: any[]) => void),
    ): void;
    setCurrentMoney(amount: number): void;
    setForeignMoney(amount: number): void;
    setGameVariable(variableIndex: number, value: number): void;
    setGold(amount: number): void;
    setStartPos(pos: number[]): void;
    setVariable(variableIndex: number, value: number): void;
    setZlitos(amount: number): void;
    updateWaypoint(id: number, pos: number[]): void;
    _setLoadHandler(callback: (json: string) => void): void;
    _setSaveHandler(callback: (isBackupSave: boolean) => string | void): void;
}

Properties

Events

Events: SceneEvents

All the possible scene events.

GameVariables

GameVariables: GameVariables

Special game variables: vanilla inventory items, chapter, etc. The sceneric game variables, used to control the game state, are not in this enum.

LoadModes

LoadModes: SceneLoadModes

All the possible scene load modes (why the scene is being loaded).

`Readonly`objects

objects: GameObject[]

An iterable property that allows iteration over all objects (actors) in the scene. This provides a convenient way to iterate through all scene objects using for...of loops. Also provides length property and [index] operator.

Example

for (const obj of scene.objects) {
  console.log(obj.getId());
}
scene.objects.length; // The same as scene.getNumObjects()
scene.objects[0]; // The same as scene.getObject(0)

`Readonly`waypoints

waypoints: number[][]

An iterable property that allows iteration over all waypoints in the scene. This provides a convenient way to iterate through all scene waypoints using for...of loops. Also provides length propery and [index] operator.

Returns

An array of waypoints, each represented as an array of three numbers (x, y, z).

Example

for (const waypoint of scene.waypoints) {
  console.log(waypoint); // [x, y, z] coordinates
}
scene.waypoints.length; // The same as scene.getNumWaypoints()
scene.waypoints[0]; // The same as scene.getWaypoint(0)

`Readonly`zones

zones: Zone[]

An iterable property that allows iteration over all zones in the scene. This provides a convenient way to iterate through all scene zones using for...of loops. Also provides length propery and [index] operator.

Example

for (const zone of scene.zones) {
  console.log(zone.getType());
}
scene.zones.length; // The same as scene.getNumZones()
scene.zones[0]; // The same as scene.getZone(0)

Methods

addEventListener

addEventListener(
    event: "beforeLoadScene",
    callback: BeforeLoadSceneCallback,
    name?: string,
): void
Subscribe to beforeLoadScene event. This event is called right before a scene is loaded by any reason.
Parameters
- event: "beforeLoadScene"
  Must be SceneEvents.beforeLoadScene
- callback: BeforeLoadSceneCallback
  The callback that receives the arguments.
- Optionalname: string
  A name can be given to the event listener to unregister it later.
Returns void
- Defined in scene.d.ts:383
addEventListener(
    event: "afterLoadScene",
    callback: AfterLoadSceneCallback,
    name?: string,
): void
Subscribe to afterLoadScene event.

This is the main entry point for the mod for each particular scene.

This event is called right after the scene is fully loaded from SCENE.hqr, but before any previously saved game state is applied.

This is called when new game is started, when game is loaded, and also during the game, when you move between scenes.

In this call the scene state is allowed to be modified.

Use this call to setup everything in your mode: modify scene objects, zones, variables, as if the HQR file itself would have contained the desired modifications.

Also in this call you will have to register life handlers, coroutines and do other mod initializations.

See Samples for examples of usage of this event.
Parameters
- event: "afterLoadScene"
  Must be SceneEvents.afterLoadScene
- callback: AfterLoadSceneCallback
  The callback that receives the arguments.
- Optionalname: string
  A name can be given to the event listener to unregister it later.
Returns void
- Defined in scene.d.ts:410
addEventListener(
    event: "afterLoadSavedState",
    callback: AfterLoadSavedStateCallback,
    name?: string,
): void
Subscribe to afterLoadSavedState event.

This event is called right after the game is loaded from a save file or a backup state.
Parameters
- event: "afterLoadSavedState"
  Must be SceneEvents.afterLoadSavedState
- callback: AfterLoadSavedStateCallback
  The callback of the event
- Optionalname: string
  A name can be given to the event listener to unregister it later.
Returns void
Warning
Only use this if you know what you are doing.

This is called only when the game is loaded from a saved state, not when a new game is started or when moving between scenes.

If the game is loaded, this is called after SceneEvents.afterLoadScene event, so at this point, any modifications you might have made to the scene objects, zones, and variables in the SceneEvents.afterLoadScene, will have been overwritten by the saved game state.
- Defined in scene.d.ts:432

addObjects

addObjects(count?: number): number
Adds one or several new GameObjects (actors) to the scene. The objects will be added at the end of the scene objects list. The objects will be initialized with default values, so you need to set its properties before using it.
Parameters
- Optionalcount: number
  The number of objects to add. If not specified, it will try to add one object.
Returns number
The id of the first added object. The subsequent objects will have consecutive ids (i.e., firstId + 1, firstId + 2, etc.)
- Defined in scene.d.ts:354

addWaypoints

addWaypoints(count?: number): number
Adds one or several new waypoints to the scene. The waypoints will be added at the end of the scene waypoints list. The waypoints will be initialized with zeros, so you need to call Scene.updateWaypoint to set their positions before using them.
Parameters
- Optionalcount: number
  The number of waypoints to add. If not specified, it will try to add one waypoint.
Returns number
The id of the first added waypoint. The subsequent waypoints will have consecutive ids (i.e., firstId + 1, firstId + 2, etc.)
- Defined in scene.d.ts:374

addZones

addZones(count?: number): number
Adds one or several new Zones to the scene. The zones will be added at the end of the scene zones list. The zones will be initialized with zeros, so you need to set its properties before using it.
Parameters
- Optionalcount: number
  The number of zones to add. If not specified, it will try to add one zone.
Returns number
The id of the first added zone. The subsequent zones will have consecutive ids (i.e., firstId + 1, firstId + 2, etc.)
- Defined in scene.d.ts:364

findFreeZoneValue

findFreeZoneValue(zoneType: ZoneType, exceptZoneId?: number): number
Returns the first unused zone value (zone number) for the given zone type.

The zone value are used in the script commands for sceneric, camera, ladder, and other zones.

One zone value can be assigned to one or multiple zones of a particular type, so they act the same way, as a group of zones.
Parameters
- zoneType: ZoneType
  The type of the zone to find a free value for
- OptionalexceptZoneId: number
  The ID of a zone to exclude from the search
Returns number
- Defined in scene.d.ts:456

getCurrentMoney

getCurrentMoney(): number
Returns the amount of current planet's money the hero has. If the hero is on Twinsun, this returns Gold. If on Zeelich, this returns Zlitos. This is the currency displayed in the main hero menu.

Returns number
The amount of current planet's currency
- Defined in scene.d.ts:491

getForeignMoney

getForeignMoney(): number
Returns the amount of foreign planet's money the hero has. If the hero is on Twinsun, this returns Zlitos. If on Zeelich, this returns Gold. This currency is displayed as an inventory item.

Returns number
The amount of foreign planet's currency
- Defined in scene.d.ts:499

getGameVariable

getGameVariable(variableIndex: number): number
Returns a game variable value by its index The game variables (aka VAR_GAME) are used by the original game scripts in the scope of the whole game. They are not reset when the scene is reloaded, or when navigating between scenes.

The whole legacy inventory of the game is managed by the game variables, as well as current chapter, and some other game states.
Parameters
- variableIndex: number
  The index of the variable to get from 0 to 255
Returns number
See
GameVariables
- Defined in scene.d.ts:301

getGold

getGold(): number
Returns the amount of Gold (Twinsun currency) the hero currently has.

Returns number
The amount of gold in the hero's possession
- Defined in scene.d.ts:477

getId

getId(): number
Returns the current scene ID.

Returns number
- Defined in scene.d.ts:461

getIsland

getIsland(): number
Returns the current island ID.

Returns number
- Defined in scene.d.ts:466

getMagicLevel

getMagicLevel(): number
Returns the current magic level of the hero. To change this value use Life script commands.

Returns number
The current magic level of the hero
- Defined in scene.d.ts:541

getMagicPoints

getMagicPoints(): number
Returns the current magic points of the hero. To change this value use Life script commands.

Returns number
The current magic points of the hero
- Defined in scene.d.ts:548

getNumKeys

getNumKeys(): number
Returns the number of the small keys the hero has. To change this value use Life script commands.

Returns number
The number of keys the hero has
- Defined in scene.d.ts:534

getNumObjects

getNumObjects(): number
Returns the number of the current scene objects, if the scene is loaded.

Returns number
- Defined in scene.d.ts:236

getNumWaypoints

getNumWaypoints(): number
Returns the number of waypoints in the current scene. The waypoints are used by the original game scripts to navigate.

Returns number
- Defined in scene.d.ts:247

getNumZones

getNumZones(): number
Returns the number of the current scene zones, if the scene is loaded.

Returns number
- Defined in scene.d.ts:241

getObject

getObject(objectIndex: number): GameObject
Returns a scene GameObject at the given index. The index is zero-based. The player object is 0. The NitroMecaPingouin is 1.
Parameters
- objectIndex: number
  The index of the object to get.
Returns GameObject
The object at the given index.
- Defined in scene.d.ts:256

getPlanet

getPlanet(): number
Returns the current planet ID.

Returns number
- Defined in scene.d.ts:471

getStartPos

getStartPos(): number[]
Returns the start position of the player in the current scene. The start position is used in the new game or if player teleports to this scene.

Returns number[]
Array of 3 values representing the position as [x, y, z]
- Defined in scene.d.ts:281

getVariable

getVariable(variableIndex: number): number
Returns a scene variable value by its index The scene variables (aka VAR_CUBE) are used by the original game scripts in the scope of the current scene. They reset to their default values when the scene is reloaded (also when navigating between scenes).
Parameters
- variableIndex: number
  The index of the variable to get from 0 to 79
Returns number
- Defined in scene.d.ts:289

getWaypoint

getWaypoint(waypointIndex: number): number[]
Returns a waypoint from the scene, at the given index. The index is zero-based.
Parameters
- waypointIndex: number
  The index of the waypoint to get.
Returns number[]
The waypoint at the given index as an array of three numbers (x, y, z).
- Defined in scene.d.ts:274

getZlitos

getZlitos(): number
Returns the amount of Zlitos (Zeelich currency) the hero currently has.

Returns number
The amount of zlitos in the hero's possession
- Defined in scene.d.ts:483

getZone

getZone(zoneIndex: number): Zone
Returns a Zone from the scene, at the given index. The index is zero-based.
Parameters
- zoneIndex: number
  The index of the zone to get.
Returns Zone
The zone at the given index.
- Defined in scene.d.ts:265

removeEventListener

removeEventListener(
event: AllSceneEvents,
callbackOrName: string | ((...args: any[]) => void),
): void
Unregisters a previously registered event callback.
Parameters
- event: AllSceneEvents
- callbackOrName: string | ((...args: any[]) => void)
Returns void
- Defined in scene.d.ts:441

setCurrentMoney

setCurrentMoney(amount: number): void
Sets the amount of current planet's money the hero has. If the hero is on Twinsun, this sets Gold. If on Zeelich, this sets Zlitos. This is the currency displayed in the main hero menu.
Parameters
- amount: number
  The amount of current planet's currency to set
Returns void
- Defined in scene.d.ts:519

setForeignMoney

setForeignMoney(amount: number): void
Sets the amount of foreign planet's money the hero has. If the hero is on Twinsun, this sets Zlitos. If on Zeelich, this sets Gold. This currency is displayed as an inventory item.
Parameters
- amount: number
  The amount of foreign planet's currency to set
Returns void
- Defined in scene.d.ts:527

setGameVariable

setGameVariable(variableIndex: number, value: number): void
Sets a game variable value by its index.
Parameters
- variableIndex: number
  The index of the variable to set from 0 to 255
- value: number
  The value to set the variable to, from -32,768 to 32,767
Returns void
Warning
Only use it to read / set inventory and existing LBA game variables in order to integrate your mod with the rest of the game.

Do not create new game variables for your mod, using this function! Use the javascript store variables instead to persist your mod state.
- Use useGameStore to create and manage your IdaJS game variables.
The classic game variables (aka VAR_GAME) are used by the original game scripts in the scope of the whole game. They are not reset when the scene is reloaded, or when navigating between scenes.

The whole legacy inventory of the game is managed by the game variables, as well as current chapter, and some other game states.
See
GameVariables
- Defined in scene.d.ts:344

setGold

setGold(amount: number): void
Sets the amount of Gold (Twinsun currency) the hero has.
Parameters
- amount: number
  The amount of gold to set
Returns void
- Defined in scene.d.ts:505

setStartPos

setStartPos(pos: number[]): void
Sets a start position of the hero The start position is used in the new game or if player teleports to this scene.
Parameters
- pos: number[]
  Array of 3 values representing the position as [x, y, z]
Returns void
- Defined in scene.d.ts:308

setVariable

setVariable(variableIndex: number, value: number): void
Sets a scene variable value by its index.
Parameters
- variableIndex: number
  The index of the variable to set from 0 to 79
- value: number
  The value to set the variable to, from 0 to 255
Returns void
Warning
You should not use this for your new variables in the mods. Use the javascript variables instead:
- Use useSceneStore to create and manage your IdaJS scene-specific mod variables.
The classic scene variables (aka VAR_CUBE) are used by the original game scripts in the scope of the current scene.

They reset to their default values when the scene is reloaded (also when navigating between scenes).
- Defined in scene.d.ts:323

setZlitos

setZlitos(amount: number): void
Sets the amount of Zlitos (Zeelich currency) the hero has.
Parameters
- amount: number
  The amount of zlitos to set
Returns void
- Defined in scene.d.ts:511

updateWaypoint

updateWaypoint(id: number, pos: number[]): void
Updates the position of a waypoint in the scene. Any changes to the waypoints are not saved to the saved game file.

This function can be used outside of scene setup, during move and life flows. However, if you are using it outside of the scene setup, use it with caution, and make sure to persist any changes in your custom scene variable, if you need them. The updated waypoint coordinate will not be saved to the saved game file automatically.

This allows to have dynamic waypoints that can be updated during the game.

Be careful to not update waypoints that are used by current running scripts, as it may lead to unexpected behavior.
Parameters
- id: number
  The index of the waypoint to update
- pos: number[]
  The new position of the waypoint as an array of three numbers (x, y, z)
Returns void
- Defined in scene.d.ts:564

`Private`_setLoadHandler

_setLoadHandler(callback: (json: string) => void): void
Private
Sets an Ida load handler callback to handle loading the game state from a json string.
Parameters
- callback: (json: string) => void
Returns void
Warning
This is managed by Ida internally. Only use this function, if you know what you are doing.
- Defined in scene.d.ts:651

`Private`_setSaveHandler

_setSaveHandler(callback: (isBackupSave: boolean) => string | void): void
Private
Sets an Ida save handler callback to handle saving the game state to a file.
Parameters
- callback: (isBackupSave: boolean) => string | void
  The callback that receives isBackupSave as an argument.
  
  If isBackupSave is false, the callback should return a json string representing the game state to be saved.
  
  If isBackupSave is true, the callback should save the backup state internally, and is not expected to return anything.
Returns void
Warning
This is managed by Ida internally. Only use this function, if you know what you are doing.
- Defined in scene.d.ts:643

Interface Scene

Index

Properties

Methods

Properties

Events

GameVariables

LoadModes

Readonlyobjects

Example

Readonlywaypoints

Returns

Example

Readonlyzones

Example

Methods

addEventListener

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Warning

addObjects

Parameters

Returns number

addWaypoints

Parameters

Returns number

addZones

Parameters

Returns number

findFreeZoneValue

Parameters

Returns number

getCurrentMoney

Returns number

getForeignMoney

Returns number

getGameVariable

Parameters

Returns number

See

getGold

Returns number

getId

Returns number

getIsland

Returns number

getMagicLevel

Returns number

getMagicPoints

Returns number

getNumKeys

Returns number

getNumObjects

Returns number

getNumWaypoints

Returns number

getNumZones

Returns number

getObject

Parameters

Returns GameObject

getPlanet

Returns number

getStartPos

Returns number[]

getVariable

Parameters

Returns number

getWaypoint

Parameters

Returns number[]

getZlitos

Returns number

getZone

Parameters

Returns Zone

`Readonly`objects

`Readonly`waypoints

`Readonly`zones

`Private`_setLoadHandler

`Private`_setSaveHandler