Navigation
API > API/Plugins > API/Plugins/AnimNextAnimGraph > API/Plugins/AnimNextAnimGraph/PlayAnim
Inheritance Hierarchy
- FSharedFromThisBase
- TSharedFromThis
- FPlayAnimRequest
References
| Module | AnimNextAnimGraph |
| Header | /Engine/Plugins/Experimental/AnimNextAnimGraph/Source/AnimNextAnimGraph/Public/PlayAnim/PlayAnimRequest.h |
| Include | #include "PlayAnim/PlayAnimRequest.h" |
Syntax
struct FPlayAnimRequest : public TSharedFromThis< FPlayAnimRequest, ESPMode::ThreadSafe >
Remarks
PlayAnim Request
Instances of this class represent individual requests to the PlayAnim system. They are allocated as shared pointers and ownership is split between gameplay (until it no longer cares about a particular request) and the animation slot that plays it (until the request completes).
Use MakePlayAnimRequest(...) to construct instances of this type.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FAnimNextOnPlayAnimBlendingOut | OnBlendingOut | Callback called when the request starts blending out (if it wasn't interrupted) |
 |
FAnimNextOnPlayAnimCompleted | OnCompleted | Callback called when the request completes (status transitions from playing to completed) |
 |
FAnimNextOnPlayAnimInterrupted | OnInterrupted | Callback called when the request is interrupted (either by calling Stop on it or by another request) |
 |
FAnimNextOnPlayAnimStarted | OnStarted | Callback called when the request starts playing (status transitions from pending to playing) |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddReferencedObjects
(
FReferenceCollector& Collector |
GC API. |
  |
const FPlayAnimRequestArgs & | GetArgs () |
Returns the arguments this request is playing. |
 |
FPlayAnimRequestArgs & | Returns the arguments this request is playing. | |
  |
EPlayAnimStatus | GetStatus () |
Returns the request status. |
  |
FTimelineProgress | Returns the current timeline progress. | |
  |
bool | HasCompleted () |
Returns whether or not this request has completed (might have been interrupted) |
  |
bool | HasExpired () |
Returns whether or not this request has expired. |
  |
bool | Returns whether or not this request is blending out. | |
  |
bool | IsPlaying () |
Returns whether or not this request is playing (might be blending out or interrupted) |
 |
bool | Play
(
FPlayAnimRequestArgs&& InRequestArgs, |
Sends this request to the specified component and it will attempt to play with the requested arguments. |
 |
void | Stop () |
Interrupts this request and request that we transition to the source input on the playing slot. |
  |
bool | Returns whether or not this request was interrupted (by Stop or by another request) |