Articy.Unity Namespace

This contains all classes for the articy Importer for Unity plugin.

Classes

ArticyAssetCaretaker Small helper object to simplify the process of assigning Articy Assets to unity components.
ArticyBranchSortByPosition A sample branch sorting algorithm that sorts branches according to their flow position from top to bottom.
ArticyCustomFilterAttribute This attribute can be used to limit the available options on ArticyRefs object picker.
ArticyDatabase Access to all your imported articy data.
ArticyEnumValueInfo Type infos about the value of an enum ArticyType.
ArticyFlowPlayer Main flow traversal component. Used to automatically traverse the flow and notify about new branches and important objects.
ArticyHierarchyManager Gives basic informations about all articy objects in your project, exported or not, and their parent child relationship.
ArticyHierarchyNode Contains hierarchy informations about an articy object.
ArticyLanguage Contains information about a language
ArticyLocaCaretaker A helper object when dealing with localization and the unity ui.
ArticyLocalizationManager Manages and handles all localization data, settings and automatically takes care of loading and unloading necessary text repositories. Localization holds the instance that gets used by the plugin.
ArticyLocalizationPackage An storage class for localization data.
ArticyMultiLanguageString Class used for localizable string properties. Holds the loca key, a reference to the voice over asset, and additional information about the origin property. It will return the string and voice over asset localized in the current set language. Supports automaticially string interpolation via ArticyTextExtension.
ArticyNotificationManager Handles adding and removing of listeners to notify about changes of global variables.
ArticyObject The base class of all articy objects.
ArticyObjectNotificationManager Register callbacks to listen for object changes, with a variety of filter and options. Useful if you need to react to changes to any property change inside your articy:draft objects.
ArticyPackage An articy package containing models.
ArticyPackageDefinition Information about articy packages.
ArticyPrimitive A simple articy object is called a Primitive.
ArticyProject Imported information about the articy:draft user project.
ArticyPropertyInfo Contains meta information about a property of an ArticyType.
ArticyRef Used to expose articy objects safely in your unity components.
ArticyRefComplexAttribute This attribute can be used to display a full configurable ArticyRef with instance id and cloning options.
ArticyReference Component to hold a single ArticyRef.
ArticyRuntimeSettings Contains settings for the plugin that are used at runtime.
ArticyScriptCondition Value class for a script condition.
ArticyScriptInstruction Value class for a script instruction.
ArticyString Class used for non-localizable string properties. Holds the string value and additional information about the origin property. Supports automaticially string interpolation via ArticyTextExtension.
ArticyText Helper class that manages a text with localization and token resolving, with built-in databinding automatically refreshing the Text if a token source is changed. Check this article for an introduction.
ArticyTextChangedEvent UnityEvent class that is used when the Text of a ArticyText is changed.
ArticyTextComponent Component for an ArticyText. Use that if you don't want to create a custom script for a text.
ArticyTextExtension Text Extension manager class, containing the different Resolve methods for accessing the token resolving.
ArticyType Stores information about a generated articy type. With it you can access its property, template and additional type information similar to how reflection works in C#.
ArticyTypeConstraintAttribute This attribute can be used to limit the available options on ArticyRefs object picker.
ArticyTypeSystem Performant reflection system for all articy types.
BaseGlobalVariables Abstract base class for generated variable storages.
Branch Single choice inside the traversal logic.
PreviewImage Contains information about the preview image of articy objects.
StoredBaseVariable Base class for all stored variables
StoredBoolVariable Information about a boolean variable.
StoredIntVariable Information about a int variable.
StoredStringVariable Information about a string variable.
TextExtensionInternalMethods Contains implementations of methods that can be used in texts that gets resolved by the ArticyTextExtension.
Transformation Information about location transformations

Structures

ArticyChangedProperty Contains all infos about a changed property, called by the ArticyObjectNotificationManager
ArticyTextToken Contains info about a token for custom resolving

Interfaces

IArticyFlowPlayerCallbacks Interface used together with ArticyFlowPlayer for notification of flow traversal events.
IArticyPrimitive Base interface for all simple articy objects.
IArticyScriptFragment Base class for all script fragments.
IBaseScriptMethodProvider Base interface for the generated IScriptMethodProvider interface.
IFlowObject Base class for all traversable objects in the flow. (Nodes, Pins, Connections etc.)
IObjectCloning Interface for object cloning
IStoredVariable Interface containing information about a variable

Delegates

ArticyCustomFilterCallback Delegate used internally for ArticyCustomFilterAttribute
CustomTextLookup Used to override text lookup.
LanguageChangedEvent Delegate used when notifying the framework about a recent language switch.
OnBranchesUpdatedCallback Delegate used for onBranchesUpdated.
OnFlowPlayerPausedCallback Delegate used for onFlowPlayerPaused.

Enumerations

ArticyLogSubsystem Defines the different built-in systems that have their own logging.
ArticyLogVerbosity Flag to configure what kind of messages you want to see inside the logs.
ArticyPropertyConstraint Contains all types of constraints a property can have.
ArticyRefModes These define the modes for an articy reference.
ArticyTypeProperties All property reference locations
FlowPlayerFinishFlags Configure how the flow player works on stop nodes and branches.
PausableObjectTypes Describes what elements are valid stops for the execution engine
PreviewImageViewBoxModes Different view box modes for preview images.