IGameFramework | perplexed-wars

Hierarchy

EventEmitter
- IGameFramework

Implemented by

Game

Index

Events

afterAddUnit

afterAddUnit(event: AfterAddUnitEvent): void

- Defined in state/IGameFramework.d.ts:147
Triggered after a unit was successfully added in the board

asmemberof

IGameFramework

Parameters
- event: AfterAddUnitEvent
Returns void

afterGameStarts

afterGameStarts(event: GameFrameworkEvent): void

- Defined in state/IGameFramework.d.ts:77
Triggered just before turn is about to end (units didn't moved yet)

asmemberof

IGameFramework

Parameters
- event: GameFrameworkEvent
Returns void

afterTurnEnd

afterTurnEnd(event: AfterTurnEndEvent): void

- Defined in state/IGameFramework.d.ts:53
Triggered just before turn is about to end (units didn't moved yet)

asmemberof

IGameFramework

Parameters
- event: AfterTurnEndEvent
Returns void

afterUnitDie

afterUnitDie(event: AfterUnitDieEvent): void

- Defined in state/IGameFramework.d.ts:63
Triggered after a unit die and is removed from the board

asmemberof

IGameFramework

Parameters
- event: AfterUnitDieEvent
Returns void

afterUnitSelection

afterUnitSelection(event: AfterUnitSelectionEvent): void

- Defined in state/IGameFramework.d.ts:124
Triggered after unit(s) were selected by the user

asmemberof

IGameFramework

Parameters
- event: AfterUnitSelectionEvent
Returns void

beforeAddUnitSuccess

beforeAddUnitSuccess(event: BeforeAddUnitSuccessEvent): void

- Defined in state/IGameFramework.d.ts:136
Triggered just before units are going to be added successfully to the board

asmemberof

IGameFramework

Parameters
- event: BeforeAddUnitSuccessEvent
Returns void

beforeGameFinish

beforeGameFinish(event: BeforeGameFinishEvent): void

- Defined in state/IGameFramework.d.ts:159
Triggered just before units are going to be added successfully to the board

asmemberof

IGameFramework

Parameters
- event: BeforeGameFinishEvent
Returns void

beforeGameStarts

beforeGameStarts(event: BeforeGameStartsEvent): void

- Defined in state/IGameFramework.d.ts:85
Triggered just before the game starts (no turns passed yet, nothing was drawn yet)

asmemberof

IGameFramework

Parameters
- event: BeforeGameStartsEvent
Returns void

beforeTurnEnd

beforeTurnEnd(event: BeforeTurnEndEvent): void

- Defined in state/IGameFramework.d.ts:96
Triggered just before turn is about to end (units didn't moved yet)

asmemberof

IGameFramework

Parameters
- event: BeforeTurnEndEvent
Returns void

beforeUnitSelection

beforeUnitSelection(event: BeforeUnitSelectionEvent): void

- Defined in state/IGameFramework.d.ts:113
Triggered just before unit(s) are selected by the user

asmemberof

IGameFramework

Parameters
- event: BeforeUnitSelectionEvent
Returns void

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:920
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

emit(eventName: EVENT_BEFORE_UNIT_SELECTION, data: BeforeUnitSelectionEvent): boolean
emit(eventName: EVENT_AFTER_UNIT_SELECTION, data: AfterUnitSelectionEvent): boolean
emit(eventName: EVENT_BEFORE_ADD_UNIT_SUCCESS, data: BeforeAddUnitSuccessEvent): boolean
emit(eventName: EVENT_AFTER_ADD_UNIT, data: AfterAddUnitEvent): boolean
emit(eventName: EVENT_BEFORE_GAME_FINISH, data: BeforeGameFinishEvent): boolean
emit(eventName: EVENT_BEFORE_TURN_END, data: BeforeTurnEndEvent): boolean
emit(eventName: EVENT_AFTER_TURN_END, data: AfterTurnEndEvent): boolean
emit(eventName: EVENT_BEFORE_GAME_STARTS, data: BeforeGameStartsEvent): boolean
emit(eventName: EVENT_AFTER_GAME_STARTS, data: AfterGameStartsEvent): boolean
emit(eventName: EVENT_AFTER_UNIT_DIE, data: AfterUnitDieEvent): boolean

Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:28
Parameters
- eventName: EVENT_BEFORE_UNIT_SELECTION
- data: BeforeUnitSelectionEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:30
Parameters
- eventName: EVENT_AFTER_UNIT_SELECTION
- data: AfterUnitSelectionEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:32
Parameters
- eventName: EVENT_BEFORE_ADD_UNIT_SUCCESS
- data: BeforeAddUnitSuccessEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:34
Parameters
- eventName: EVENT_AFTER_ADD_UNIT
- data: AfterAddUnitEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:36
Parameters
- eventName: EVENT_BEFORE_GAME_FINISH
- data: BeforeGameFinishEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:38
Parameters
- eventName: EVENT_BEFORE_TURN_END
- data: BeforeTurnEndEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:40
Parameters
- eventName: EVENT_AFTER_TURN_END
- data: AfterTurnEndEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:42
Parameters
- eventName: EVENT_BEFORE_GAME_STARTS
- data: BeforeGameStartsEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:44
Parameters
- eventName: EVENT_AFTER_GAME_STARTS
- data: AfterGameStartsEvent
Returns boolean
Overrides EventEmitter.emit
- Defined in state/IGameFramework.d.ts:46
Parameters
- eventName: EVENT_AFTER_UNIT_DIE
- data: AfterUnitDieEvent
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:932
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:928
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:933
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:929
Parameters
- event: string | symbol
Returns Function[]

log

log(log: Log): void

- Defined in state/IGameFramework.d.ts:26
Parameters
- log: Log
Returns void

nextTurn

nextTurn(): void

- Defined in state/IGameFramework.d.ts:25
implements next turn (setInterval / setTimeout) accordingly to [[IGame.isRealTime]] and IGame.interval

Returns void

on

on(eventName: EVENT_BEFORE_UNIT_SELECTION, eventHandler: beforeUnitSelection): this
on(eventName: EVENT_AFTER_UNIT_SELECTION, eventHandler: afterUnitSelection): this
on(eventName: EVENT_BEFORE_ADD_UNIT_SUCCESS, eventHandler: beforeAddUnitSuccess): this
on(eventName: EVENT_AFTER_ADD_UNIT, eventHandler: afterAddUnit): this
on(eventName: EVENT_BEFORE_GAME_FINISH, eventHandler: beforeGameFinish): this
on(eventName: EVENT_BEFORE_TURN_END, eventHandler: beforeTurnEnd): this
on(eventName: EVENT_AFTER_TURN_END, eventHandler: afterTurnEnd): this
on(eventName: EVENT_BEFORE_GAME_STARTS, eventHandler: beforeGameStarts): this
on(eventName: EVENT_AFTER_GAME_STARTS, eventHandler: afterGameStarts): this
on(eventName: EVENT_AFTER_UNIT_DIE, eventHandler: afterUnitDie): this

Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:27
Parameters
- eventName: EVENT_BEFORE_UNIT_SELECTION
- eventHandler: beforeUnitSelection
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:29
Parameters
- eventName: EVENT_AFTER_UNIT_SELECTION
- eventHandler: afterUnitSelection
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:31
Parameters
- eventName: EVENT_BEFORE_ADD_UNIT_SUCCESS
- eventHandler: beforeAddUnitSuccess
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:33
Parameters
- eventName: EVENT_AFTER_ADD_UNIT
- eventHandler: afterAddUnit
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:35
Parameters
- eventName: EVENT_BEFORE_GAME_FINISH
- eventHandler: beforeGameFinish
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:37
Parameters
- eventName: EVENT_BEFORE_TURN_END
- eventHandler: beforeTurnEnd
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:39
Parameters
- eventName: EVENT_AFTER_TURN_END
- eventHandler: afterTurnEnd
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:41
Parameters
- eventName: EVENT_BEFORE_GAME_STARTS
- eventHandler: beforeGameStarts
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:43
Parameters
- eventName: EVENT_AFTER_GAME_STARTS
- eventHandler: afterGameStarts
Returns this
Overrides EventEmitter.on
- Defined in state/IGameFramework.d.ts:45
Parameters
- eventName: EVENT_AFTER_UNIT_DIE
- eventHandler: afterUnitDie
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:922
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:923
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:924
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:930
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:926
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:925
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): void

- Defined in state/IGameFramework.d.ts:23
Returns void

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:927
Parameters
- n: number
Returns this

start

start(): void

- Defined in state/IGameFramework.d.ts:21
starts the game

Returns void

stop

stop(): void

- Defined in state/IGameFramework.d.ts:22
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in /home/sg/git/perplexed-wars/node_modules/@types/node/index.d.ts:917
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implemented by

Index

Events

Properties

Methods

Events

afterAddUnit

Parameters

event: AfterAddUnitEvent

Returns void

afterGameStarts

Parameters

event: GameFrameworkEvent

Returns void

afterTurnEnd

Parameters

event: AfterTurnEndEvent

Returns void

afterUnitDie

Parameters

event: AfterUnitDieEvent

Returns void

afterUnitSelection

Parameters

event: AfterUnitSelectionEvent

Returns void

beforeAddUnitSuccess

Parameters

event: BeforeAddUnitSuccessEvent

Returns void

beforeGameFinish

Parameters

event: BeforeGameFinishEvent

Returns void

beforeGameStarts

Parameters

event: BeforeGameStartsEvent

Returns void

beforeTurnEnd

Parameters

event: BeforeTurnEndEvent

Returns void

beforeUnitSelection

Parameters

event: BeforeUnitSelectionEvent

Returns void

Properties

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

emit

Parameters

eventName: EVENT_BEFORE_UNIT_SELECTION

data: BeforeUnitSelectionEvent

Returns boolean

Parameters

eventName: EVENT_AFTER_UNIT_SELECTION

data: AfterUnitSelectionEvent

Returns boolean

Parameters

eventName: EVENT_BEFORE_ADD_UNIT_SUCCESS

data: BeforeAddUnitSuccessEvent

Returns boolean

Parameters

eventName: EVENT_AFTER_ADD_UNIT

data: AfterAddUnitEvent

Returns boolean

Parameters

eventName: EVENT_BEFORE_GAME_FINISH

data: BeforeGameFinishEvent

Returns boolean

Parameters