NativeSoundEvent

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

• MediaEvent
  • NativeSoundEvent

Index

Constructors

• constructor

Properties

• other
• target
• track

Accessors

• bubbles

Methods

• action
• layPath
• propagate
• stopPropagation

Constructors

constructor

• NativeSoundEvent(target: Sound, track?: WebAudioInstance): NativeSoundEvent

• Overrides MediaEvent.constructor

  Parameters

  • target: Sound

  • optionaltrack: WebAudioInstance

  Returns NativeSoundEvent

Properties

publicinheritedother

other: Sound | null = null

Inherited from MediaEvent.other

Other target object for this event

publicinheritedtarget

target: Sound

Inherited from MediaEvent.target

Target object for this event.

publicoptionaltrack

track?: WebAudioInstance

Accessors

publicinheritedbubbles

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

• Inherited from MediaEvent.bubbles

  Media event cannot bubble

  ---

  Returns boolean

• Inherited from MediaEvent.bubbles

  Media event cannot bubble

  ---

  Parameters

  • _value: boolean

  Returns void

Methods

publicinheritedaction

• action(): void

• Inherited from MediaEvent.action

  Action, that calls when event happens

  ---

  Returns void

publicinheritedlayPath

• layPath(_actor: Actor): void

• Inherited from MediaEvent.layPath

  Parameters

  • _actor: Actor

  Returns void

publicinheritedpropagate

• propagate(): void

• Inherited from MediaEvent.propagate

  Propagate event further through event path

  ---

  Returns void

publicinheritedstopPropagation

• stopPropagation(): void

• Inherited from MediaEvent.stopPropagation

  Prevents event from bubbling

  ---

  Returns void