Game Flow

SUPPORT/FEEDBACK/DONATE

EXAMPLE/SOURCE CODE

TUTORIAL

You can create all assets provided by this plugin via opening Content Browser context menu (with Right Mouse Button) and navigating to Gameplay category after plugin is installed. In the next sections all assets will be covered.

Game Flow - is main asset class which contains state machine. It is configured via Graph Editor by creating and editing nodes, links between them, setting properties on that nodes, links and asset itself. By default there is an Entry Node which defines state machine entry point.

Game Flow State - is the only node class available for user to add while editing Game Flow.

Game Flow State properties:

• [Sub Flow] - with this property user can include one Game Flow into another one, so building by this some hierarchy of Game Flows. Avoid referencing Game Flow by itself with this property - this can create execution logic cycle and cause problems.
• [Instanced Sub Flow] - If true, referenced [Sub Flow] will be used as template to create instance inside this state. If false, referenced [Sub Flow] will be used as shared flow. IS AVAILABLE ONLY WHEN [Sub Flow] IS SET
• [Reset Sub Flow On Enter State] - If true, referenced [Sub Flow] will be reset when this state is entered. IS AVAILABLE ONLY WHEN [Sub Flow] IS SET AND [Instanced Sub Flow] IS FALSE - INSTANCED [Sub Flow] IS ALWAYS RESET WHEN STATE IS ENTERED
• [Reset Sub Flow On Exit State] - If true, referenced [Sub Flow] will be reset when this state is exited. IS AVAILABLE ONLY WHEN [Sub Flow] IS SET AND [Instanced Sub Flow] IS FALSE - INSTANCED [Sub Flow] IS ALWAYS RESET WHEN STATE IS EXITED
• [Steps] - collection of Game Flow Step objects to execute when state is entered and exited, going from first to last when entering and vice versa when exiting. See Steps section below.
• [Transition Key] - if set, state will try to make transition with this Transition Key object after executing its [Steps]

While editing Game Flow user can select links between states via their labels.

Game Flow Transition properties:

• [Transition Key] - this property defines what Transition Key object will trigger thais transition.

Transition Key - is asset class for all objects that are used as keys to control transitions between states of Game Flows.

Game Flow Step - is base blueprint class for all objects that can be executed by Game Flows when entering and exiting their states. States contains [Steps] property, that stores collection of Game Flow Step objects to execute. Execution order is different when entering (from first step to last) and when exiting (from last step to first). That is similar to stack execution model.

User can create own subclasses of this class both in C++ and Blueprints. See pictures to check sync and async templates.

Game Flow Context - is an interface which provide some common mechanism to get and set values by keys. It is possible that user will need some data to be stored in the sense of place (globally/locally) and time (permanent/temporary) when using Game Flows. For example, there can be some state that is creating SaveGame for active game session. In this case, it will be needed to store that information somewhere globally while this game session is active. Although, it can be done with internal logic of user created subclasses of Game Flow Step, it also can be done based on Game Flow Context, achieving the same in more abstract and formal way.

Plugin contains default implementation for this interface based on Map.