MediaEvent

Base event type in Excalibur that all other event types derive from. Not all event types are thrown on all Excalibur game objects, some events are unique to a type, others are not.

Hierarchy

• GameEvent<Sound>
  • MediaEvent
    • NativeSoundEvent
    • NativeSoundProcessedEvent

Index

Constructors

• constructor

Properties

• other
• target

Accessors

• bubbles

Methods

• action
• layPath
• propagate
• stopPropagation

Constructors

constructor

• new MediaEvent(target: Sound, _name?: string): MediaEvent

• Overrides GameEvent.constructor

  Parameters

  • target: Sound

  • _name: string = 'MediaEvent'

  Returns MediaEvent

Properties

publicother

other: Sound = null

Inherited from GameEvent.other

Other target object for this event

publictarget

target: Sound

Inherited from GameEvent.target

Target object for this event.

Accessors

publicbubbles

• get bubbles(): boolean
• set bubbles(_value: boolean): void

• Overrides GameEvent.bubbles

  Media event cannot bubble

  ---

  Returns boolean

• Overrides GameEvent.bubbles

  Media event cannot bubble

  ---

  Parameters

  • _value: boolean

  Returns void

Methods

publicaction

• action(): void

• Action, that calls when event happens

  ---

  Returns void

publiclayPath

• layPath(_actor: Actor): void

• Parameters

  • _actor: Actor

  Returns void

publicpropagate

• propagate(): void

• Propagate event further through event path

  ---

  Returns void

publicstopPropagation

• stopPropagation(): void

• Overrides GameEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void