Agents & Entities Archives - RIDE https://ride.ict.usc.edu/tag/agents-and-entities/ Rapid Integration & Development Environment Fri, 07 Jul 2023 00:04:37 +0000 en-US hourly 1 https://wordpress.org/?v=7.0.4 https://ride.ict.usc.edu/wp-content/uploads/2020/05/cropped-RIDE_Logo_Icon_250x-32x32.png Agents & Entities Archives - RIDE https://ride.ict.usc.edu/tag/agents-and-entities/ 32 32 Asset Lineup https://ride.ict.usc.edu/support/documentation/examples/asset-lineup/?utm_source=rss&utm_medium=rss&utm_campaign=asset-lineup Thu, 06 Jul 2023 19:04:47 +0000 https://ride.ict.usc.edu/?page_id=5810 Collects available entity prefabs for inspection, modification and testing.

The post Asset Lineup appeared first on RIDE.

]]>
Agents & Entities

Asset Lineup

Overview

Collects available entity prefabs for inspection, modification and testing.

Page Contents

RIDE Asset Lineup Soldiers
RideAssetLineUp

Purpose

Collects available entity prefabs for inspection, modification and testing.

How to Use

This scene includes prefabs strictly limited to DoD distribution of Ride, Ride_Art, and if useful, Ride_Dependencies directories. Consult the 3rdPartyLicenses document in the DoD distribution for specifics about the Unity Asset Store and other 3rd party vendor asset fees and restrictions.

Prefab variants of soldiers and other units non-exhaustive.

Entities are grouped by type in-scene:

  • Characters
  • Weapons
  • Vehicles
  • Props 

Note, LODs and unit properties unmodified except where to prevent combat engagement.

Controls

WASD keys – Move camera

Q, E keys – Rotate camera

RMB – Hold for mouse look

Scene Location & Name

Assets/Ride/Examples/RideAssetLineUp/RideAssetLineUp.unity

Setup Requirements 

The initial version of the scene utilizes the RideBaseMinimal script, DirectionalLightRig, and a simple plane object.

The post Asset Lineup appeared first on RIDE.

]]> Interpretation System https://ride.ict.usc.edu/support/documentation/examples/interpretation-system/?utm_source=rss&utm_medium=rss&utm_campaign=interpretation-system Wed, 06 Oct 2021 22:24:19 +0000 https://ride.ict.usc.edu/?page_id=4128 Demonstrates the systems for real-time interpretation of scenario events and narrative summarization.

The post Interpretation System appeared first on RIDE.

]]>
Agents & Entities

Interpretation System

Overview

Demonstrates the systems for real-time interpretation of scenario events and narrative summarization.

Page Contents

Example Interpretation System Image 00
ExampleInterpretationSystem

Purpose

Demonstrates the systems for real-time interpretation of scenario events and narrative summarization.

How to Use

The example sequence automatically begins at run-time, with the Interpreter system observing and interpreting the scenario events in real-time using probability-ordered logical abduction, picking the assumptions that are the direct antecedent of the observations.

Toggle output in the Interpreter menu by clicking Observable, Ignored observables, Interpretation, and N-Best Interpretations buttons.

Switch to the Narrator menu by clicking the header button or right arrow at the top of the debug menu.

Once the sequence has completed, click the Narrative Summary button to review the Narrator output.

Scene Location & Name

Assets/Ride/Examples/Services/Interpretation/ExampleInterpretationSystem.unity

Setup Requirements 

Utilize the Interpreter and Narrator for your scene by referring to the example scene scripts. 

ExampleInterpretationSystem Script

Add this script to an object in your scene to create a sequence of events for the Interpreter system. Modify as needed to suit your own needs. 

InterpretationSystem Script

Referenced by ExampleInterpretationSystem script. Add this script to an object in your scene to enable the Interpreter system.

UnityKnowledgebaseCache Script

Referenced by InterpretationSystem script and must contain at least one Knowledgebase object. Add this script to to the same object with  ExampleInterpretationSystem.

Elements

Ensure the below or a custom KB is added to the UnityKnowledgebaseCache component.

  • ExampleKB
  • ExampleTemplates

RegionSystem Script

If following the example and using regions, add this script to an object in your scene.

The post Interpretation System appeared first on RIDE.

]]> DataMono Entities https://ride.ict.usc.edu/support/documentation/examples/datamono-entities/?utm_source=rss&utm_medium=rss&utm_campaign=datamono-entities Mon, 20 Sep 2021 23:34:14 +0000 https://ride.ict.usc.edu/?page_id=4021 "DataMono" characters built by using bootstrappable data components for entities.

The post DataMono Entities appeared first on RIDE.

]]>
Agents & Entities

DataMono Entities

Overview

DataMono characters built by using bootstrappable data components for entities.

Page Contents

Example Movement Data Mono Image
ExampleMovementDataMono

Purpose

Now “DataMono” characters are built by using bootstrappable data components for entities and no longer rely on AgentMono script, which reduces the number of necessary functions and decouples them from a single class.

How to Use

Each data component is handled by one or more different RIDE systems.

New bootstrappable entity components added for the following functions:

RideAgent

  • Basic agent info such as name and team
  • Handled by IAgentSystem

RideAgentMover

  • Default RIDE IMover for agent movement and path calculation
  • Implements either Unity or AStar navigation solution
  • Handled by IMovementSystem

UnitBoost

  • Handles speed multiplier (for functions like character sprinting)
  • Handled by IMovementSystem for characters (could be expanded by future systems for vehicle use)

RideAgentAnimationController

  • Sets up animations for characters
  • Handled by IAnimationSystem

RideInventory

  • Updated inventory/item system that now tracks both items, item status (ownership, stowage, equipped, etc.) and the “containers” that carry them. These conceptual containers could include representation of pockets, backpacks, ammunition boxes as well as character hands.
  • Handled by IEquipmentSystem

RideEntityHitBox

  • This component handles hit boxes and health status of the entity
  • Will be expanded to be more customizable to include multiple hit boxes/areas with varying different levels of hit points and locations so it can be used on a variety of entity types including both characters and vehicles
  • Handled by IAttackSystem

RideEntitySelector

  • Handles the user selection interface with units (much like selecting units in an RTS)
  • This component sets up the entity for selection for the RideEntitySelectorSystem
  • Handled by ISelector (RideEntitySelectorSystem)

Camera

  • Sets up cameras around an entity
  • Allows for different types of camera configurations such as first-person and third-person (free-look and locked) views
  • Handled by ICameraSystem

PlayerInputController

  • An IInputController that handles user input
  • Currently used by player controlled characters
  • Handled by IInputSystem

RideAgentControllable

  • An IInputControllable that receives input for characters
  • Currently used by player controlled characters that receive input from a PlayerInputController and moves the character around
  • Handled by IInputSystem

Scene Location & Name

Various DataMono counterparts to the original AgentMonoDataMono scenes now exist:

Assets/Ride/Examples/BattleDrills/BattleDrill_ReactToAmbush_DataMono.unity

Assets/Ride/Examples/Groups/ExampleGroupsDataMono.unity

Assets/Ride/Examples/MilitaryUnits/ExampleMilitaryUnitsDataMono.unity

Assets/Ride/Examples/Movement/ExampleMovementDataMono.unity

Assets/Ride/Examples/PlayerInputController/PlayerInputControllerDataMono.unity

How to Use

PrefabDataMono Entities 

Pre-built PrefabDataMono entities can be found in the following location:

Assets/Ride_Art/Art/Characters/MiddleEast/RideEntities/

ResourceLoader Prefab

In order to instantiate any PrefabDataMono entity dynamically via code at run-time, ensure the necessary prefabs are added to the ResourceLoader prefab under the RideSystems prefab. Add a new Element entry in the Unit Prefabs section for each unit desired. 

The post DataMono Entities appeared first on RIDE.

]]> Battle Drills – React to Ambush – Near https://ride.ict.usc.edu/support/documentation/examples/battle-drills-react-to-ambush-near/?utm_source=rss&utm_medium=rss&utm_campaign=battle-drills-react-to-ambush-near Fri, 09 Apr 2021 00:27:14 +0000 https://ride.ict.usc.edu/?page_id=3695 Demonstrate various ICT S&T research lines in a well-known format with very specific pass/fail parameters and training objectives.

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

]]>
Agents & Entities

Battle Drills - React to Ambush - Near

Overview

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

Page Contents

Battle Drill React To Ambush Near Image
BattleDrill_ReactToAmbush_Near

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:

  1. Click an agent to select them (green ring appears at their feet)
  2. Next, press the O key
  3. Camera switches to first-person mode from that agent’s perspective
  4. 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 https://ride.ict.usc.edu/support/documentation/examples/region-system/?utm_source=rss&utm_medium=rss&utm_campaign=region-system Wed, 27 Jan 2021 19:29:29 +0000 https://ride.ict.usc.edu/?page_id=2434 Track the movement of individual agents and groups as they move in and out of defined polygonal regions.

The post Region System appeared first on RIDE.

]]>
Agents & Entities

Region System

Overview

Track the movement of individual agents and groups as they move in and out of defined polygonal regions.

Page Contents

ExampleRegionSystem

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.

]]> Time Simulation https://ride.ict.usc.edu/support/documentation/examples/time-simulation/?utm_source=rss&utm_medium=rss&utm_campaign=time-simulation Wed, 13 Jan 2021 19:12:35 +0000 https://ride.ict.usc.edu/?page_id=2320 Demonstrates how to control simulation time speed and unit movement speed.

The post Time Simulation appeared first on RIDE.

]]>
Agents & Entities

Time Simulation

Overview

Demonstrates how to control simulation time speed and unit movement speed.

Page Contents

Example Time Simulation capture
ExampleTimeSimulation

Purpose

Demonstrates how to control simulation time speed and unit movement speed.

How to Use

The top options in the debug menu are used to spawn and select agents. With the agents selected, set at least one waypoint to begin unit movement. Adjust the Time and Movement Speed sliders to speed up or slow down these aspects of the simulation.

With Should Loop enabled, units will navigate between the selected waypoints.

Click Clear Agent(s) to remove the selected agents.

This scene features the Catalina Island OWT  dataset for its diverse terrain, as such the waypoints chosen vary in difficulty for the A* Pathing navigation of units.

Scene Location & Name

Assets/Ride/Examples/TimeSimulation/ExampleTimeSimulation.unity

Setup Requirements 

The ITimeSimulationSystem allows you to speed up, slow down, stop, and resume the simulation. Utilize the ITimeSimulationSystem API for your scene and its agents by adding the ExampleTimeSimulation script. 

ExampleTimeSimulation Script

Add this script to an object in your scene to enable the use of the ITimeSimulationSystem. In this script, UI widget presses are handled to set the time simulation speed via the service.

The post Time Simulation appeared first on RIDE.

]]> Razish Tour https://ride.ict.usc.edu/support/documentation/examples/razish-tour/?utm_source=rss&utm_medium=rss&utm_campaign=razish-tour Fri, 08 Jan 2021 00:57:31 +0000 https://ride.ict.usc.edu/?page_id=2211 This example scene shows how to create an interactive tour around a terrain using scenario events and custom AI behaviors.

The post Razish Tour appeared first on RIDE.

]]>
Agents & Entities

Razish Tour

Overview

This example scene shows how to create an interactive tour around a terrain using scenario events and custom AI behaviors.

Page Contents

Razish Tour Image
RazishTour

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.

]]> VGL Stress Test https://ride.ict.usc.edu/support/documentation/examples/vgl-stress-test/?utm_source=rss&utm_medium=rss&utm_campaign=vgl-stress-test Sat, 14 Nov 2020 07:08:11 +0000 https://ride.ict.usc.edu/?page_id=1866 Configure a scalability test with generic in-game agents in real-time and record performance data locally and in the cloud for later analysis.

The post VGL Stress Test appeared first on RIDE.

]]>
Agents & Entities

VGL Stress Test

Overview

Configure a scalability test with generic in-game agents in real-time and record performance data locally and in the cloud for later analysis.

Page Contents

Purpose

Configure a scalability test with generic in-game agents in real-time and record performance data locally and in the cloud for later analysis.

How to Use

Allow the terrain in the scene to populate. Once finished, the Run Test 01 button will appear in the upper left. Upon click, this will initialize a brief test that spawns 100 instances of the full_genericAvatar model. Ideally, these models will appear to walk smoothly in a circle depending on hardware capability. If running the scene in the Unity editor, you may observe the scene’s frame rate in real-time with the Stats overlay.

The current test will last for 5 seconds, and when complete, will automatically generate a performance output file using the Unity Profiler utility in .json format that will save to the following location within the project directory on disk: /Assets

Additionally, a copy of the output file will upload automatically to the RIDE AWS and Azure cloud storages.

Example output file content:

				
					
"$id": "1",
"os": "Windows 10 (10.0.0) 64bit",
"numProcessors": 8,
"sysMemorySize": 32.696,
"gfxDeviceName": "NVIDIA GeForce GTX 1080",
"gfMemorySize": 8079,
"usedHeapSize": 440311680.0,
"resolutionWidth": 1280,
"resolutionHeight": 720,
"scenario": "ExampleVGLStressTest",
"numCivs": 100,
"duration": 5.0,
"civVertCountSingle": 42547,
"civVertCountTotal": 4254700,
"avgfps": 74.2840652

Note, no user specific information is contained within the file.

Using REST to Control the Scenario

This scenario can be controlled via REST. After the scenario loads, enter the following url into your browser:

http://127.0.0.1:9157/ScenarioService/BeginSimulation/?civs=100&duration=5

civs = The number of civilians to spawn

duration = The length of time to run the simulation before clearing the scenario and logging the performance data

Scene Location & Name

Assets/Scenes/PatternsOfLife/VGL/ExampleVGLStressTest.unity

Setup Requirements 

Utilize a similar scalability test for your scene and specific assets by adding the ExampleVGLStressTest script, ScenarioMenu UI and ResourceLoader (GOList) prefab.

ExampleVGLStressTest Script

First, add this script to an object in your scene to enable the example test and output file generation.

ScenarioMenu, ResourceLoader Prefab and Supporting Objects

Manually invoke the test through a simple UI by adding the ScenarioSettingsMenu script to an empty game object. In the Scenario field, choose your scene (ExampleVGHStressTest). Next, follow the example Panel construction to create the necessary buttons. Hide the ScenarioMenu object by unchecking its box in the Inspector so that it will not appear until after terrain load.

Instance the ResourceLoader prefab (commonly renamed as GOList) and add entries under Scene Game Objects for what you wish to spawn. In this example, VGL_Civilian00 and VGL_Civilian01. Instance these objects in the scene, but uncheck the box in the Inspector to hide them by default at start.

This examples scene contains the following prefabs and scripts related to terrain:

  • TerrainLoader
  • TerrainCamera
  • RazishNavmesh

The Waypoint layer contains multiple Waypoint_AutoAddToRide prefab objects used to move scene objects to a destination at run-time. In the example, waypoints are placed in a circle around a central point of interest in the terrain map.

The post VGL Stress Test appeared first on RIDE.

]]> Vehicles Input https://ride.ict.usc.edu/support/documentation/examples/vehicles-input/?utm_source=rss&utm_medium=rss&utm_campaign=vehicles-input Sat, 14 Nov 2020 07:02:50 +0000 https://ride.ict.usc.edu/?page_id=1861 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. An overlay displays vehicle motion statistics in real-time.

The post Vehicles Input appeared first on RIDE.

]]>
Agents & Entities

Vehicles Input

Overview

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.   

Page Contents

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:

  1. Keyboard:
    1. Accelerate/Reverse – W/S or Up/Down arrow keys
    2. Turn left/right – A/D or Left/Right arrow keys
  2. 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.

]]> Unit Data https://ride.ict.usc.edu/support/documentation/examples/unit-data/?utm_source=rss&utm_medium=rss&utm_campaign=unit-data Sat, 14 Nov 2020 06:54:56 +0000 https://ride.ict.usc.edu/?page_id=1856 Save agents and/or groups for later retrieval, allowing them to be loaded into the scene via custom menus.

The post Unit Data appeared first on RIDE.

]]>
Agents & Entities

Unit Data

Overview

Save agents and/or groups for later retrieval, allowing them to be loaded into the scene via custom menus.

Page Contents

Purpose

Save agents and/or groups for later retrieval, allowing them to be loaded into the scene via custom menus.

How to Use

Instantiating Prefabs

  • On the left-side of the screen are prefabs that are either in the project or objects in the scene that can be instantiated. Clicking on any of the prefabs/objects on the left and then clicking on the plane in the game will spawn the objects. They default to a wander around behavior.

Saving Out an Agent to JSON

  • You can select units by clicking on them. When selected, the unit will have a green circular selector around them. When you have an agent selected, right-click to open the save menu. Enter the name of the save file and press enter. The right-side of the screen will update with the agent saved.

Saving Out a Group to JSON

  • You can select multiple units by click-hold and dragging the selector UI around the units you want selected. When right-clicking, the save menu will open for you to enter the name of the save file. When you press enter, the whole group will be saved into a file and the right-side of the screen will update with the group saved.

Loading a Saved Agent to the Scene

  • On the right-side of the screen are agents and groups that can be loaded into the scene at runtime. The first part of the list are agents that are saved to JSON. You can load them into the game the same way you load the prefabs/objects on the left-side of the screen. Loaded agents will spawn in the location where you originally clicked on the plane.

Loading a Saved Group to the Scene

  • The second part of the list on the right-side of the screen are groups. Those are merely buttons and clicking on them will spawn the objects in the groups into the scene. They will spawn in the same location as when they were saved.

Scene Location & Name

Assets/Ride/Examples/UnitData/UnitDataExample.unity

Save File Locations

  • Assets/unitData/groups/
  • Assets/unitData/units/

Note

Currently, any save files no longer desired must be manually deleted by the user from these folders to remove them from the JSON Units menu at run-time.

Setup Requirements 

Utilize the save/load ability and selector API with an assist list and UI options for your scene by adding the UnitDataExample script, SelectorUI prefab, GOList prefab, vehicle prefabs, and a custom Canvas object with buttons. 

UnitDataExample script

First, add this script to an object in your scene to enable the spawning of units for saving/loading.

SelectorUI prefab

Next, import the SelectorUI prefab into your scene to enable rectangular selection and highlight of units by way of the RectSelectionDisplay script.

This prefab also contains the necessary EventSystem and Canvas child prefabs. 

GOList and vehicle prefabs

Next, import the GOList prefab into your scene. This list determines which assets are available in the scene. By default the list is populated with 0 Scene Game Objects and 20 Unit Prefabs.

Remove the VehHmvM111402Prefab from the Unit Prefabs list by changing the Unit Prefabs field Size to 19. Change the Size value of Scene Game Objects to 2. 

Now, import Abrams and VehHmvM111402Prefab prefabs into the scene. Hide (uncheck) both instances by default in the scene.

Add both objects to Scene Game Objects under the GOList.

Custom Canvas object and buttons

Last, instance a new Unity Canvas object in the scene. Add a ToggleGroup component to the object, from the following loaction: Pakages/com.unity.ugui/Runtime/UI/Core/ToggleGroup.cs

Place three Panel objects as children, renaming them as follows: GO_ListSpawnList, UnitDataSavePanel and JSONSpawnList. Refer to the example scene assets to create/copy the various on-screen buttons and menus within these panels.

Note

A future update may include the ToggleGroup functionality within the RIDE Canvas prefab, as well as a new Canvas prefab with GO_ListSpawnList, UnitDataSavePanel and JSONSpawnList ready for drag-and-drop scene placement.

The post Unit Data appeared first on RIDE.

]]>