Behavior Simulation Node Library#
The omni.anim.behavior.tree extension provides the behavior simulation node library. These are nodes available for use when the Behavior Tree extensions (omni.behavior.tree.bundle) are enabled.
Action Nodes#
Action nodes are leaf nodes that perform work and return a status.
Type |
Description |
Ports |
|---|---|---|
Idle |
Agent task to stand idle. |
facing · float3 or SdfPath · optionalduration · float · default 0.0 |
MoveTo |
Agent task to move to a target. |
target · float3 or SdfPathauto_brake · bool · default true |
MoveAlong |
Agent task to move along a basis curve. |
target · SdfPathstart_from_closest_point · bool · default falseauto_brake · bool · default true |
Follow |
Agent task to follow a target. |
target · SdfPathdistance · float · default -1.0 |
Dodge |
Agent task to dodge towards a direction. |
direction · float3 · default 0.0, 0.0, 1.0motion_scale · float · default 1.0 |
Fall |
(Experimental) Agent task to fall to the ground with ragdoll physics. Only available when |
(none) |
Sit |
Agent task to sit on a target. |
target · SdfPathsnap_to_seat · bool · default false |
PickupObject |
Agent task to pick up an object. |
target · SdfPathsnap_to_hand · bool · default false |
PlaceObject |
Agent task to place a held object. |
target · SdfPathxform · SdfPath |
ReleaseObject |
Agent task to release a held object. |
target · SdfPath |
LookAt |
Agent task to look at a target. |
target · SdfPathduration · float · default 0.0 |
ReachHand |
Agent task to reach a hand towards a target. |
hand_usage · enumtarget · SdfPathpalm_direction · float3 · optionalfinger_direction · float3 · optionalduration · float · default 0.0motion_scale · float · default 1.0 |
PoseHand |
Agent task to pose hands to a preset pose. |
hand_usage · enumpreset · enumduration · float · default 0.0 |
CustomAction |
Agent task to perform a custom action by imported action name. |
action · stringroot_animation · enumduration · float · default 0.0 |
Reset |
Agent will reset state at a target. |
target · float3 or SdfPathfacing · float3 or SdfPath · optional |
Teleport |
Agent will teleport to a target. |
target · float3 or SdfPathfacing · float3 or SdfPath · optional |
SetSpeed |
Sets the agent locomotion speed. |
speed · float · default -1.0 |
SetNavMeshAreas |
Sets the navmesh areas the agent is allowed to traverse. |
areas · string[] |
Modifier Types#
Modifiers attach to any node and wrap its execution. They support Abort Mode for reactive behavior (see Behavior Simulation User Guide for details on abort modes).
Type |
Description |
Input Ports |
Output Ports |
|---|---|---|---|
CheckTaskName |
Checks the name of the current running task. |
task_name · SdfPathinvert_condition · bool · false |
|
CheckAgentDistance |
Checks agent’s distance to a target within distance. |
target · SdfPathdistance · float · default 100.0comparison · enuminvert_condition · bool · false |
|
CheckNavMeshPathExists |
Checks if navigable path exists to a target. |
target · float3 or SdfPathinvert_condition · bool · false |
|
RandomNavMeshPoint |
Samples a random point on the navmesh. Value is cached until reset. |
center · float3 or SdfPath · optionalradius · float2 · optionalarea_probabilities · float[] · optional |