Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • TweenService

Index

Functions

addTween

  • addTween(world: World, entity: Entity, field: any, startval: ut.Math.Vector3, targetval: ut.Math.Vector3, duration: number, timeOffset: number, loopmode: LoopMode, func: TweenFunc, destroyWhenDone: boolean): any
  • addTween(world: World, entity: Entity, field: any, startval: ut.Math.Vector2, targetval: ut.Math.Vector2, duration: number, timeOffset: number, loopmode: LoopMode, func: TweenFunc, destroyWhenDone: boolean): any
  • addTween(world: World, entity: Entity, field: any, startval: ut.Math.Quaternion, targetval: ut.Math.Quaternion, duration: number, timeOffset: number, loopmode: LoopMode, func: TweenFunc, destroyWhenDone: boolean): any
  • addTween(world: World, entity: Entity, field: any, startval: Color, targetval: Color, duration: number, timeOffset: number, loopmode: LoopMode, func: TweenFunc, destroyWhenDone: boolean): any
  • addTween(world: World, entity: Entity, field: any, startval: number, targetval: number, duration: number, timeOffset: number, loopmode: LoopMode, func: TweenFunc, destroyWhenDone: boolean): any
  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • startval: ut.Math.Vector3
    • targetval: ut.Math.Vector3
    • duration: number
    • timeOffset: number
    • loopmode: LoopMode
    • func: TweenFunc
    • destroyWhenDone: boolean

    Returns any

  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • startval: ut.Math.Vector2
    • targetval: ut.Math.Vector2
    • duration: number
    • timeOffset: number
    • loopmode: LoopMode
    • func: TweenFunc
    • destroyWhenDone: boolean

    Returns any

  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • startval: ut.Math.Quaternion
    • targetval: ut.Math.Quaternion
    • duration: number
    • timeOffset: number
    • loopmode: LoopMode
    • func: TweenFunc
    • destroyWhenDone: boolean

    Returns any

  • Parameters

    Returns any

  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • startval: number
    • targetval: number
    • duration: number
    • timeOffset: number
    • loopmode: LoopMode
    • func: TweenFunc
    • destroyWhenDone: boolean

    Returns any

setValue

  • setValue(world: World, entity: Entity, field: any, value: ut.Math.Vector3): any
  • setValue(world: World, entity: Entity, field: any, value: ut.Math.Vector2): any
  • setValue(world: World, entity: Entity, field: any, value: ut.Math.Quaternion): any
  • setValue(world: World, entity: Entity, field: any, value: Color): any
  • setValue(world: World, entity: Entity, field: any, value: number): any
  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • value: ut.Math.Vector3

    Returns any

  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • value: ut.Math.Vector2

    Returns any

  • Parameters

    • world: World
    • entity: Entity
    • field: any
    • value: ut.Math.Quaternion

    Returns any

  • Parameters

    Returns any

  • Parameters

    Returns any

Methods

Static addTweenColor

  • Creates a new tweening entity with the TweenColor component and a TweenComponent component. This a helper function that does the following: e = createEntity addComponent(e,TweenColor) addComponent(e,TweenComponent) It then populates the two components with the values passed as parameters. Returns the new tweening entity, e. From a JS or TS script, use TweenService.addTween without a type.

    Parameters

    Returns Entity

Static addTweenFloat

  • Creates a new tweening entity with a TweenFloat component and a TweenComponent component. This a helper function that does the following: e = createEntity addComponent(e,TweenFloat) addComponent(e,TweenComponent) It then populates the two components with the values passed as parameters. Returns the new tweening entity, e. From a JS or TS script, use TweenService.addTween without a type.

    Parameters

    Returns Entity

Static addTweenQuaternion

  • Creates a new tweening entity with the TweenQuaternion component and a TweenComponent component. This a helper function that does the following: e = createEntity addComponent(e,TweenQuaternion) addComponent(e,TweenComponent) It then populates the two components with the values passed as parameters. Returns the new tweening entity, e. From a JS or TS script, use TweenService.addTween without a type.

    Parameters

    Returns Entity

Static addTweenVector2

  • Creates a new tweening entity with a TweenVector2 component and a TweenComponent component. This a helper function that does the following: e = createEntity addComponent(e,TweenVector2) addComponent(e,TweenComponent) It then populates the two components with the values passed as parameters. Returns the new tweening entity, e. From a JS or TS script, use TweenService.addTween without a type.

    Parameters

    Returns Entity

Static addTweenVector3

  • Creates a new tweening entity with the TweenVector3 component and a TweenComponent component. This a helper function that does the following: e = createEntity addComponent(e,TweenVector3) addComponent(e,TweenComponent) It then populates the two components with the values passed as parameters. Returns the new tweening entity, e. From a JS or TS script, use TweenService.addTween without a type.

    Parameters

    Returns Entity

Static removeAllEndedTweens

  • removeAllEndedTweens(world: WorldBase): void
  • Helper function that removes all tween entities that have stopped playing. You can use it to clean up after a level or transition sequence.

    Parameters

    Returns void

Static removeAllTweens

  • Helper function that removes all tween entities that reference target entity e.

    Parameters

    Returns void

Static removeAllTweensInWorld

  • removeAllTweensInWorld(world: WorldBase): void
  • Helper function that removes all tween entities in the world. You can use it to clean up after a level.

    Parameters

    Returns void

Static setValueColor

  • Sets a tweenable value. This is a shorthand helper function that writes the component data. temp = getComponentData(e,cid) temp[offset] = value setComponentData(e,temp) From a JS or TS script, use TweenService.setValue without a type.

    Parameters

    Returns void

Static setValueFloat

  • Sets a tweenable value. This is a shorthand helper function that writes the component data. temp = getComponentData(e,cid) temp[offset] = value setComponentData(e,temp) From a JS or TS script, use TweenService.setValue without a type.

    Parameters

    Returns void

Static setValueQuaternion

  • Sets a tweenable value. This is a shorthand helper function that writes the component data. temp = getComponentData(e,cid) temp[offset] = value setComponentData(e,temp) From a JS or TS script, use TweenService.setValue without a type.

    Parameters

    Returns void

Static setValueVector2

  • Sets a tweenable value. This is a shorthand helper function that writes the component data. temp = getComponentData(e,cid) temp[offset] = value setComponentData(e,temp) From a JS or TS script, use TweenService.setValue without a type.

    Parameters

    Returns void

Static setValueVector3

  • Sets a tweenable value. This is a shorthand helper function that writes the component data. temp = getComponentData(e,cid) temp[offset] = value setComponentData(e,temp) From a JS or TS script, use TweenService.setValue without a type.

    Parameters

    Returns void

Generated using TypeDoc