Interface AnimatorComponentDefinitionExtended

Hierarchy

Properties

componentId: number
componentName: string
componentType: LastWriteWinElementSet

Methods

  • Add the current component to an entity, throw an error if the component already exists (use createOrReplace instead).

    • Internal comment: This method adds the <entity,component> to the list to be reviewed next frame

    Parameters

    • entity: Entity

      Entity that will be used to create the component

    • Optional val: PBAnimator

      The initial value

    Returns PBAnimator

  • Delete the current component to an entity, return null if the entity doesn't have the current component.

    • Internal comment: This method adds the <entity,component> to the list to be reviewed next frame

    Parameters

    • entity: Entity

      Entity to delete the component from

    Returns null | PBAnimator

  • Marks the entity as deleted and signals it cannot be used ever again. It must clear the component internal state, produces a synchronization message to remove the component from the entity.

    Parameters

    • entity: Entity

      Entity ID that was deleted.

    • markAsDirty: boolean

    Returns void

  • Get a mutable version of animator clip

    Returns

    the clip or fails if it isn't found

    Parameters

    • entity: Entity

      entity with Animator component

    • clipName: string

      the field clip of the component

    Returns PBAnimationState

  • Get a mutable version of animator clip

    Returns

    the clip or null if it isn't found

    Parameters

    • entity: Entity

      entity with Animator component

    • clipName: string

      the field clip of the component

    Returns null | PBAnimationState

  • Get the mutable component of the entity, throw an error if the entity doesn't have the component.

    • Internal comment: This method adds the <entity,component> to the list to be reviewed next frame

    Parameters

    • entity: Entity

      Entity to get the component from

    Returns PBAnimator

  • Get the mutable component of the entity, return null if the entity doesn't have the component.

    • Internal comment: This method adds the <entity,component> to the list to be reviewed next frame

    Parameters

    • entity: Entity

      Entity to get the component from

    Returns null | PBAnimator

  • Set playing=true the animation $name

    Returns

    true in successful playing, false if it doesn't find the Animator or clip

    Parameters

    • entity: Entity

      entity with Animator component

    • clipName: string

      animation name

    • Optional resetCursor: boolean

      the animation starts at 0 or continues from the current cursor position

    Returns boolean

  • Set playing=false all animations

    Returns

    true in successful playing, false if it doesn't find the Animator

    Parameters

    • entity: Entity

      entity with Animator component

    • Optional resetCursor: boolean

      the animation stops at 0 or at the current cursor position

    Returns boolean