Architecture Archives - RIDE https://ride.ict.usc.edu/tag/architecture/ Rapid Integration & Development Environment Tue, 28 Apr 2026 16:01:05 +0000 en-US hourly 1 https://wordpress.org/?v=6.9.4 https://ride.ict.usc.edu/wp-content/uploads/2020/05/cropped-RIDE_Logo_Icon_250x-32x32.png Architecture Archives - RIDE https://ride.ict.usc.edu/tag/architecture/ 32 32 API Functions VHMsg https://ride.ict.usc.edu/support/documentation/examples/api-functions-vhmsg/?utm_source=rss&utm_medium=rss&utm_campaign=api-functions-vhmsg Tue, 06 Apr 2021 05:32:56 +0000 https://ride.ict.usc.edu/?page_id=3539 Demonstrates how to setup a scene to use VHMsg (ActiveMQ wrapper) in RIDE.

The post API Functions VHMsg appeared first on RIDE.

]]>
Architecture

API Functions VHMsg

Overview

Demonstrates how to setup a scene to use VHMsg (ActiveMQ wrapper) in RIDE.

Page Contents

Purpose

Demonstrates how to setup a scene to use VHMsg (ActiveMQ wrapper) in RIDE.

How to Use

Examine the example scene hierarchy to see which objects you need in order to be VHMsg compatible.

Scene Location & Name

Assets/Ride/Examples/ApiFunctions/ExampleApiFunctionsVHMsg.unity

Setup Requirements 

Add Assets/Ride/Prefabs/RideVHMsgManager.prefab to the scene. This enables the sending and receiving of VHMsgs.

Note, the service relies on the ActiveMQ protocol, which can be downloaded from the location specified in the scene.

The post API Functions VHMsg appeared first on RIDE.

]]> RIDE API Basics https://ride.ict.usc.edu/support/documentation/examples/ride-api-basics/?utm_source=rss&utm_medium=rss&utm_campaign=ride-api-basics Wed, 27 Jan 2021 18:34:04 +0000 https://ride.ict.usc.edu/?page_id=2432 Demonstrates how to spawn and move opposing agents.

The post RIDE API Basics appeared first on RIDE.

]]>
Architecture

RIDE API Basics

Overview

Demonstrates how to spawn and move opposing agents as well as listen to world events.

Page Contents

Example Api Functions Image 02
ExampleGroups

Purpose

Establish groups for agents and relationships between the groups. 

How to Use

Hit play and see 3 different agents spawn, an opfor, a blufor, and a civilian.  All of the agents will begin to move and the opfor and blufor will attack each other.  In the on screen log, you will see events that are happening during the course of the simulation.  

Scene Location & Name

Assets/Ride/Examples/Groups/ExampleApiFunctions.unity

Setup Requirements 

The ExampleApiFunctions script was added to the game object named “Example”.
 
A navigation mesh was generated from the plane in the scene.

ExampleApiFunctions Script

Add this script to an object in your scene to spawn and move agents and listen to world events. Modify as needed to suit your own needs. 

The post RIDE API Basics appeared first on RIDE.

]]> State Machine https://ride.ict.usc.edu/support/documentation/examples/state-machine/?utm_source=rss&utm_medium=rss&utm_campaign=state-machine Sat, 14 Nov 2020 01:52:50 +0000 https://ride.ict.usc.edu/?page_id=1840 Basic Agent state machine that can be modified as needed for simulations.

The post State Machine appeared first on RIDE.

]]>
Architecture

State Machine

Overview

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

Page Contents

Example State Machine Image
ExampleStateMachine

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);
Player Finite State Machine Image
PlayerFiniteStateMachine

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.

]]> Specifying Assets Available for Loading https://ride.ict.usc.edu/support/documentation/examples/specifying-assets-available-for-loading/?utm_source=rss&utm_medium=rss&utm_campaign=specifying-assets-available-for-loading Sat, 14 Nov 2020 01:31:09 +0000 https://ride.ict.usc.edu/?page_id=1836 Load OWT Terrain from disk, create agents from prefabs or from the scene.

The post Specifying Assets Available for Loading appeared first on RIDE.

]]>
Architecture

Specifying Assets Available for Loading

Overview

Load OWT Terrain from disk, create agents from prefabs or from the scene.

Page Contents

Purpose

Load OWT Terrain from disk, create agents from prefabs or from the scene.

How to Use

Use the GOList Prefab or Add a new GameObject and attach the ResourceLoaderSystem script component to it.

Inside the component, its parameters are sorted into different sections.

Scene Game Objects

  1. *SCENE* NAME
    1. The *SCENE* tells the code to use this list, and the NAME is the name of Game Object to instantiate
    2. Note that this will be renamed to the AgentName from the AgentPrefab name
  2. These are already in the scene and are copied and set active when instantiated
  3. This is useful for when you want references to other things in the scene
  4. Important to note that the position will come from the scene, not the position passed into AddAgent

The GameObject must be in the GO List Scene GameObjects array.

AgentAddedEvent

				
					
Rideid agent = Globals.api.agentSystem.AddAgent(new Unit()
                {
                    team = Team.Blue,
                    prefab = "*SCENE*ChrUsaArmyInfantryAcu01Prefab",
                    pos = new RideVector3(0,0,0)
                });

Unit Prefabs

These are the list of prefabs you can instantiate into the scene. These prefabs should be linked in from the Unity Project window.

				
					
Rideid agent = Globals.api.agentSystem.AddAgent(new Unit()
                {
                    team = Team.Blue,
                    prefab = "*PREFAB*ChrUsaArmyInfantryAcu01Prefab",
                    pos = new RideVector3(0,0,0)
                });

Terrain Paths

A list of paths to Terrains which can be loaded and are accessible via the index into the array.

				
					
Globals.api.terrainSystem.LoadTerrain(index);

The post Specifying Assets Available for Loading appeared first on RIDE.

]]> Listening to / Dispatching Events https://ride.ict.usc.edu/support/documentation/examples/listening-to-dispatching-events/?utm_source=rss&utm_medium=rss&utm_campaign=listening-to-dispatching-events Sat, 14 Nov 2020 00:17:07 +0000 https://ride.ict.usc.edu/?page_id=1797 Create listeners for events and dispatch events in simulations.

The post Listening to / Dispatching Events appeared first on RIDE.

]]>
Architecture

Listening to / Dispatching Events

Overview

Create listeners for events and dispatch events in simulations. 

Page Contents

Purpose

Create listeners for events and dispatch events in simulations. 

How to Use

Refer to the following examples for your own scenarios:

				
					
// add listeners
Globals.api.worldStateSystem.AddListener<TestEvent>(WorldEvent.waypointReached, OnWaypointReached);
Globals.api.worldStateSystem.AddListener<WaypointReachedEvent>(WorldEvent.waypointReached, OnWaypointReached2);
Globals.api.worldStateSystem.AddListener<int>(WorldEvent.waypointReached, OnWaypointReached3);
 
// dispatch
Globals.api.worldStateSystem.DispatchEvent<TestEvent>(WorldEvent.waypointReached, new TestEvent { x = 100 });
Globals.api.worldStateSystem.DispatchEvent<int>(WorldEvent.waypointReached, 10);
Globals.api.worldStateSystem.DispatchEvent<WaypointReachedEvent>(WorldEvent.waypointReached, new WaypointReachedEvent(wp, blueAgent));
 
// remove
Globals.api.worldStateSystem.RemoveListener<WaypointReachedEvent>(WorldEvent.waypointReached, OnWaypointReached2);

The post Listening to / Dispatching Events appeared first on RIDE.

]]> Headless Mode https://ride.ict.usc.edu/support/documentation/examples/headless-mode/?utm_source=rss&utm_medium=rss&utm_campaign=headless-mode Sat, 14 Nov 2020 00:04:43 +0000 https://ride.ict.usc.edu/?page_id=1793 If the CommandLineParser.cs script is in the scene, and you create a build of the scene, then you can process all the ScenarioParameters and run your simulation with or without graphics.

The post Headless Mode appeared first on RIDE.

]]>
Architecture

Headless Mode

Overview

If the CommandLineParser.cs script is in the scene, and you create a build of the scene, then you can process all the ScenarioParameters and run your simulation with or without graphics. 

Page Contents

Purpose

If the CommandLineParser.cs script is in the scene, and you create a build of the scene, then you can process all the ScenarioParameters and run your simulation with or without graphics. 

How to Use

Command Line Parser 

The Parameters used to run a scenario which tells what scenario file to load (defaultJsonPath ), how long to run the simulation (duration), how fast the simulation should run (timeScale), the log for the simulation output (logScenarioFile), how oftern to update the log with the new agents positions and other agent information.

The ScenarioParameters can be set in the scene or parsed from the command line using the command line parser.

If the CommandLineParser.cs script is in the scene, and you create a build of the scene, then you can process all the ScenarioParameters and run your simulation with or without graphics. See the headless mode below for more information about running without graphics.

To run the scenario with the ScenarioParameters calls the ExecuteScenario function in the Main.cs script:

FindObjectOfType<Main>().ExecuteScenario(m_parameters);

The Main.cs file contains ScenarioParameters as well as keyboard shortcuts for toggling the Debug Menu and controlling the camera.

				
					
public class ScenarioParameters
{
    public string defaultJsonPath = "Assets/Content/Scenarios/headless.json";
    public float duration = 1f;
    public float timeScale = 1f;
    public string logScenarioFile = "ScenarioOutput.json"; 
    public int updateRateLog = 10;//10 times per second
    public bool isWaitAndQuit = false;
    public bool isLogScenario = false;
    public bool isLoadAtStart = false;
}

Headless Mode

You can run your simulations without seeing any graphics output, and you can run lots of them, easily, over and over. Several .bat files are included to show examples of how to run your simulations.

Note

.bat files are simply a sequence of commands that are run from the command line automatically when double clicked.Run the executable build of the scene and tells Unity to run the scene with no graphical input. Therefore, to see the output you need to look in the scenario log file for the results.

RIDE.exe -batchmode -nographics 

The -json tells the simulation where to load the scenario file from:

-json “Assets/Content/Scenarios/ExampleTwoUnits.json”

The duration is how long to run the simulation for, and the timeScale is how fast the game loop runs where higher is faster, so 2 is twice normal speed and 0.5 is slower:

duration 5 -timeScale 1

The output of the simulation will be in the logScenarioFile and the ExampleLogScenario.cs script is provided to show you how you can save relevant data from the simulation for your research:

-logScenarioFile “TwoUnitsLog.json” -updateLogRate 10

If you want to quit after running the simulation so can run lots of simulations use the isWaitAndQuit parameter, otherwise, perhaps you want to run in graphics mode and interact with the simulation then set it to false:

-isWaitAndQuit true

Example .bat files included with the builds which you can copy and modify for your own needs:

Example1.bat, ExampleFastSimulation.bat, ExampleTwoUnits.bat

The post Headless Mode appeared first on RIDE.

]]>