Class ActionEvent

constructor

• new ActionEvent(
      source: any,
      pointerX: number,
      pointerY: number,
      meshUnderPointer: Nullable<AbstractMesh>,
      sourceEvent?: any,
      additionalData?: any,
  ): ActionEvent

  Creates a new ActionEvent

  Parameters

  • source: any

    The mesh or sprite that triggered the action

  • pointerX: number

    The X mouse cursor position at the time of the event

  • pointerY: number

    The Y mouse cursor position at the time of the event

  • meshUnderPointer: Nullable<AbstractMesh>

    The mesh that is currently pointed at (can be null)

  • OptionalsourceEvent: any

    the original (browser) event that triggered the ActionEvent

  • OptionaladditionalData: any

    additional data for the event

  Returns ActionEvent

OptionaladditionalData

meshUnderPointer

pointerX

pointerY

source

OptionalsourceEvent

StaticCreateNew

• CreateNew(source: AbstractMesh, evt?: any, additionalData?: any): ActionEvent

  Helper function to auto-create an ActionEvent from a source mesh.

  Parameters

  • source: AbstractMesh

    The source mesh that triggered the event

  • Optionalevt: any

    The original (browser) event

  • OptionaladditionalData: any

    additional data for the event

  Returns ActionEvent

  the new ActionEvent

StaticCreateNewFromPrimitive

• CreateNewFromPrimitive(
      prim: any,
      pointerPos: Vector2,
      evt?: Event,
      additionalData?: any,
  ): ActionEvent

  Helper function to auto-create an ActionEvent from a primitive

  Parameters

  • prim: any

    defines the target primitive

  • pointerPos: Vector2

    defines the pointer position

  • Optionalevt: Event

    The original (browser) event

  • OptionaladditionalData: any

    additional data for the event

  Returns ActionEvent

  the new ActionEvent

StaticCreateNewFromScene

• CreateNewFromScene(scene: Scene, evt: any): ActionEvent

  Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew

  Parameters

  • scene: Scene

    the scene where the event occurred

  • evt: any

    The original (browser) event

  Returns ActionEvent

  the new ActionEvent

StaticCreateNewFromSprite

• CreateNewFromSprite(
      source: Sprite,
      scene: Scene,
      evt?: any,
      additionalData?: any,
  ): ActionEvent

  Helper function to auto-create an ActionEvent from a source sprite

  Parameters

  • source: Sprite

    The source sprite that triggered the event

  • scene: Scene

    Scene associated with the sprite

  • Optionalevt: any

    The original (browser) event

  • OptionaladditionalData: any

    additional data for the event

  Returns ActionEvent

  the new ActionEvent