Class KirCity

Abstract class for game environments.
This class is used to set up the environment for the game, including the skybox, ground segments, static objects, and entities.\

Hierarchy (View Summary)

Environment
- KirCity

Index

Constructors

Properties

player random scene skybox skyboxSize

Accessors

Methods

beforeRenderUpdate getGroundSegments getLight load loadEnvironment pushEntityObject pushGroundSegment pushStaticObject setGroundSegments setupLight setupShadows setupSkybox

Constructors

constructor

new KirCity(scene: LevelScene, player: Player, seed?: number): KirCity
Parameters
- scene: LevelScene
- player: Player
- Optionalseed: number
Returns KirCity
Inherited from Environment.constructor
- Defined in environments/environment.ts:24

Properties

`Protected`player

player: Player

`Protected`random

random: Random

`Protected`scene

scene: LevelScene

`Protected`skybox

skybox: Mesh

`Protected`skyboxSize

skyboxSize: number = 10000

Accessors

seed

get seed(): number
Returns number
Inherited from Environment.seed
- Defined in environments/environment.ts:32

Methods

beforeRenderUpdate

beforeRenderUpdate(): void
Returns void
Overrides Environment.beforeRenderUpdate
- Defined in environments/minigames/classicLevels/kirbyCity.ts:29

`Protected`getGroundSegments

getGroundSegments(): Mesh[]
Returns Mesh[]
Inherited from Environment.getGroundSegments
- Defined in environments/environment.ts:42

getLight

getLight(): DirectionalLight
Returns DirectionalLight
Inherited from Environment.getLight
- Defined in environments/environment.ts:36

load

load(classicLevel?: number): Promise<void>
Parameters
- OptionalclassicLevel: number
Returns Promise<void>
Inherited from Environment.load
- Defined in environments/environment.ts:67

loadEnvironment

loadEnvironment(): Promise<void>
Returns Promise<void>
Overrides Environment.loadEnvironment
- Defined in environments/minigames/classicLevels/kirbyCity.ts:23

`Protected`pushEntityObject

pushEntityObject(entity: GameEntity, position: Vector3): void
Parameters
- entity: GameEntity
- position: Vector3
Returns void
Inherited from Environment.pushEntityObject
- Defined in environments/environment.ts:60

`Protected`pushGroundSegment

pushGroundSegment(mesh: Mesh, position?: Vector3): void
Parameters
- mesh: Mesh
- Optionalposition: Vector3
Returns void
Inherited from Environment.pushGroundSegment
- Defined in environments/environment.ts:50

`Protected`pushStaticObject

pushStaticObject(mesh: Mesh, position: Vector3): void
Parameters
- mesh: Mesh
- position: Vector3
Returns void
Inherited from Environment.pushStaticObject
- Defined in environments/environment.ts:55

`Protected`setGroundSegments

setGroundSegments(segments: Mesh[]): void
Parameters
- segments: Mesh[]
Returns void
Inherited from Environment.setGroundSegments
- Defined in environments/environment.ts:46

setupLight

setupLight(): void
Returns void
Overrides Environment.setupLight
- Defined in environments/minigames/classicLevels/kirbyCity.ts:19

setupShadows

setupShadows(): void
Returns void
Inherited from Environment.setupShadows
- Defined in environments/environment.ts:73

setupSkybox

setupSkybox(): void
Returns void
Overrides Environment.setupSkybox
- Defined in environments/minigames/classicLevels/kirbyCity.ts:7