Class Obstacle

Obstacles are usually walls, except they can also move, and can be used in all sorts of other ways.

Hierarchy

Role
- Obstacle

Index

Constructors

constructor

new Obstacle(cfg?): Obstacle
Construct an Obstacle role
Parameters
- cfg: {
      disableHeroCollision?: boolean;
      enemyCollision?: ((thisActor, collideActor) => void);
      heroCollision?: ((thisActor, collideActor) => void);
      jumpReEnableSides?: DIRECTION[];
      projectileCollision?: ((thisActor, collideActor) => boolean);
  } = {}
  - Optional disableHeroCollision?: boolean
    Should the hero bounce off of this obstacle?
  - Optional enemyCollision?: ((thisActor, collideActor) => void)
    Code to run when this obstacle collides with an enemy
    - (thisActor, collideActor): void
      Code to run when this obstacle collides with an enemy
      
      Parameters
      thisActor: Actor
      collideActor: Actor
      Returns void
  - Optional heroCollision?: ((thisActor, collideActor) => void)
    Code to run when this obstacle collides with a hero
    - (thisActor, collideActor): void
      Code to run when this obstacle collides with a hero
      
      Parameters
      thisActor: Actor
      collideActor: Actor
      Returns void
  - Optional jumpReEnableSides?: DIRECTION[]
    Which sides "count" for letting a jumping hero jump again?
  - Optional projectileCollision?: ((thisActor, collideActor) => boolean)
    Code to run when this obstacle collides with a projectile
    - (thisActor, collideActor): boolean
      Code to run when this obstacle collides with a projectile
      
      Parameters
      thisActor: Actor
      collideActor: Actor
      Returns boolean
Returns Obstacle
Overrides Role.constructor
- Defined in Components/Role.ts:618

Properties

collisionRules

collisionRules: {
ignores: CollisionExemptions[];
properties: CollisionExemptions[];
} = ...

collisionRules lets us turn off collisions based on the roles of two actors. We do this with two sets. If A's second set contains an entry in B's first set, then we disable the collision. We also do this symmetrically with B and A. In essence, this means that the first set lets a Role say "here are special things about me", and the second set lets a Role say "I don't collide with things that are special in these ways."

Type declaration

ignores: CollisionExemptions[]
The second set: properties that this role won't collide with
properties: CollisionExemptions[]
The first set: properties of this role

`Optional` enemyCollision

enemyCollision?: ((thisActor, collideActor) => void)

This is for when an enemy collides with an obstacle

Type declaration

- (thisActor, collideActor): void
- This is for when an enemy collides with an obstacle
  Parameters
  - thisActor: Actor
  - collideActor: Actor
  Returns void

`Optional` heroCollision

heroCollision?: ((thisActor, collideActor) => void)

Code to run when a hero collides with this obstacle

Type declaration

- (thisActor, collideActor): void
- Code to run when a hero collides with this obstacle
  Parameters
  - thisActor: Actor
  - collideActor: Actor
  Returns void

jumpReEnableSides

jumpReEnableSides: DIRECTION[] = ...

Which sides of this obstacle count as a "wall" to stop the current jump

`Readonly` prerenderTasks

prerenderTasks: ((elapsedMs, actor?) => void)[] = []

Tasks to run before every render

Type declaration

- (elapsedMs, actor?): void
- Parameters
  - elapsedMs: number
  - Optional actor: Actor
  Returns void

`Optional` projectileCollision

projectileCollision?: ((thisActor, collideActor) => boolean)

This is for when a projectile collides with an obstacle

Type declaration

- (thisActor, collideActor): boolean
- This is for when a projectile collides with an obstacle
  Parameters
  - thisActor: Actor
  - collideActor: Actor
  Returns boolean

Accessors

actor

get actor(): undefined | Actor
The actor associated with this Role

Returns undefined | Actor
- Defined in Components/Role.ts:602
set actor(actor): void
The actor associated with this Role
Parameters
- actor: undefined | Actor
Returns void
- Defined in Components/Role.ts:600

Methods

disableCollision

disableCollision(which): void
This actor ignores collisions with Heroes
Parameters
- which: CollisionExemptions
Returns void
Inherited from Role.disableCollision
- Defined in Components/Role.ts:65

enableCollision

enableCollision(which): void
Indicate that the current Role should not ignore collisions with some other role
Parameters
- which: CollisionExemptions
  The role that should not be ignored
Returns void
Inherited from Role.enableCollision
- Defined in Components/Role.ts:55

onCollide

onCollide(other): boolean
Code to run when there is a collision involving this role's Actor
Parameters
- other: Actor
Returns boolean
Overrides Role.onCollide
- Defined in Components/Role.ts:637

playCollideSound

playCollideSound(): void
Internal method for playing a sound when a hero collides with this obstacle. Since collisions can repeat with high frequency, we use this to avoid re-playing the sound before it even finishes.

Returns void
- Defined in Components/Role.ts:663

prerender

prerender(elapsedMs): void
Code to run immediately before rendering this role's Actor
Parameters
- elapsedMs: number
Returns void
Inherited from Role.prerender
- Defined in Components/Role.ts:75

Class Obstacle

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

cfg: { disableHeroCollision?: boolean; enemyCollision?: ((thisActor, collideActor) => void); heroCollision?: ((thisActor, collideActor) => void); jumpReEnableSides?: DIRECTION[]; projectileCollision?: ((thisActor, collideActor) => boolean); } = {}

Optional disableHeroCollision?: boolean

Optional enemyCollision?: ((thisActor, collideActor) => void)

Parameters

thisActor: Actor

collideActor: Actor

Returns void

Optional heroCollision?: ((thisActor, collideActor) => void)

Parameters

thisActor: Actor

collideActor: Actor

Returns void

Optional jumpReEnableSides?: DIRECTION[]

Optional projectileCollision?: ((thisActor, collideActor) => boolean)

Parameters

thisActor: Actor

collideActor: Actor

Returns boolean

Returns Obstacle

Properties

collisionRules

Type declaration

ignores: CollisionExemptions[]

properties: CollisionExemptions[]

Optional enemyCollision

Type declaration

Parameters

thisActor: Actor

collideActor: Actor

Returns void

Optional heroCollision

Type declaration

Parameters

thisActor: Actor

collideActor: Actor

Returns void

jumpReEnableSides

Readonly prerenderTasks

Type declaration

Parameters

elapsedMs: number

Optional actor: Actor

Returns void

Optional projectileCollision

Type declaration

Parameters

thisActor: Actor

collideActor: Actor

Returns boolean

Accessors

actor

Returns undefined | Actor

Parameters

actor: undefined | Actor

Returns void

Methods

disableCollision

Parameters

which: CollisionExemptions

Returns void

enableCollision

Parameters

which: CollisionExemptions

Returns void

onCollide

Parameters

other: Actor

Returns boolean

playCollideSound

Returns void

cfg: {
disableHeroCollision?: boolean;
enemyCollision?: ((thisActor, collideActor) => void);
heroCollision?: ((thisActor, collideActor) => void);
jumpReEnableSides?: DIRECTION[];
projectileCollision?: ((thisActor, collideActor) => boolean);
} = {}

`Optional` disableHeroCollision?: boolean

`Optional` enemyCollision?: ((thisActor, collideActor) => void)

`Optional` heroCollision?: ((thisActor, collideActor) => void)

`Optional` jumpReEnableSides?: DIRECTION[]

`Optional` projectileCollision?: ((thisActor, collideActor) => boolean)

`Optional` enemyCollision

`Optional` heroCollision

`Readonly` prerenderTasks

`Optional` actor: Actor

`Optional` projectileCollision