Navigation
API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/TraitCore
Inheritance Hierarchy
- FAnimNextTraitEvent
- FAnimNextInertializationRequestEvent
- FAnimNextModule_ActionEvent
References
| Module | AnimNext |
| Header | /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/TraitCore/TraitEvent.h |
| Include | #include "TraitCore/TraitEvent.h" |
Syntax
USTRUCT (BlueprintType )
struct FAnimNextTraitEvent
Remarks
Trait Event
Encapsulates an event in the trait system. Events can be marked as handled to signal to future handlers that no further action needs to be taken. Consuming an event prevents it from propagating to other handlers.
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Creates a transient event. | |||
FAnimNextTraitEvent
(
UE::AnimNext::FTraitEventLifetime InLifetime |
Creates an event of the specified type and associated lifetime. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Allow typesafe destruction of derived types. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| const EventType * | AsType () |
Returns a pointer to this event cast to the specified type if the TypeUIDs match, nullptr otherwise. | |
| EventType * | AsType () |
Returns a pointer to this event cast to the specified type if the TypeUIDs match, nullptr otherwise. | |
| bool | DecrementLifetime
(
UE::AnimNext::FTraitEventList& OutputEventList |
Decrements the lifetime count and returns whether or not this event has expired in the process OnExpired will be called on the derived type if we expire and new output events can be appended | |
| UE::AnimNext::FTraitEventLifetime | GetLifetime () |
Returns the lifetime of this event. | |
| UE::AnimNext::FTraitEventUID | GetTypeUID () |
Returns the event type UID. | |
| bool | IsA () |
Returns whether or not this event derives from the specified type. | |
| bool | IsA
(
UE::AnimNext::FTraitEventUID InTypeUID |
Returns whether or not this event derives from the specified type. | |
| bool | IsConsumed () |
Returns whether or not this event has been consumed by a previous handler. | |
| bool | IsExpired () |
Returns whether or not this event has expired. | |
| bool | IsHandled () |
Returns whether or not this event has been handled by a previous handler. | |
| bool | IsInfinite () |
Returns whether or not this event has infinite duration. | |
| bool | IsTransient () |
Returns whether or not this event has transient duration. | |
| bool | IsValid () |
Returns whether or not this event is valid An event is valid if it hasn't been consumed and if it isn't expired | |
| bool | MarkConsumed () |
Marks this event as being consumed. | |
| bool | MarkHandled () |
Marks this event as being handled. | |
| void | OnExpired
(
UE::AnimNext::FTraitEventList& OutputEventList |
Called when an events' lifetime expires. | |
| void | SetLifetime
(
UE::AnimNext::FTraitEventLifetime InLifetime |
Sets the desired lifetime for this event. |