Navigation
API > API/Plugins > API/Plugins/AvalancheMedia
Base class for page commands.
this API is experimental.
| Name | FAvaRundownPageCommand |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMedia/Public/Rundown/AvaRundownPageCommand.h |
| Include Path | #include "Rundown/AvaRundownPageCommand.h" |
Syntax
USTRUCT (BlueprintType )
struct FAvaRundownPageCommand
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAvaRundownPageCommand() |
Rundown/AvaRundownPageCommand.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanExecuteOnLoad
(
FAvaRundownPageCommandContext& InContext, |
Returns true if the command can be executed. Used by UI for button status. | Rundown/AvaRundownPageCommand.h | |
virtual bool CanExecuteOnPlay
(
FAvaRundownPageCommandContext& InContext, |
Returns true if the command can be executed. Used by UI for button status. | Rundown/AvaRundownPageCommand.h | |
virtual bool ExecuteOnLoad
(
FAvaRundownPageCommandContext& InContext, |
Execute the command when a page is loaded. | Rundown/AvaRundownPageCommand.h | |
virtual bool ExecuteOnPlay
(
FAvaRundownPageTransitionBuilder& InTransitionBuilder, |
Execute the command when a page is played. | Rundown/AvaRundownPageCommand.h | |
virtual FText GetDescription() |
Returns this command's description. Used for page summary. | Rundown/AvaRundownPageCommand.h | |
| Returns a string representing the transition layers. This is used for the page list "layer" column. | Rundown/AvaRundownPageCommand.h | ||
virtual bool HasTransitionLogic() |
Returns true if the command will act as transition logic. | Rundown/AvaRundownPageCommand.h |