Class YAnimators

Hierarchy

YAnimators

Constructors

constructor

new YAnimators(): YAnimators

Returns YAnimators

Methods

Static aimTo

aimTo(obj: YEntity | YLogic | YGroup, targetObject: YEntity | YLogic | YGroup, offset: YVector3, offsetIsRelative: boolean, maxSpeed: number, acceleration: number, distanceToStartRotation: number, distanceToEndRotation: number, x: boolean, y: boolean, z: boolean): void

Rotates selected animated object towards target object.

Parameters
- obj: YEntity | YLogic | YGroup
- targetObject: YEntity | YLogic | YGroup
- offset: YVector3
- offsetIsRelative: boolean
- maxSpeed: number
- acceleration: number
- distanceToStartRotation: number
- distanceToEndRotation: number
- x: boolean
- y: boolean
- z: boolean
Returns void

Static follow

follow(obj: YEntity | YLogic | YGroup, targetObject: YEntity | YLogic | YGroup, offset: YVector3, offsetIsRelative: boolean, maxSpeed: number, acceleration: number, distanceToStartMovement: number, distanceToEndMovement: number): void

Moves selected animated object towards target object.

Parameters
- obj: YEntity | YLogic | YGroup
- targetObject: YEntity | YLogic | YGroup
- offset: YVector3
- offsetIsRelative: boolean
- maxSpeed: number
- acceleration: number
- distanceToStartMovement: number
- distanceToEndMovement: number
Returns void

Static getController

getController(obj: YEntity | YLogic | YGroup): YController

Allows to get a reference to the Custom Controller Game Logic of the target object, if it has any attached.

Parameters
- obj: YEntity | YLogic | YGroup
Returns YController

Static getControllerParameterVariable

getControllerParameterVariable(obj: YEntity | YLogic | YGroup, variableName: String): any

Returns the value of selected paramater of target object.

Parameters
- obj: YEntity | YLogic | YGroup
- variableName: String
Returns any

Static getPositionAnimator

getPositionAnimator(obj: YEntity | YLogic | YGroup): YPositionAnimator

Returns current position animator of selected object.

Parameters
- obj: YEntity | YLogic | YGroup
Returns YPositionAnimator

Static getPossessedObject

getPossessedObject(player: YCharacter): YEntity | YLogic | YGroup

Returns object which is currently possesed by target player.

Parameters
- player: YCharacter
Returns YEntity | YLogic | YGroup

Static getPossessor

getPossessor(obj: YEntity | YLogic | YGroup): YCharacter

Returns the possesor (player) of target object.

Parameters
- obj: YEntity | YLogic | YGroup
Returns YCharacter

Static getRotationAnimator

getRotationAnimator(obj: YEntity | YLogic | YGroup): YRotationAnimator

Returns current rotation animator of selected object.

Parameters
- obj: YEntity | YLogic | YGroup
Returns YRotationAnimator

Static moveToSpeed

moveToSpeed(obj: YEntity | YLogic | YGroup, targetPosition: YVector3, speed: number, smoothing: number): void

Moves the animated object to the target position at specified speed.

Parameters
- obj: YEntity | YLogic | YGroup
- targetPosition: YVector3
- speed: number
- smoothing: number
Returns void

Static moveToTime

moveToTime(obj: YEntity | YLogic | YGroup, targetPosition: YVector3, time: number, smoothing: number): void

Moves the animated object to the target position in specified time.

Parameters
- obj: YEntity | YLogic | YGroup
- targetPosition: YVector3
- time: number
- smoothing: number
Returns void

Static rotateToSpeed

rotateToSpeed(obj: YEntity | YLogic | YGroup, targetRotation: YVector3, speed: number, smoothing: number): void

Rotates the animated object to the target rotation at specified speed.

Parameters
- obj: YEntity | YLogic | YGroup
- targetRotation: YVector3
- speed: number
- smoothing: number
Returns void

Static rotateToTime

rotateToTime(obj: YEntity | YLogic | YGroup, targetRotation: YVector3, time: number, smoothing: number): void

Rotates the animated object to the target rotation in specified time.

Parameters
- obj: YEntity | YLogic | YGroup
- targetRotation: YVector3
- time: number
- smoothing: number
Returns void

Static setController

setController(obj: YEntity | YLogic | YGroup, customController: YController): void

Allows to attach a Custom Controller Game Logic to the target object.

Parameters
- obj: YEntity | YLogic | YGroup
- customController: YController
Returns void

Static setControllerParameterVariable

setControllerParameterVariable(obj: YEntity | YLogic | YGroup, variableName: String, variableValue: any): void

Allows to set the custom controller to the target *object, allowing it to be possessed by a player.

Parameters
- obj: YEntity | YLogic | YGroup
- variableName: String
- variableValue: any
Returns void

Static setPositionAnimator

setPositionAnimator(obj: YEntity | YLogic | YGroup, positionAnimator: YPositionAnimator, timeOffset: number): void

Allows to assign position animator to selected object.

Parameters
- obj: YEntity | YLogic | YGroup
- positionAnimator: YPositionAnimator
- timeOffset: number
Returns void

Static setPossessedObject

setPossessedObject(player: YCharacter, value: YEntity | YLogic | YGroup): void

Allows to set object to be possesed by target player.

Parameters
- player: YCharacter
- value: YEntity | YLogic | YGroup
Returns void

Static setRotationAnimator

setRotationAnimator(obj: YEntity | YLogic | YGroup, rotationAnimator: YRotationAnimator, timeOffset: number): void

Allows to assign rotation animator to selected object.

Parameters
- obj: YEntity | YLogic | YGroup
- rotationAnimator: YRotationAnimator
- timeOffset: number
Returns void

Static stopMovement

stopMovement(obj: YEntity | YLogic | YGroup): void

Stops any movement instruction or animator that is currently assigned to the object.

Parameters
- obj: YEntity | YLogic | YGroup
Returns void

Static stopRotation

stopRotation(obj: YEntity | YLogic | YGroup): void

Stops any rotation instruction or animator that is currently assigned to the object.

Parameters
- obj: YEntity | YLogic | YGroup
Returns void

Generated using TypeDoc