Open 3D Engine ScriptedEntityTweener Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Attributes | List of all members
ScriptedEntityTweener::ScriptedEntityTweenerRequests Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual void AnimateEntity (const AZ::EntityId &entityId, const AnimationParameters &params)=0
 Animate a property or properties on component(s) on an entity.
 
virtual void SetOptionalParams (float timeIntoAnimation, float duration, int easingMethod, int easingType, float delayTime, int timesToPlay, bool isFrom, bool isPlayingBackward, const AZ::Uuid &animationId, int timelineId, int onCompleteCallbackId, int onUpdateCallbackId, int onLoopCallbackId)=0
 Sets optional animation parameters to be used on next AnimateEntityScript call, needed as lua implementation doesn't support > 13 args in non-debug builds.
 
virtual void AnimateEntityScript (const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName, const AZStd::any &paramTarget)=0
 Script exposed version of the AnimateEntity call.
 
virtual void Stop (int timelineId, const AZ::EntityId &entityId)=0
 Stop all animations on an entityId, if timelineId is specified (non-zero), only stop animations associated with the timelineId.
 
virtual void Pause (int timelineId, const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName)=0
 Pause a specific animation, if timelineId is specified (non-zero), only pause for animations associated with the timelineId.
 
virtual void Resume (int timelineId, const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName)=0
 Resume a specific animation, if timelineId is specified (non-zero), only resume for animations associated with the timelineId.
 
virtual void SetPlayDirectionReversed (int timelineId, const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName, bool isPlayingBackward)=0
 Change direction an animation is playing, if timelineId (non-zero), only change for animations associated with the timelineId.
 
virtual void SetSpeed (int timelineId, const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName, float speed)=0
 Set playback speed for a specific animation, by percentage (1.0f is default, 2.0f is 2x as fast, 0.5 is half as fast).
 
virtual void SetInitialValue (const AZ::Uuid &animationId, const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName, const AZStd::any &initialValue)=0
 Set initial values for a specific animation with an animationId.
 
virtual AZStd::any GetVirtualPropertyValue (const AZ::EntityId &entityId, const AZStd::string &componentName, const AZStd::string &virtualPropertyName)=0
 Get current value.
 
virtual void Reset ()=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 
The documentation for this class was generated from the following file: