Table of Contents

Namespace Visual_Scripting

Classes

Action

Implements the "Interacting", "Combining" and "Custom" Action functionality of the TrainAR Framework, therefore it checks if the user triggered the "Interact", "Combine" Buttons or triggered a CustomAction through scripts and allows to check this against the stored state in the visual statemachine.

ActionFork

Implements the "Interacting", "Combining" and "Custom" Action functionality of the TrainAR Framework, therefore it checks if the user triggered the "Interact", "Combine" Buttons or triggered a CustomAction through scripts and allows to check this against the stored state in the visual statemachine.

This is the fork version of the action node. Therefore there are multiple correct answers and the stateflow enters a fork depending on which one is selected.

ActionMulti

Implements the "Interacting", "Combining" and "Custom" Action functionality of the TrainAR Framework, therefore it checks if the user triggered the "Interact", "Combine" Buttons or triggered a CustomAction through scripts and allows to check this against the stored state in the visual statemachine.

This is the multi version of the action node. Therefore all specified actions in this node have to be completed before advancing.

ActionUI

Implements the UI questionnaire functionality of TrainAR, therefore it triggers and checks against UI questions like text input fields, questionnaires, and question lists.

Conclusion

Triggers the Completion overlay that shows the training assessment of the scenario and ends the stateflow/training.

Feedback

Implements the "Feedback" functionality of the TrainAR Framework, therefore it triggers the error overlay modality to show feedback (e.g. for an incorrect important action).

Insights

Implements the "Insights" functionality of the TrainAR Framework, therefore it triggers the expert input modality to show additional insights and tips and optionally plays audio clips.

Instructions

Implements the "Instruction" functionality of the TrainAR Framework, therefore it updates the isntrutions and progress percentage of the Top panel.

ObjectHelper

The Object helper provides utility methods to toggle visibility, grabbability, interactability, and combinability of TrainAR objects, to destroy them, to get GameObject references to TrainAR object in the stateflow and many other utility functions.

OnboardingSetup

Adds an EventHook for the onboarding setup that is used to trigger the start of the visual scripting stateflow after the onboarding was completed.

VisualScriptingEventNames

Registering a string name for your custom event to hook it to an event. You can save this class in a separated file and add multiple events to it as public static strings.

Enums

Action.TrainARActionChoices

The type of interaction to check against.

ActionFork.TrainARActionChoices

The type of interaction to check against.

ActionMulti.TrainARActionChoices

The type of interaction to check against.

ActionUI.TrainARUIActionChoices

The type of UI questionnaire triggered and check against.

ObjectHelper.TrainARHelperChoices

The available helper utility to select on the "TrainAR: Object Helper" nodes menu.