Class Scene

Constructors

constructor

new Scene(game, name): Scene
Creates a new scene object.
Parameters
- game: Game
  The game object that the scene belongs to.
- name: string
  The name of the scene.
Returns Scene
- Defined in src/lib/engine-objects/scene.ts:53

Properties

camera

camera: Camera = ...

The camera object for the scene.

data

data: Record<string, any> = {}

The custom data for the scene.

game

game: Game

The game object that the scene belongs to.

gravity

gravity: number = 0

The global gravity value for the scene.

layers

layers: Layer[] = []

An array of all the layers in the scene.

name

name: string

The name of the scene.

nextRenderOrder

nextRenderOrder: number = 0

The next available render order for layers.

objects

objects: Entity[] = []

An array of all the objects in the scene.

size

size: Vector = ...

The size of the scene (grid size in tiles). Default grid is canvas resolution with tile size 1px.

tileCollisionData

tileCollisionData: number[] = []

An array of tile collision data.

tileSize

tileSize: Vector = ...

The size of each tile in the scene (default 1px).

tiles

tiles: Record<string, Tile> = {}

A record of all the tiles in the scene.

`Optional`tmxMap

tmxMap?: string

The TMX map file name.

Methods

addLayer

addLayer(l, order?): Layer
Adds a layer to the scene.
Parameters
- l: TMXLayer | Constructable<Layer>
  The layer to add. It can be a constructor function or an instance of TMXLayer.
- Optionalorder: number
  The render order of the layer. If not provided, it will be assigned the next available render order.
Returns Layer
- Defined in src/lib/engine-objects/scene.ts:248

addObject

addObject(entity, layerId?): Entity
Adds an entity to the scene.
Parameters
- entity: Entity
  The entity to be added.
- OptionallayerId: number
  The ID of the layer to add the entity to (optional).
Returns Entity
The added entity.
- Defined in src/lib/engine-objects/scene.ts:282

addObjectFromLayer

addObjectFromLayer(type, props): Entity
Adds an object to the scene from a specific layer.
Parameters
- type: string
  The type of the object to add.
- props: Record<string, any>
  The properties of the object.
Returns Entity
The added entity.
- Defined in src/lib/engine-objects/scene.ts:269

addTileset

addTileset(tileset, source): {
    columns: number;
    firstgid: number;
    image: {
        height: number;
        source: string;
        width: number;
    };
    margin?: number;
    name: string;
    spacing?: number;
    tilecount: number;
    tileheight: number;
    tiles: TMXTile[];
    tilewidth: number;
}
Adds a tileset to the scene.
Parameters
- tileset: TMXTileset
  The tileset to add.
- source: string
  The source of the tileset image.
Returns {
    columns: number;
    firstgid: number;
    image: {
        height: number;
        source: string;
        width: number;
    };
    margin?: number;
    name: string;
    spacing?: number;
    tilecount: number;
    tileheight: number;
    tiles: TMXTile[];
    tilewidth: number;
}
- columns: number
- firstgid: number
- image: {
      height: number;
      source: string;
      width: number;
  }
  - height: number
  - source: string
  - width: number
- Optionalmargin?: number
- name: string
- Optionalspacing?: number
- tilecount: number
- tileheight: number
- tiles: TMXTile[]
- tilewidth: number
- Defined in src/lib/engine-objects/scene.ts:306

createFromTmxMap

createFromTmxMap(tmxMap): void
Creates a scene from a TMX map.
Parameters
- tmxMap: TMXTiledMap
  The TMX map to create the scene from.
Returns void
- Defined in src/lib/engine-objects/scene.ts:75

createLayers

createLayers(layers): void
Creates layers and adds them to the scene.
Parameters
- layers: (TMXLayer | Constructable<Layer>)[]
  An array of layer constructors or TMXLayer instances.
Returns void
- Defined in src/lib/engine-objects/scene.ts:237

createTilesets

createTilesets(tilesets): void
Creates tilesets for the scene.
Parameters
- tilesets: TMXTileset[]
  An array of TMXTileset objects representing the tilesets to be created.
Returns void
- Defined in src/lib/engine-objects/scene.ts:318

destroy

destroy(): void
Destroys the scene by resetting its properties.

Returns void
- Defined in src/lib/engine-objects/scene.ts:61

displayDebug

displayDebug(): void
Displays debug information on the canvas.

Returns void
- Defined in src/lib/engine-objects/scene.ts:513

draw

draw(): void
Draws the scene on the main context.

Returns void
- Defined in src/lib/engine-objects/scene.ts:133

getCameraVisibleArea

getCameraVisibleArea(): Box
Calculates the visible area of the camera in the scene.

Returns Box
A Box object representing the visible area of the camera.
- Defined in src/lib/engine-objects/scene.ts:360

getCameraVisibleGrid

getCameraVisibleGrid(): Box
Returns the visible grid of the camera.

Returns Box
The visible grid of the camera.
- Defined in src/lib/engine-objects/scene.ts:349

getData

getData(key): any
Retrieves the value associated with the specified key from the data object.
Parameters
- key: string
  The key of the value to retrieve.
Returns any
The value associated with the specified key, or undefined if the key does not exist.
- Defined in src/lib/engine-objects/scene.ts:506

getGridPos

getGridPos(pos): Vector
Returns the grid position of a given vector.
Parameters
- pos: Vector
  The vector to calculate the grid position for.
Returns Vector
The grid position as a vector.
- Defined in src/lib/engine-objects/scene.ts:373

getLayerById

getLayerById(id): undefined | Layer
Retrieves a layer from the scene based on the provided ID.
Parameters
- id: number
  The ID of the layer to retrieve.
Returns undefined | Layer
The layer with the specified ID, or undefined if no layer is found.
- Defined in src/lib/engine-objects/scene.ts:413

getLayerByIndex

getLayerByIndex(index): Layer
Retrieves the layer at the specified index. If the layer does not exist, an empty Layer object is returned.
Parameters
- index: number
  The index of the layer to retrieve.
Returns Layer
The layer at the specified index, or an empty Layer object if the layer does not exist.
- Defined in src/lib/engine-objects/scene.ts:423

getObjectById

getObjectById(id): undefined | Entity
Retrieves an object from the scene by its ID.
Parameters
- id: number
  The ID of the object to retrieve.
Returns undefined | Entity
The object with the specified ID, or undefined if not found.
- Defined in src/lib/engine-objects/scene.ts:432

getObjectByType

getObjectByType(type): undefined | Entity
Retrieves an object from the scene by its type.
Parameters
- type: string
  The type of the object to retrieve.
Returns undefined | Entity
The first object found with the specified type, or undefined if no object is found.
- Defined in src/lib/engine-objects/scene.ts:441

getObjectLayers

getObjectLayers(): Layer[]
Retrieves the object layers of the scene.

Returns Layer[]
An array of object layers.
- Defined in src/lib/engine-objects/scene.ts:458

getObjectsByType

getObjectsByType(type): Entity[]
Returns an array of objects of a specific type.
Parameters
- type: string
  The type of objects to filter.
Returns Entity[]
An array of objects of the specified type.
- Defined in src/lib/engine-objects/scene.ts:450

getPointerPos

getPointerPos(): Vector
Returns the position of the pointer relative to the scene.

Returns Vector
The position of the pointer relative to the scene.
- Defined in src/lib/engine-objects/scene.ts:394

getPointerRelativeGridPos

getPointerRelativeGridPos(): Vector
Returns the pointer position relative to the grid.

Returns Vector
The pointer position divided by the tile size.
- Defined in src/lib/engine-objects/scene.ts:404

getScreenPos

getScreenPos(pos, size?): Vector
Calculates position on screen based on the given position and size.
Parameters
- pos: Vector
  The position vector.
- Optionalsize: Vector
  The size vector (optional).
Returns Vector
The calculated screen position.
- Defined in src/lib/engine-objects/scene.ts:383

getTile

getTile(pos, layerId): undefined | Tile
Retrieves the tile object at the specified position on the given layer. If the tile at the position is not found, it returns the tile object at index 0.
Parameters
- pos: Vector
  The position of the tile.
- layerId: number
  The ID of the layer.
Returns undefined | Tile
The tile object at the specified position.
- Defined in src/lib/engine-objects/scene.ts:469

getTileCollisionData

getTileCollisionData(pos): number
Retrieves the tile collision data at the specified position.
Parameters
- pos: Vector
  The position to retrieve the tile collision data from.
Returns number
The tile collision data at the specified position.
- Defined in src/lib/engine-objects/scene.ts:341

getTileObject

getTileObject(id): Tile
Retrieves the tile object with the specified ID.
Parameters
- id: number
  The ID of the tile object.
Returns Tile
The tile object associated with the ID.
- Defined in src/lib/engine-objects/scene.ts:479

init

init(): void
Initializes the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:85

postUpdate

postUpdate(): void
Performs post-update operations for the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:121

postUpdateLayers

postUpdateLayers(): void
Performs post-update operations for all the layers in the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:126

raycastTileCollision

raycastTileCollision(start, end, entity?): undefined | Vector
Performs a raycast to check for tile collisions between two positions. Based on the DDA algorithm: https://lodev.org/cgtutor/raycasting.html
Parameters
- start: Vector
  The starting position of the raycast.
- end: Vector
  The ending position of the raycast.
- Optionalentity: Entity
  An optional entity to check for collisions with tiles.
Returns undefined | Vector
The position of the first tile hit by the raycast, or null if no collision occurred.
- Defined in src/lib/engine-objects/scene.ts:212

removeLayer

removeLayer(layer): void
Removes a layer from the scene.
Parameters
- layer: Layer
  The layer to be removed.
Returns void
- Defined in src/lib/engine-objects/scene.ts:488

removeObject

removeObject(obj): void
Removes an object from the scene.
Parameters
- obj: Entity
  The object to be removed.
Returns void
- Defined in src/lib/engine-objects/scene.ts:297

setData

setData(key, value): void
Sets the value of a specific key in the data object.
Parameters
- key: string
  The key to set the value for.
- value: any
  The value to set.
Returns void
- Defined in src/lib/engine-objects/scene.ts:497

setDimensions

setDimensions(size, tileSize): void
Sets the dimensions of the scene.
Parameters
- size: Vector
  The size of the scene.
- tileSize: Vector
  The size of each tile in the scene.
Returns void
- Defined in src/lib/engine-objects/scene.ts:153

setScale

setScale(scale): void
Sets the scale of the scene.
Parameters
- scale: number
  The scale value to set.
Returns void
- Defined in src/lib/engine-objects/scene.ts:162

setTileCollisionData

setTileCollisionData(pos, data?): void
Sets the collision data for a tile at the specified position.
Parameters
- pos: Vector
  The position of the tile.
- data: number = 0
  The collision data to set for the tile. Defaults to 0.
Returns void
- Defined in src/lib/engine-objects/scene.ts:332

setTileCollisionLayer

setTileCollisionLayer(layerId, exclude?): void
Sets the tile collision layer for the scene.
Parameters
- layerId: number
  The ID of the layer to set as the collision layer.
- exclude: number[] = ...
  An array of tile IDs to exclude from the collision layer.
Returns void
- Defined in src/lib/engine-objects/scene.ts:171

testTileCollision

testTileCollision(pos, size, entity?): boolean
Performs a tile collision test for the given position and size.
Parameters
- pos: Vector
  The position of the entity.
- size: Vector
  The size of the entity.
- Optionalentity: Entity
  The entity to perform the collision test for (optional).
Returns boolean
true if a collision is detected, false otherwise.
- Defined in src/lib/engine-objects/scene.ts:190

update

update(): void
Updates the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:90

updateCamera

updateCamera(): void
Updates the camera in the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:95

updateLayers

updateLayers(): void
Updates all the layers in the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:102

updateObjects

updateObjects(): void
Updates all the active objects in the scene.

Returns void
- Defined in src/lib/engine-objects/scene.ts:109

Class Scene

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Scene

Properties

camera

data

game

gravity

layers

name

nextRenderOrder

objects

size

tileCollisionData

tileSize

tiles

OptionaltmxMap

Methods

addLayer

Parameters

Returns Layer

addObject

Parameters

Returns Entity

addObjectFromLayer

Parameters

Returns Entity

addTileset

Parameters

Returns { columns: number; firstgid: number; image: { height: number; source: string; width: number; }; margin?: number; name: string; spacing?: number; tilecount: number; tileheight: number; tiles: TMXTile[]; tilewidth: number; }

columns: number

firstgid: number

image: { height: number; source: string; width: number; }

height: number

source: string

width: number

Optionalmargin?: number

name: string

Optionalspacing?: number

tilecount: number

tileheight: number

tiles: TMXTile[]

tilewidth: number

createFromTmxMap

Parameters

Returns void

createLayers

Parameters

Returns void

createTilesets

Parameters

Returns void

destroy

Returns void

displayDebug

Returns void

draw

Returns void

getCameraVisibleArea

Returns Box

getCameraVisibleGrid

Returns Box

getData

Parameters

Returns any

getGridPos

Parameters

Returns Vector

getLayerById

Parameters

Returns undefined | Layer

getLayerByIndex

Parameters

Returns Layer

`Optional`tmxMap

Returns {
columns: number;
firstgid: number;
image: {
height: number;
source: string;
width: number;
};
margin?: number;
name: string;
spacing?: number;
tilecount: number;
tileheight: number;
tiles: TMXTile[];
tilewidth: number;
}

image: {
height: number;
source: string;
width: number;
}

`Optional`margin?: number

`Optional`spacing?: number