GenvidCommands

New in version 1.12.0.

header:Genvid/Public/GenvidCommands.h
implementation:Genvid/Private/GenvidCommands.cpp
class UGenvidCommands

The base class that allows you to subscribe to Commands Channel from the Genvid Stack.

Functions

virtual void Create()

Subscribe to all commands defined in this instance.

virtual void Destroy()

Unsubscribe to all commands on the instance destruction.

static UGenvidCommands *CreateCommands(...)

Factory for UGenvidCommands instances.

void InternalReceiveBeginPlay()

Acts as a superset of the AActor BeginPlay. It’s the first function called when the UGenvidCommands class is created.

Properties

TArray<FGenvidCommand> Commands

A list of FGenvidEvent to subscribe to.

bool bIsCreated

Read-only variable for reporting if the commands have been successfully subscribed to.

class FGenvidCommand

This class hold the name of the command to subscribe and its delegate.

Properties

FString Name

The name of the command to subscribe.

FOnGenvidCommand OnGenvidCommandDelegate
Display Name:Delegate

The delegate to call when the command is received.

class FOnGenvidCommand

An Unreal Dynamic Delegate with two parameters:

  • const FString& commandID: the id of the command.
  • const FString& fullCommand: the command as a single string.

The delegate is actually declared this way:

DECLARE_DYNAMIC_DELEGATE_TwoParams(FOnGenvidCommand, const FString&, commandID, const FString&, fullCommand))