Skip to end of metadata
Go to start of metadata

AI Behavior Tree

Allows users to specify, from a dropdown menu, the Behavior Tree an Entity should run.


Behavior Tree component

For Behavior Trees to appear within the dropdown menu however, they need to be saved under the Scripts/AI/BehaviorTrees directory of your project. Please refer to the Implementing The Behavior Tree in The Behavior Tree Editor section for an example.

SettingDescription
NameName of the behavior tree saved under the Scripts/AI/BehaviorTrees directory of your project. 

AI Cover User

The Cover User component works together with movement system and provides an ability to use covers for the entity. Covers are user designed objects (Cover Surface) placed in Sandbox.

SettingDescription
Min Effective Cover HeightMinimal effective height for the cover to be usable by the cover user and not to be compromised.
In Cover RadiusRadius used to block nearby cover locations when the agent is in cover.
Distance To CoverHow far the cover user can be from the exact cover location.
Blacklist TimeHow long the compromised cover location will be considered as not valid for further cover queries.

AI Faction

The Faction component stores the faction of the entity. Factions and their relations are defined in the Faction Map (Scripts/AI/Factions.xml).

SettingDescription
FactionHere you can choose the faction your entity belongs to.

AI Listener

The Listener component registers the entity to AuditionMap and makes it able to perceive sound stimuli. The component is notified when any interesting stimuli is heard.

Property/SettingDescription
Factions To Listen To

Only sound stimuli whose source entities belong to these factions will be processed.

Listening Distance Scale

An optional scale that can be applied to increase or reduce the listening distance.

Ear Locations

A collection of locations that will determine if the entity is within hearing range of sound stimuli. Can also be used to cast rays to these locations to determine sound obstruction fall-offs and such.

SettingDescription
Location typePivot or Bone.
Bone Name(if Location type is 'Bone') The name of the bone/joint from which to take the position
OffsetX, Y and Z coordinates for fixed offset from position.

Use Custom Filter

Whether the custom condition filter should be used (Schematyc 'ListenerCustomFilter' signal).

AI Navigation Agent

The Navigation Agent component gives the ability to navigate in space, finding paths to desired destinations, following them, and also trying to avoid collisions with other agents.

PropertyDescription
Navigation Agent TypeType of the navigation agent, specifying which NavMesh will be used by the agent (agent types are defined in Scripts/AI/Navigation.xml).
Update TransformationWhen set to true, the Navigation Component automatically updates the entity's transformation by computed requested velocity (position and rotation). When false, the requested velocity should be passed to other systems.

Movement

SettingDescription
Normal SpeedNormal entity speed.
Min SpeedMinimal output speed.
Max SpeedMaximal output speed.
Max AccelerationMaximum acceleration of the entity.
Max DecelerationMinimal acceleration of the entity.
Look Ahead DistanceHow far the entity looks ahead along the path.
Stop At EndAim to finish the path by reaching the end position (stationary) or simply overshoot.

Collision Avoidance

SettingDescription
Type
  • None - Agent doesn't contribute to collision avoidance.
  • Passive - Agent isn't trying to avoid obstacles but other agents consider him as an obstacle.
  • Active - Agent is actively trying to avoid obstacles.
RadiusRadius of the colliding agent.
HeightHeight of the colliding agent.

Navigation Query Filter

SettingDescription
Area Costs
  • Default - Costs multipliers set per each of the area types. During path-finding, paths that lead through triangles with lower costs are preferred.
Include Flags

Specifies which flags are accessible. At least one of these flags must be set in triangle to be accepted.

  • All - Selects all flags listed in this section.
  • None - Deselects all listed flags. 
  • Walkable - Created by the Navigation System by default, this flag is set upon all triangles in the NavMesh, when no special area type is specified within the NavMesh.
  • Inaccessible - Created by the Navigation System by default, this flag is set upon all triangles in the NavMesh that aren't accessible from any seed points placed in a map.

Custom flags must be defined in the Navigation.xml file located under ProjectFolder/Scripts/AI/.

Exclude Flags

Specifies which flags are forbidden. None of these flags must be set in triangle to be accepted.

  • All - Selects all flags listed in this section.
  • None - Deselects all listed flags. 
  • Walkable - Created by the Navigation System by default, this flag is set upon all triangles in the NavMesh, when no special area type is specified within the NavMesh.
  • Inaccessible - Created by the Navigation System by default, this flag is set upon all triangles in the NavMesh that aren't accessible from any seed points placed in a map.

Custom flags must be defined in the Navigation.xml file located under ProjectFolder/Scripts/AI/.

AI Navigation Markup Shape

The Navigation Markup Shape component is used to create markup shapes, allowing to 'mark' triangles in the NavMesh with various annotations (area types and flags). Annotations can be set in the Scripts/AI/Navigation.xml config file.

PropertyDescription
Ignore Geometry in MNMWhen activated, the Entity's geometry is ignored in NavMesh generation.
Shapes

Clicking on the dropdown menu icon next to the Shapes section will reveal a list including the following options:

OptionDescription
Insert Adds a new Shape on top of the list.
Add Adds a new Shape at the bottom of the list.
Remove AllRemoves all the Shapes that has been previously added to the list.

When a new Shape is added, following settings will appear on the Properties panel:

SettingDescription
Shapes Parameters
  • Name - Name of the shape. Needs to be unique among all defined shapes.
  • Position - Position offset of the shape relative to the owning entity's pivot.
  • Rotation - Rotation angles around axes in local space.
  • Area Type - Area type that should be applied to NavMesh. All flags defined for the area type are applied as well.
Affected Agent Types

Defines what agent type's NavMeshes should be affected by the Markup Shape. There are currently two agent types that can be affected by the Markup Shape, namely MediumSizedCharacters and VehicleMedium.

  • Size - Size of the rectangular shape in X, Y and Z coordinates.
  • Static - Set to true if the markup shape's triangles' annotation doesn't need to be modified at runtime.
  • Expand By Agent Radius - True if the marked area on NavMesh should be expanded by the agent radius.

AI Observable

The observable component registers the entity to VisionMap and makes it able to be "seen" by other entities that are registered as Observers.

PropertyDescription
Vision Map TypeCombination of flags to identify the type of the observable.

Observable Locations

Positions, offset from the pivot or bones, that are checked for visibilty by Observers.

SettingDescription
Location typeDefines if the location is set on Pivot or Bone.
OffsetX, Y and Z coordinates for fixed offset from position.
Bone NameAvailable when the Location type is set to Bone. Sets the name of the bone/joint from which to take the position.

AI Observer

The observer component registers the entity to VisionMap and makes it able to see other entities that are registered as Observables.

SettingDescription
Vision Map Type

Combination of flags to identify the type of the observer.

Vision

Configuration of the vision sensor with which the entity can observe the world.

SettingDescription
Field of ViewField of view in degrees.
Sight RangeThe maximum sight distance from the eye point to an observable location on an entity.
Location

Location of the eye sensor; offset from Pivot or Bone position).

SettingDescription
Location typeWhether the eye sensor is attached to a Bone or a Pivot.
Offset

Fixed offset from position.

Bone NameWhen the Location type is Bone, defines the name of the bone/joint from which to take the position.
Vision Blocking
SettingDescription
Blocked By SolidsIf enabled, vision ray-casts cannot pass through colliders that are part of solid objects that sometimes also denoted as hard cover.
Blocked By Soft CoverIf enabled, vision ray-casts cannot pass through colliders marked as soft cover. These are colliders that only block vision but you can still sit inside them. e.g. bushes, tall grasses, etc.
Types To Observe

Only entities that belong to these vision map types will be processed for sight.

Factions To Observe

Only entities that belong to these factions will be processed for sight.

Use Custom FilterWhether the custom condition filter should be used or not such as Schematyc's ObserverCustomFilter signal.

On This Page

  • No labels