Static Methods

Description

A class that provides methods for interfacing with Animate Anything directly in Unity.

Example

Declaration

Parameters

Declarations

Parameters

Declaration

Parameters

Static Methods

Description

Top level namespace of the AnythingWorld package, holds main user facing functionality.

Static Methods

Description

Utility for building and passing parameters to the maker pipeline.

Declarations

 public static RequestParameterOption PlaceOnGrid(bool value)

Parameters

Description

Place object on grid.

Declarations

public static LegacyAnimatorInEditorOption LegacyAnimatorInEditorOption(bool value)

Parameters

Description

Make the object use the legacy animation system.

Declarations

public static AddRigidbody AddRigidbody()

public static AddRigidbody AddRigidbody(bool value)

Parameters

Description

Add Rigidbody to object.

Declarations

public static RequestParameterOption AddScripts(params Type[] scriptTypes)

public static RequestParameterOption AddScripts(params MonoBehaviour[] monobehaviours)

Parameters

Description

Specify scripts to add to object after creation process completed.

Declarations

public static RequestParameterOption IsAnimated(bool value)

Parameters

Description

Request model with animation system if available.

Description

Enum defining the different types of scaling modes when creating AnythingWorld objects.

Declarations

public static RequestParameterOption PlaceOnGround(bool value)

Parameters

Description

Set origin of object to the centre bottom of mesh bounds.

Declarations

public static RequestParameterOption TransformSpace(Utilities.TransformSpace space)

Parameters

Description

Define whether transformations (position, rotation) should be applied using world space or local space.

Declarations

public static RequestParameterOption Parent(Transform parentTransform)

Parameters

Description

Set parent GameObject for created model.

Declarations

public static RequestParameterOption Rotation(Quaternion quaternionRotation)

public static RequestParameterOption Rotation(Vector3 eulerRotation)

Parameters

Description

Set rotation of object transform.

Declarations

public static RequestParameterOption SetDefaultBehaviourPreset()

public static RequestParameterOption SetDefaultBehaviourPreset(DefaultBehaviourPreset behaviourPreset)

Parameters

Description

Choose whether to apply behaviours from a default or given preset.

Declarations

public static RequestParameterOption Scale(Vector3 scaleVector)

public static RequestParameterOption Scale(int x, int y, int z)

Parameters

Description

Set scale of object transform.

Declarations

public static RequestParameterOption Position(Vector3 positionVector)

public static RequestParameterOption Position(int x, int y, int z)

Parameters

Description

Multiply the default or defined scale value by this value.

Declarations

public static RequestParameterOption ScaleMultiplier(float scaleVector)

Parameters

Description

Multiply the default or defined scale value by this value.

Declarations

public static RequestParameterOption SerializeAsset()

public static RequestParameterOption SerializeAsset(bool value)

Parameters

Description

Serialize model assets to database on loading completion.

Declaration

public void Idle()

Description

Transition the object to the idle animation.

Declaration

public void JumpStart()

Description

Transition the object to the start of the jump animation.

Declaration

public void Walk()

Description

Transition the object to the walk animation.

Methods

Description

A class that handles sending plain text commands to our parsing API and then returning the parsed commands to users and handling the command.

Declaration

public static RequestParameterOption OnFailAction(Action action)

Parameters

Declaration

Parameters

Description

Pass an action into make process that will be invoked on a failed model creation or request.

Declarations

public static RequestParameterOption ScaleType(Utilities.ScaleType scaleType)

Parameters

Description

Multiply the default or defined scale value by this value.

Declaration

private static IEnumerator RequestAndReturnCommand(string input, Action<string> ReturnAction)

Parameters

Description

Requests a command from a plain text input string and returns the resulting command as a JSON-formatted string.

Declaration

 public static void RequestCommand(string input, Action<string> ReturnedCommandAction = null)

Parameters

Description

Requests a command from a plain text input string and handles resulting command through CommandHandler utility.

Description

Namespace holding scripts handling speech-to-text, text-to-speech and command parsing functions.

Classes

Description

Namespace holding utility functions that are used throughout the different modules of the AnythingWorld package.

Classes

Declarations

public static RequestParameterOption ClampDatabaseScale(Vector3 upperBound)

public static RequestParameterOption ClampDatabaseScale(Vector3 lowerBound, Vector3 upperBound)

Parameters

Description

Clamp database scale between given values.

Public Methods

Properties

Description

Declares utility enums that are used throughout the project for creation processes.

Declaration

public static GameObject Make(string name)

Parameters

Description

This method allows users to request an object from the Anything World database and have it instantiated in the scene according to the parameters they pass in. If no parameters are passed in the default parameters will be used.

Users can provide RequestParams, that can be created using the RequestParameter class.

Example

Declaration

public static RequestParameterOption OnSuccessAction(Action action)

Parameters

Declaration

Parameters

Description

Pass action into make process that will be invoked on a successful model creation.

Public Methods

Declaration

public void BlendAnimationOnSpeed(float speed)

Parameters

Description

Blend between the different movement speeds of the object (Idle, Walk, and Run)

Declaration

public void Land()

Description

Transition the object to the end of the jump animation.

A Behavior Tree (BT) is a hierarchical structure that defines the decision-making process of an AI agent. It consists of nodes that represent tasks or behaviors, which are executed based on certain conditions. The tree is traversed from the root node down to the leaf nodes, with each node returning Success, Failure, or Running status. Behavior Trees help you structure the decision-making logic of your agent, making complex behaviors manageable and understandable via visual representation.

Main Concepts

1. Action Nodes

Action nodes are the leaf nodes of the Behavior Tree. They represent the actual tasks or behaviors that the AI agent can perform. When an action node is executed, it attempts to carry out a specific action, such as moving to a target, attacking an enemy, or playing an animation.

2. Composite Nodes

Organizational nodes that control the execution flow of their child nodes. There are several types of composite nodes, including:

• Sequence: Executes its child nodes in order until one fails. If all child nodes succeed, the sequence node succeeds.

• Selector: Attempts to execute its children one by one until one succeeds. It's used for selecting between different behaviors based on their success.

• Parallel: Executes all its child nodes simultaneously and succeeds if a specified number of child nodes succeed.

For example you can have a "FindAndAttackEnemy" sequence node with two child nodes: "SearchForEnemy" and "AttackEnemy". The sequence node would first execute the "SearchForEnemy" node to locate an enemy. If an enemy is found, it would then execute the "AttackEnemy" node. If both child nodes succeed, the sequence node succeeds.

3. Decorator Nodes

Modifiers that alter the behavior or outcome of their child nodes. They can be used to repeat actions, invert success/failure, or conditionally execute based on certain criteria. Common types of decorator nodes include:

• Inverter: Inverts the success/failure status of its child node.

• Repeater: Repeats the execution of its child node a specified number of times or until a condition is met.

• Conditional: Executes its child node only if a specified condition is true.

A repeater node can execute the "AttackEnemy" node multiple times, allowing the AI agent to perform consecutive attacks.

4. Blackboard

The Blackboard is a global data store that allows nodes to share information and state across the Behavior Tree. It acts as a key-value store, where nodes can read and write data. The Blackboard is useful for storing variables such as target positions, health values, or any other relevant information that nodes might need to access.

Declaration

public void Run()

Description

Transition the object to the run animation.

Declaration

public void PlayAnimation(string animationName)

Parameters

Description

Play a new animation.

Declaration

public void StopAnimations()

Description

Stop all animations.

Declaration

public void JumpFall(bool fall)

Parameters

Description

Transition the object to the falling animation.

Declaration

public void Idle()

Description

Transition the object to the idle animation.

Declaration

public void Fly()

Description

Transition the object to the flying animation.

Declaration

public void CrossFadeAnimation(string animationName)

Parameters

Description

Crossfade between the current animation and another animation.

Public Methods

Declaration

public IEnumerator Wait(float seconds, Action callback)

Parameters

Description

Controller waits a set length of seconds and then does a function call.

PathCreator is a tool for creating Bezier curve splines in the Scene view. These splines can be used to represent a path agents use to move. You can place objects and meshes along it for example to create roads. Read more about Bezier curve and how it is defined parametrically here or watch this in-depth video.

Getting started

To start creating a spline add a PathCreator component to any game object. Default spline with two anchors and two control points will be added to the scene.

Anchors and control points

Each segment of the spline is defined by two anchor points that determine the start and the end of the spline and two control points tied to anchors that determine the shape of the spline . When more segments are added intermediate anchors have two control points each determining the shape of neighbouring spline segments. To keep the spline curve smooth those control points are usually tied to each other and placed on a straight line but it's possible to change that using different Control Modes.

Control Modes

To have more control over the spline shape you can choose how a control point opposite the one you are manipulating behaves:

• Mirrored mode will place the opposite control at the same distance from anchor and directly opposite direction as the manipulated one.

• Aligned mode changes the direction of the opposite control but keeps the original distance to anchor intact.

• Free mode completely decouples two controls and allows changing them independently.

Snap to Surface

Enables snapping of anchor and control points to the nearest surface. It can be useful if you want to create a ground path on an uneven surface. Snap mode uses anchor position to calculate the snapped positions of related controls so make sure to snap the anchor first by moving it until it snaps to the surface you want.

For best snapping accuracy it's recommended to manually set up Surface Orientation in corresponding dropdown.

Path Space

Choose between creating splines in 3D or 2D space, with 2D splines restricted to the XZ plane. Snapping is only available in 3D space.

Normals

Opening Normals Options section will make normals visible. They determine the orientation of objects placed on a spline or moving along it. While you can set the global angle of normals it's also possible to fine tune them for each segment by clicking on anchor and enabling Unity's rotation tool by clicking on corresponding icon or pressing "E".

Display Options

Constant Point Size makes it so that control and anchor points keep the same size when moving closer or farther from spline.

Global settings that also exist in Path Options (snap to surface, etc.) determine defaults when path is created or reset.

Deselect When Clicking Outside Spline determines if selection is changed if you click on empty space or other game object. If it's disabled you need to click anywhere in the Hierarchy window to deselect PathCreator object.

Editing spline segments

• Append: Shift + Left Mouse Button (LMB).

• Prepend: Ctrl + Shift + LMB or Command + Shift + LMB on Mac.

• Divide: Shift + LBM over a segment.

Vertex Path

While Bezier Path tab shows a visualization of the spline, Vertex Path shows an actual curve that is created by sampling the curve equation at certain intervals. This allows to get a set of vertices which can be used while moving or placing objects along spline.

Vertex Path Options determine how close the resulting curve will resemble the original one. Changing the margins of error will reduce the Vertex count making it more lightweight while losing some degree of fidelity.

Moving agents along spline

We've created a simple SplineMovement behaviour tree with MoveAlongSpline node. The code behind this node shows how spline points can be sampled programmatically to determine position and orientation of the agent on the spline. Example behaviour tree can be found at Assets/AnythingWorld/Examples/BTMovement. To see it in action open and run RandomMovement scene from the same folder. You can also see a more specific use case by downloading Extra scenes package from the bottom of your and running City_Day scene.

You can also add this BT to any game object to make it move along spline. Adding behaviour trees is explained in the previous section of documentation. After adding the BehaviourTreeRunner component and choosing SplineMovement as the BT you want to run, you also need to add a MovementDataContainer script which contains a field for PathCreator. Add your game object containing PathCreator component to this field and you are good to go.

Creating a path programmatically

It is also possible to create a spline programmatically at runtime by using one of the constructors in BezierPath class. All you need to do is supply it with a set of 2d or 3d points and optionally specify if you want the spline path to be forming a loop and space of the path to be 3d or 2d.

1. Included Shaders

When building projects that only use the runtime scripting API Unity will cull shaders that are not in use, so it's recommended to go to Project Settings > Graphics and add the default shaders used in the AW pipeline.

• Standard (Metallic)

• Standard (Specular)

• Standard Transparent (Metallic)

• Standard Transparent (Specular)

2. MacOS Microphone Permissions

Some platforms including mobile and MacOS require a Microphone Usage description for builds that include microphone usage, this will usually be shown to users in a popup format when requesting microphone access.

To do this, navigate to Project Settings > Player > Other Settings > Mac Configuration > Microphone Usage Description.

Description

Namespace holding scripts handling animation import and controllers.

Classes

Opening the editor

The Behavior Tree Editor can be accessed by either double-clicking an existing tree asset or through the tab located in AnythingWorld -> Behavior Tree Editor.

Behaviour Tree Editor can be opened via double clicking on existing tree asset or opening the tab in AnythingWorld -> Behaviour Tree Editor.

User interface overiew

Node View

Displays behavior tree nodes and the edges connecting them. This area allows users to interact with the nodes, connect them to each other and visualize the tree structure.

Node Inspector

Shows data associated with the currently selected node. Some fields are presented as dropdowns linked to blackboard keys, they have a special type of NodeProperty which allows them to interact with blackboard keys. Other fields are standard Unity serialized fields.

Working with nodes

Adding a node

To add a node, right-click on anywhere in the node view and select the desired node from the context menu. You can also start typing the name of the node to filter the list.

Editing node code

Double-clicking on a node opens the code associated with it, allowing direct modifications to its behavior.

Auto-scaling

Pressing "A" will auto-scale the node view to occupy the available window space fully, enhancing visibility.

Behaviour Trees management

Accessing behaviour trees

Clicking on the Asset menu in the upper left corner reveals a list of all behavior trees in the current project and provides an option to create new ones.

Global settings

• New nodes and trees are saved to default locations specified in the global BT settings, found at Assets/AnythingWorld/AnythingBehaviour/BehaviourTreeProjectSettings.asset.

• Enable Node Values Copying setting determines whether node's field values will be deep copied when copy pasting nodes in node view.

Integration and runtime behaviour

Adding to GameObjects

• To use a behavior tree with a GameObject, add the BehaviourTreeRunner component and select the appropriate tree. Once you add a tree it is automatically instantiated so you can edit it without changing the original asset.

• BehaviourTreeRunner also allows adding blackboard overrides for any blackboard keys BT has. This is useful if you want to change parameters like speed without opening and editing a BT.

• Overrides are applied when entering playmode so they need to be setup beforehand.

• Animated models in AnythingWorld Model Browser are imported with preset movement BTs depending on the model type. These default BTs can be changed via Make Options. You can also enable NavMesh usage which will make ground animals move using existing NavMesh or a generated one in case there is none in the scene.

Execution flow visualization

When a scene is played, a runtime copy of the tree is created. If you've opened a Behaviour Tree Editor window before running the scene,d clicking on a GameObject with an active tree will visualize the execution flow, with colors indicating the state of each node. Yellow denotes nodes that returned Running state, green - nodes that returned Success state and red - nodes that returned Failure.

Compatibility

Behavior trees should be created in the lowest Unity version they will be used with, as there is no downward compatibility between versions. You can see the lowest Unity version AnythingWorld currently supports .

Extending Behaviour Tree with code

Adding new node types

New node types can be added either through the context menu in the node view or by creating a new C# class that inherits from Action, Decorator, or Composite types. These classes must implement OnStart(), OnStop(), and OnUpdate() functions, with OnUpdate() returning one of the node states.

Shared context

Each node class has access to a shared context field which is an instance of Context class that stores commonly used components and subsystems. It is created from the game object that you attached BehaviourTreeRunner component to. You can extend it by adding components that you want all nodes to have access to like Colliders, RigidBodies, etc.

Converting field to NodeProperty to enable blackboard interaction

To enable any field of a node to read or write to a blackboard key you must declare it as a NodeProperty<T> where T is the type of the property you want to declare, e.g. NodeProperty<float> speed. You can set a default value via constructor like so: NodeProperty<float> speed = new NodeProperty<float>(4). If you have a blackboard key of the same type it's possible now to associate speed NodeProperty with that key by choosing it from a dropdown in Node Inspector.

Adding new blackboard key types

Opening Type dropdown when creating a new key will show most of the common C# and Unity types. However if you find some types lacking you need to add them manually by opening BlackboardKeyTypes.cs file and adding your type following the existing pattern.

Moving agents with behaviour trees

You can find example random movement BTs for all types of AnythingWorld agents underAssets/AnythingWorld/Examples/BTMovement. To see them in action open and run RandomMovement scene from the same folder. There is also MoveAlongSpline BT which is explained in Path Creator documentation section.

All the random movement BTs follow the same logic:

1. Generate a random position via random position node.

2. Write it into a blackboard key.

3. Use that position as movement destination in a MoveToDestination node.

However these nodes and their settings vary depending on the model type. The only variables common to all movement nodes and goal generation nodes are the following:

• Min / Max Goal Spawn Radius - min / max random goal distance from agent's position.

• Speed - initial speed of the agent.

• Scale Speed With Model Speed - should we multiply the Speed by speedScalar? speedScalar is calculated from speed data specific to imported model.

Ground agents movement

Both ground animals and vehicles have settings for movement and turning speed. However ground animals are also able to jump hence GroundAnimalMoveToGoal node in GroundAnimalRandomMovement tree has additional jump settings explained below:

• Jump Detector Size - the distance at which an agent will try to detect an obstacle and either avoid it or jump on it. Consequently determines the distance between jump starting point and obstacle.

• Scale Jump With Model Height - will decrease or increase both Max Jump Height and Jump Detector Size proportional to model's height.

• MaxSlope - maximum slope of the surface an animal able to traverse. Any surface with slope above max is processed as an obstacle that will be avoided or jumped on.

You will notice that the movement node of GroundAnimalNavMesh tree has almost no jump settings. That's because NavMesh is used to calculate optimal routes and there cannot be arbitrary changes to movement trajectory. Jump areas must be explicitly defined via NavMeshLinks explained .

Flying and swimming agents movement

While movement speed and rotation settings resemble previously discussed agents, goal generation has an added height constraint. Flying agent's AerialRandomGoal node has:

• Ground Y Coordinate which defines the ground level with global Y coordinate.

• Min / Max Flying Height - min / max height relative to ground. So if you have ground level set at 5 and min height set at 2, the agent's min flying height will be 7.

Swimming agents are similar but always stay below water surface. Hence FishRandomGoal node has only Surface Y Coordinate and Swimming Depth which is also relative to the surface.