Behaviors & Navigation Archives - RIDE

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Important

This example utilizes the A* Pathfinding Project Pro package which can be obtained from the Unity Asset Store. This solution is optional for RIDE users currently.

Example Scene

Purpose

Observe the movement behavior of multiple units under the A* Pathfinding movement system option.

How to Use

The terrain panel appears by default on scene launch and is divided into the following options:

GUI Debug Menu Navigation

Top Options

Toggle format of terrain maps; use the arrows to select between Split LMAB (default) and Single LMAB formats. System/System2 display various real-time stats.
Note, recommend Split LMAB for most users.

General

Clear Terrain – Removes an in-progress or completely loaded terrain map from the scene.
Clear Data Cache – Removes …\AppData\LocalLow\USC-ICT\Ride\datacache folder; use this command in the event terrain maps fail to load properly.
Center Camera – Places the camera at the defined map center of the terrain map.

Load Terrain

Load Trees – Click to toggle off/on. Replaces low-detail tree geometry in the map with various high-fidelity SpeedTree objects; note, may not be available in all maps.
Use Camera Pos As Start – Terrain map streams into scene from approximate scene camera location; used in conjunction with Radius slider.
Radius – Adjust the slider to change the distance at which terrain tiles are rendered from the current camera position.
CPU Usage: Adjust the slider to allocate more resources to the loading of terrain tiles. A higher value may cause the editor to be unresponsive for several seconds as it attempts to render many tiles at once. Recommend the default value of 20%.
Use Asset Bundles – Unity Asset Bundles are the recommended and default delivery method of terrain map data.
Progress – Indicator of approximate completeness for the streaming of the current terrain map into the scene.
Time – Tracks how long the terrain map took to stream into the scene, reaching 100% completion.
Plane – Instances a simple plane object for test purposes; note, does not have tree objects.

Tip If steaming terrain on a mobile device (Android/iOS) strongly recommend setting the Radius to a value of < 800 to avoid running out of device memory.

Load Terrain – Split LMAB Format & LOD

Select a terrain map, choose a LOD setting (lowest selected by default).
Select a Collider. Note, a value other than “None” must be selected in order to enable pathfinding for units. Click Load Terrain to begin streaming that terrain map data into the scene. Overall progress statements incrementally appear until loading finishes (1.0 value).

Load Terrain – Single LMAB Format & LOD

Select a terrain map, choose a LOD setting (lowest selected by default).
Click Load Terrain to begin streaming that terrain map data into the scene. Overall progress statements incrementally appear until loading finishes (1.0 value).

Important The steaming of Single LMAB terrain maps, with the exception of those with the “s3” location designation, only function while on the ICT domain. If remote, ensure your ICT VPN is active.

Tip

Navigation Controls:

WASD keys – Move the camera forward/backward/left/right
Q/E keys – Lower and raise the camera
Use the J key to toggle “free-look” mouse cursor control

Press F11 on Windows platform to toggle off/on the terrain loading menu. Use the top arrows in the debug menu to switch between the other system menus.

Unit Movement Commands

Drag-select single or multiple agents by left-click, and then direct agent(s) to a waypoint on the terrain designated by right-click of the mouse. Agents will navigate around obstacles to reach a set waypoint and stop. Navigation of agents can be interrupted by another right-click of the mouse; agents will then navigate to that new waypoint location.

Scene Location & Name

Assets/Ride/Examples/AstarPathing/ExampleAstarPathing.unity

Setup Requirements

Utilize the terrain loading capability with debug menu and unit instantiation for your scene with the ExampleAstarPathing script.

ExampleAstarPathing Script

Simply add this script to an empty game object in your scene: Assets/Ride/Examples/AstarPathing/ExampleAstarPathing.cs

Spawn Locations

Add empty game objects to the scene to serve as spawn points, which are then referenced in ExampleAstarPathing.cs.

Manually Enable A* Pathfinding

The A* Pathfinding Project Pro package is now available as an alternative to using Unity’s native Pathfinding solution. Future releases may have this option be the default.

In order to enable the A* Pathfinding option, go into the RideSystems prefab.
Select the UnityNavMeshMovementSystem.
In the Inspector, at the top, to the left of its name, de-select the checkbox. This disables the system.
Now, select the UnityAStarMovementSystem and select the checkbox. This enables the system.

Known Issues

Not quite feature par with Unity’s solution
Still working on loading/caching features
Units have trouble navigating on certain terrains

Future Benefits Since the navigation is loaded at runtime, there’s no need to generate a navmesh offline. This eliminates the cumbersome step of generating a navmesh for each scene. It’s possible to now load multiple terrains within a single scene. Instead of a TeamMatch scene for each terrain dataset, there could exist e a single scene, with a menu option to choose which terrain to load.

Setting up A* Pathfinding Navigation

Caching navigation graphs

In this method, navigation graphs are saved to a cache file. This is somewhat similar to baking a navmesh in Unity’s default navigation system.

Open the scene that you want to save the navigation graphs to.
In the Hierarchy, go to the UnityAStarMovementSystem game object in the RideSystems prefab.
Look at the Pathfinder component in the UnityAStarMovementSystem game object. You should see three graphs already in Pathfinder component, Dismounted, Wheeled, and Tracked.
For each graph, check the bounds of the navigation mesh and edit them if needed. Click Snap bounds to scene to automatically set bounds using the existing 3D meshes in the scene, or adjust the Center, Size, and Rotation fields as needed. If you want to ignore meshes when snapping bounds automatically, you can either temporarily disable the mesh’s game object, or use a layer mask. The graph’s bounds will appear as a white box in the scene, provided that the view has gizmos activated.
Click Scan at the bottom of the Pathfinder component to begin scanning the navmesh.
Once the process is finished, check to make sure your graphs are where you want them. Click the eye icon for each graph to hide them to aid in visual inspection. (Make sure Show Graphs is checked on if you want to see graphs)
Disable the Scan on Awake option in the Settings tab of the Pathfinder component. If this is not disabled, the scene will rescan the scene at runtime and will ignore the scan we had just made.
In the Save & Load tab of the Pathfinder component, click Generate Cache to create a .bytes file that will contain our navigation mesh info for this scene. Unity will ask if you want to scan for meshes before generating the cache. Since we just did that ourselves, you can click No. The cache file will be stored in Assets/GraphCaches. Rename this file in editor if you’d like. Make sure Cache startup is checked and that the cache file is assigned.
Save the scene to keep your changes to the Pathfinder component.
The scene should now use the graphs that you just scanned at runtime.

The post A* Pathing appeared first on RIDE.

Battle Drills – React to Ambush – Near

Andrew Leeds — Fri, 09 Apr 2021 00:27:14 +0000

Behaviors & Navigation

Battle Drills - React to Ambush - Near

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Example Scene

Purpose

Demonstrate various ICT S&T research lines in a well-known format with very specific pass/fail parameters and training objectives.

How to Use

When the scene launches, allow time for the terrain map assets to complete streaming. The first button prompt for setup will appear when finished.

Sequence Customization Steps

Add OPFOR

Click the button, then click a point on the terrain to instance a group of OPFOR agents.

Add OPFOR Kill Zone

Click the button, then click a point on the terrain to set the OPFOR Kill Zone. The ambush will occur when BLUFOR units enter this zone. Recommend placement “near” the OPFOR group.

Add BLUFOR

Click the button, then click a point on the terrain to instance a group of BLUFOR agents. Ensure the location is well outside of the OPFRO Kill Zone. Recommend placement behind a structure that obscures visual line-of-sight to OPFOR initially.

Add BLUFOR Patrol Point

Click the button, then click a point on the terrain for the BLUFOR agents to navigate toward. Ensure this location is either within the Kill Zone itself, or will cause BLUFOR to intersect it.

Now the sequence will initialize with the BLUFOR agents navigating to the patrol point, and will approach/enter the kill zone where the ambush portion will begin.

Input Controls – PC

Keyboard & Mouse

General Controls

F12 releases/constrains cursor to/from window
F11 toggles off/on debug/system menus
Step to the next menu be either clicking the middle title bar or arrows (<>) at the top
System statistics appear in subsequent menus
~ key toggles the console tool

Camera Controls

Hold right-click and move cursor to rotate camera
Press WASD keys to move camera
Press QE keys to rotate camera left/right (yaw)
Press TG keys to rotate camera up/down (pitch)
Hold Shift to increase camera movement speed
Hold Space bar to raise camera
Hold Ctrl to lower camera

Tip

First-Person Observer Controls:

Click an agent to select them (green ring appears at their feet)
Next, press the O key
Camera switches to first-person mode from that agent’s perspective
Press the O key again to toggle back to the main camera

Scene Location & Name

Assets/Ride/Examples/BattleDrills/BattleDrill_ReactToAmbush.unity

Setup Requirements

Utilize the Battle Drill capability and interface for your scene with the BattleDrillScene script.

Refer to the example scene for setup.

The post Battle Drills – React to Ambush – Near appeared first on RIDE.

Region System

Andrew Leeds — Wed, 27 Jan 2021 19:29:29 +0000

Behaviors & Navigation

Region System

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

This example scene shows how to programmatically create regions of interest on the terrain, and track the movement of individuals and groups in and out of these regions using a Region Service.

How to Use

Maneuver the leader soldier in and out of the visualized region using the W-A-S-D keys on your keyboard, or right-click on a destination. On-screen messages will appear when either agent enters or exists the region, as well as messages when the group collectively enters or exists the region.

Scene Location & Name

Assets/Ride/Examples/Services/Region/ExampleRegionSystem.unity

Setup Requirements

Region System

Utilize the RIDE Region System by adding the necessary code to the script that initializes your scene. Begin by creating a new RegionSystem object, then add this object as a System using RIDE’s system access system.

Inform the Region System about all of the regions of interest by adding them one at a time. Each polygonal region is defined as an ordered array of RideVector2 points, which represents each of the vertices of the polygon. Points can be ordered in either clockwise or counter clockwise directions around the polygon, but must not define edges that cross. Adding an array of points to the Region System returns a new RideID for the defined region.

Monitoring agents and groups

A Region System can be configured to dispatch RIDE world events whenever a specified agent or group enters or exists defined regions, using the MonitorAgent and MonitorGroup functions provided by the system with the corresponding RideID identifiers. The data dispatched in these events are “RegionChangeEvent” data types, and identified by the labels “agentEnterRegion”, “agentExitRegion”, “groupEnterRegion”, and “groupExitRegion”. Use the RIDE world state system to add specific listeners and functions for these events.

For groups, entry and exit of a region is determined by the group’s average location (centroid). Because of this, it is possible that world events will be dispatched when no member of the group is within the region bounds, e.g., when the groups is split into two subgroups that are in disparate places on the terrain, where the defined region lies between them.

Unity Region Visualizer

Create a new UnityRegionVisualizer object in your initialization script to draw the edges of a region in a Unity scene. Using the visualizers DrawRegion command, pass the RideID of the region and the region system, along with an (optional) color.

The post Region System appeared first on RIDE.

Razish Tour

Andrew Leeds — Fri, 08 Jan 2021 00:57:31 +0000

Behaviors & Navigation

Razish Tour

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

This example scene shows how to create an interactive tour around a terrain using scenario events and custom AI behaviors. In this example, the player tours the fictional city of Razish, located in the real world at the National Training Center at Ft. Irwin, California.

How to Use

This example scene begins with an overhead view and fly-through of the city of Razish, with a moving camera and a recorded audio clip. When this introductory fly-through is finished, you take on the role of an Iraqi woman following her two friends and their two children on a walking tour of Razish. Maneuver your avatar using the W-A-S-D keys on your keyboard or with a gamepad controller. When you arrive at each tour stop, an audio clip describing the site will be triggered. At the end of the walking tour, the scene will return to an overhead view for a final fly-through of the city.

Scene Location & Name

Assets/Ride/Examples/Scenarios/RazishTour/RazishTour.unity

Setup Requirements

Scenario System

Utilize the RIDE Scenario System to create Scenario Events that are triggered by Scenario Conditions. Several built-in scenario events and scenario conditions are provided by the RIDE platform. This example scene demonstrates several types of built-in Scenario Event types, including an AgentBehaviourScenarioEvent to assign the TourBehaviour to the tour guide agent, and an AudioScenarioEvent to play clips using RIDE’s Audio System.

Custom Scenario Events

Utilize a CustomScenarioEvent in order to execute arbitrary code when Scenario Conditions are met. This example scene demonstrates several instances of CustomScenarioEvent, including the switching from overhead view to control of an avatar, the programmed camera movements of the two fly-through sequences.

Observation Scenario Conditions

Utilize an ObservationScenarioCondition to create a Scenario Condition for any arbitrary World Event that is dispatched by RIDE, and represented an logical (symbolic) form by RIDE’s Interpretation System. In this example, an ObservationScenarioCondition is triggered when the Interpretation System encodes a FlagCaptured World Event. Please see Interpretation System documentation for details on writing patterns for ObservationScenarioConditions.

The post Razish Tour appeared first on RIDE.

Vehicles Input

Andrew Leeds — Sat, 14 Nov 2020 07:02:50 +0000

Behaviors & Navigation

Vehicles Input

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Navigate terrain maps with “drivable” vehicles through basic keyboard or gamepad input. Cycle multiple camera angles in and around the vehicle for observation of variables in the environment that affect physics of the vehicles, such as the suspension’s handling over “bump” objects. An overlay displays vehicle motion statistics in real-time.

How to Use

Vehicle navigation controls vary by input device:

Keyboard:
1. Accelerate/Reverse – W/S or Up/Down arrow keys
2. Turn left/right – A/D or Left/Right arrow keys
Gamepad/Controller:
1. Accelerate/Reverse – Up/Down on left analog thumb-stick
2. Turn left/right – Left/Right arrow key on left analog thumb-stick

Switch camera angles by pressing the C key. Note, when at first-person view in the driver position, use mouse-look to change the camera orientation.

Exit and enter the vehicle by toggling the T key.

Enable the handbrake by holding the Space bar.

Pause the game by toggling the P key.

Note, the R key will call a function that attempts to reload the scene. This currently fails in the example scene.

The corner overlay displays the following values:

Gear
Velocity (km/h)
Velocity (mp/h)
Handbrake
Pause

Scene Location & Name

Assets/Ride/Examples/Vehicles/ExampleVehiclesInput.unity

Setup Requirements

Utilize vehicle controls and first-person camera API for your scene by adding the following prefabs, which their respective scripts:

Assets/Ride_Dependencies/MSVehicleSystem(FreeVersion)/Prefabs/Control.prefab
Assets/Ride_Dependencies/MSVehicleSystem(FreeVersion)/Prefabs/MSFPSController.prefab
Assets/Ride_Art/Art/Characters/MiddleEast/Legacy/Resources/RideEntities/VehicleInputControllerPrefab.prefab (VehHmvM111402)

Note, the VehicleInputControllerPrefab contains the humvee model from Bravemind. Reference setup of this prefab when adding your own vehicle model to a custom prefab. Add the following script to the root of your prefab to enable vehicle control:

Assets/Ride_Dependencies/MSVehicleSystem(FreeVersion)/Scripts/MSVehicleControllerFree.cs

The example scene contains an OWT terrain map, collision mesh, and start point, represented by objects TerrainLoader, RazishNavmesh and TerrainCenter.

Note, the Scenario object is for testing purposes only, and belongs to the MSVehicleSystem(FreeVersion) 3rd party package.

Control Prefab w/MSSceneControllerFree Script

First, add the Control prefab to your scene and in the Vehicles > Element 0 field, add your vehicle prefab. Next, in the Player field, add the MSFPSController prefab once instanced in your scene.

This prefab also contains the necessary Canvas child prefab.

MSFPSController Prefab and MSFPSController Script

Next, import the MSFPSController prefab into your scene for first-person controls of your avatar by way of the MSFPSController script. This prefab also contains the necessary Camera and Canvas child prefabs.

Remember to add this vehicle prefab in the Vehicles > Element 0 field of the Control prefab instanced in your scene.

VehHmvM111402Prefab Prefab and MSVehicleControllerFree Script

Next, import the VehHmvM111402Prefab prefab into your scene as the vehicle to be controlled by way of the MSVehicleControllerFree script.

This “game-ready” prefab contains all the necessary objects, including model, cameras, colliders, etc.

The post Vehicles Input appeared first on RIDE.

State Machine

Andrew Leeds — Sat, 14 Nov 2020 01:52:50 +0000

Behaviors & Navigation

State Machine

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Basic Agent state machine that can be modified as needed for simulations.

Features

Enter / Exit callbacks
Enter from / Exit to callbacks
OnUpdate callbacks
Fire Events with arbitrary parameters
Set permissions on which transitions are allowed for a state and the conditions of the transtions
Hierarchical

How to Use

Creating States

				
					
AgentStateMachine sm = new AgentStateMachine(agent.agentName, animatorWrapper, agent, agentSystem, worldStateSystem);
 
// Idle
sm.Configure(IdleState)
  .OnEnter(() => sm.animator.Play(IdleAnim01))
  .Permit((int)Trigger.Move, MoveState)
  ;
 
// Move
m.Configure(MoveState)
  .OnEnter(() => sm.animator.SetParameter(MoveParam, Mathf.Clamp01(agent.speed / agent.maxSpeed)))
  .OnUpdate(() => sm.animator.SetParameter(MoveParam, Mathf.Clamp01(agent.speed / agent.maxSpeed)))
  .OnExit(() => sm.animator.SetParameter(MoveParam, 0.0f))
  .Permit((int)Trigger.Idle, IdleState)
  ;
 
// Dead
sm.Configure(DeadState)
  .OnEnter(() => sm.animator.SetParameter(DeadParam, true))
  .OnExit(() => sm.animator.SetParameter(DeadParam, false))
  ;
 
// Crouch
sm.Configure(CrouchState)
  .OnEnter(() => sm.animator.SetParameter(StanceParam, 1))
  .OnExit(() => sm.animator.SetParameter(StanceParam, 0))
  ;
 
// Combat Engage
sm.Configure(CombatEngageState)
  .OnEnter(() => sm.animator.SetParameter(EngagedParam, true))
  .OnExit(() => sm.animator.SetParameter(EngagedParam, false))
  ;
 
// FireTwoHandedGunState
sm.Configure(FireGunState)
  .OnEnter(() => sm.animator.SetTrigger(FireParam))
  .SubstateOf(CombatEngageState)
  ;
 
 
sm.SetDefault(IdleState);
sm.Transition(IdleState);

RidePlayerFiniteStateMachine.drawio

Setting Agent States

				
					
Globals.api.agentSystem.SetAgentState(agent, StateMachineUtils.CrouchState);

Scene Location & Name

Assets/Ride/Examples/StateMachine/StateMachine.unity

The post State Machine appeared first on RIDE.

Patrol and Attack Bot

Andrew Leeds — Sat, 14 Nov 2020 01:01:34 +0000

Behaviors & Navigation

Patrol and Attack Bot

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Demonstrates autonomous agents using behavior trees (BT) in order to make decisions about patrolling and attacking.

How to Use

Reset: Returns agents to default positions.
Show Wall: Toggles visibility of the wall object.
Accuracy field: Enter a range from 0 (least) to 1 (most) to set bot accuracy. Default, 0.2.
1v0, 1v1, 3v3: Sets mode:
- 1v0: BLUFOR uses BT logic; OPFOR no behavior logic
- 1v1: BLUFOR and OPFOR both use BT logic
- 3v3: BLUFOR and OPFOR both use BT logic

Scene Location & Name

Assets/Ride/Examples/Behaviours/SeekAndDestroyBot/ExamplePatrolAndAttackBot.unity

Setup Requirements

Utilize AI bots for your scenes by adding the ExamplePatrolAndAttackBots script, waypoints, objects and Canvas prefab.

ExamplePatrolAndAttackBot script

First, add this script to an object in your scene to enable AI bots.

Waypoints, objects, and Canvas prefab

Next, add plane and cube objects to the scene.

Adjust the cube to create a wall that bisects the plane.

Instance Waypoint_AutoAddToRide prefabs on the plane. Reference hierarchy in example scene for setup.

Import Canvas prefab. Reference prefab in example scene for creation and setup of UI options.

Behavior Tree

PatrolAndAttackBot.drawio

The post Patrol and Attack Bot appeared first on RIDE.

Moving Agents

Andrew Leeds — Sat, 14 Nov 2020 00:46:18 +0000

Behaviors & Navigation

Moving Agents

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees

Overview

Purpose

Interface systems for moving agents in scenarios.

How to Use

The RIDE API uses the Unity Navmesh as its main implementation for moving agents. If you wish to use a different movement system, implement the IMovementSystem interface.

See Creating a Navigation Mesh from OWT Data to learn how to build a Unity navmesh from terrain data.

Initialization

				
					
Globals.api = ApiSystemMono.CreateApiSystemMono(false, true);

Movement System

Reference the following examples for your simulation:

				
					
// Move a single agent
Globals.api.movementSystem.MoveToPosition(agent, target);
 
// Move a group of agents in a cluster formation
Globals.api.movementSystem.MoveToPosition(agents, target, FormationProcedureType.Cluster);
 
// move a group, providing your own formation procedure
class MyFormationProcedure : IFormationProcedure { // your implementation }
Globals.api.movementSystem.MoveToPosition(agents, target, new MyFormationProcedure());

The post Moving Agents appeared first on RIDE.

Training TakeCover ML

Andrew Leeds — Fri, 13 Nov 2020 20:28:16 +0000

Behaviors & Navigation

Training TakeCover ML

Examples

Audio

Combat

Logging

MSELI

OAuth

Sockets

Timeline

Trees