Logging & Data Archives - RIDE https://ride.ict.usc.edu/tag/logging-and-data/ Rapid Integration & Development Environment Wed, 18 Jan 2023 00:59:30 +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 Logging & Data Archives - RIDE https://ride.ict.usc.edu/tag/logging-and-data/ 32 32 OAuth https://ride.ict.usc.edu/support/documentation/examples/oauth/?utm_source=rss&utm_medium=rss&utm_campaign=oauth Wed, 09 Nov 2022 23:56:00 +0000 https://ride.ict.usc.edu/?page_id=5417 This example demonstrates how to use Google and Facebook OAuth authentication systems within RIDE.

The post OAuth appeared first on RIDE.

]]>
Logging & Data

OAuth

Overview

This example demonstrates how to use Google and Facebook OAuth authentication systems within RIDE.

Page Contents

Example OAuth Page
ExampleOAuth

Purpose

This example demonstrates how to use Google and Facebook OAuth authentication systems within RIDE.

How to Use

Facebook

  1. Choose Facebook.

  2. Fill in the things as under from Setup Requirements section below:
    1. Firebase API Key: Step-2.
    2. Facebook App ID: Step-9(j).
    3. Facebook App Secret: Step-9(j).
    4. Redirect / SaveAuthToken URL: Step-5(n)-i.
    5. GetAuthToken URL: Step-5(n)-ii.

  3. Click on Login Facebook button verifying everything in Step-2 and it will redirect you to the web page to ask Allow login to Facebook. Enter your Facebook credentials and click Continue.

  4. A webpage will pop up telling to return to the app and you will see your name, email and profile picture pop up in the Unity App indicating that the login was successful.

  5. Click the Clear button to clear the account profile pic, email, and name.
  6. Click Back to return to the login selection menu.

Google

  1. Choose Google.

  2. Fill in the things as under from Setup Requirements section below:
    1. Firebase API Key: Step-2.
    2. Google Client ID: Step-7(a)-i.
    3. Google Client Secret: Step-7(a)-i.
    4. Redirect / SaveAuthToken URL: Step-5(n)-i.
    5. GetAuthToken URL: Step-5(n)-ii.

  3. Click on Login Google button verifying everything in Step-2 and it will redirect you to the web page to ask Allow login to Google. Enter your Google credentials or choose from a list of accounts.

  4. A webpage will pop up telling you to return to the app and you will see your email pop up in the Unity App indicating that the login was successful.

  5. Click the Clear button to clear the account profile pic, email, and name.
  6. Click Back to return to the login selection menu.

Scene Location & Name

Assets/Ride/Examples/OAuth/Scenes/ExampleOAuth.unity 

Scene Setup

The example Unity scene directory contains the backend scripts related to the authentication services that are presented in a custom UI within the scene: ExampleOauth.cs, FirebaseAuthHandler.cs, GoogleAuthenticator.cs, FacebookAuthenticator.cs, FacebookIdTokenResponse.cs and GoogleIdTokenResponse.cs.

Server Setup

Enable custom authentication cloud services for your own project using the following process:

  1. Create a Google Cloud project which will act as the master project in the Google Cloud Console https://console.cloud.google.com/. Make sure you have the developer or admin privileges.
  2. Go to Firebase console https://console.firebase.google.com/ and you will see the same project already there. Select it. Keep a note of the Web API Key under Project Overview→Project Settings.
    1. Note, the key may not appear immediately. Navigate to Authentication and step through the various tabs (Users, etc.) then return to the Project Settings whereupon it should now populate. 
  3. Next, create a new database for logging all related services data. 
    1. In the Firebase console, navigate to Build→Realtime Database.
    2. Click Create Database button.
    3. Click Next in the prompt.
    4. Choose Start in Locked Mode.
    5. Click Enable.
    6. Empty database with corresponding URL should now appear in the main pane.
  4. In the Build→Functions section we need to create and invoke two cloud functions. 
    1. Firebase Cloud Function is a backend for Firebase that lets user deploy JavaScript/TypeScript code onto Firebase and then run it when required. It is used here as a web page to retrieve the authentication code required to get a user sign in to Google, Facebook or any other providers.
  5. Invoking Cloud Function on Firebase Server:
    1. Go to https://nodejs.org/en/ and install nodejs to get the npm package installed in the system. To verify if installation was successful, type npm in command prompt and see you get no errors.

    2. Create a new folder on the desktop, naming it as desired. Open a new command prompt and change the path to that folder.
    3. Install Firebase tools using command, npm install -g firebase-tools.
      1. Once complete, recommend running ‘npm audit fix’ if vulnerabilities are reported.
    4. Login to your Firebase account using command, firebase login. It will open a browser window where you can login to your Firebase console.
      1. Answer Y or n regarding usage and error reporting information collection.
      2. Choose Allow for Firebase CLI access to your Google Account.
        1. A Firebase CLI login successful prompt will appear. Close and return to the command prompt window.
    5. Initiate Firebase instance using command, firebase init.
    6. Type Y to proceed.
    7. Choose Functions: Configure a Cloud Functions directory and its files.
    8. Choose Use existing [Firebase] project and choose it from the next option that pops up.
    9. Choose JavaScript as the language.
    10. Type N for Do you want to use ESLint to catch probable bugs and enforce style?.
    11. Type Y for Do you want to install dependencies with npm now?
      1. Once complete, you now have your firebase initialized!
    12. Copy file Assets\StreamingAssets\oauth\FirebaseCloudFunctions\index.js from the RideUnity project and replace the existing <current folder path>\functions\index.js to set the custom cloud function that will be deployed.
    13. Run command firebase deploy from the same command prompt to deploy it into the Firebase server.
    14. If everything was followed then you should see two functions named saveAuthToken and getAuthToken in the Functions section of the Firebase console with their respective associated endpoints as triggers.
      1. saveAuthToken endpoint: https://<your-region>-<project-id>.cloudfunctions.net/saveAuthToken
      2. getAuthToken endpoint: https://<your-region>-<project-id>.cloudfunctions.net/getAuthToken

  6. Google Cloud OAuth Consent Screen:
    1. In the Google Cloud console, go to API & Services→OAuth consent screen.
      1. Edit app registration, User Type, choose External, and click on CREATE.
      2. App information section fields:
        1. App name, enter custom name.
        2. User support email, enter desired email.
        3. App logo, add an image (optional).
      3. Develop contact information fields.
        1. Email address, use same email as above, add others as desired.
      4. Click SAVE AND CONTINUE.
      5. Scopes, leave as-is, click SAVE AND CONTINUE.
      6. Optional info, leave as-is, click SAVE AND CONTINUE.
      7. Summary, review and click BACK TO DASHBOARD.
  7. Google Cloud Credentials:
    1. In the Google Cloud console, click API & Services→Credentials
      1. OAuth2.0 Client IDs section, click entry name, “Web client (auto created by Google Service)”.
        1. Authorized JavaScript origins entries, ensure “URIs 3” populated with “https://<project-id>.firebaseapp.com” address.
        2. Authorized redirect URIs section, click on ADD URI, and add the SaveAuthToken endpoint generated in step-5(n)-i.
        3. Click on SAVE.
        4. Important, keep a note of the Client ID and Client secret entries listed in the upper-right.
          1. Note, if Client secret fails to appear, click RESET SECRET, then in the prompt, click RESET to generate it. 
  8. Firebase Google Login:
    1. Enable Google sign-in method in Firebase console:
      1. Go to the Firebase console under Build, Authentication→Sign-in method→Add new provider button, choose Google to add it into the list of providers.

    2. In the Configure provider pane, click the toggle to Enable, then click Save.
      1. Under Google→Web SDK configuration set the Web client ID and Web client secret from Step-5d. (Note, if not already auto-filled.)

  9. Facebook Login
    1. Prerequisite: Ensure you have a Facebook Developer Account (see link below).
    2. Create a Facebook app in https://developers.facebook.com/.
      1. Registration steps:
        1. Login or create Facebook account.
        2. Facebook for Developers, Welcome page, click Continue.
        3. Verify account using mobile number.
        4. Contact info email confirmation.
        5. Choose About you option and Complete Registration.
      2. Meta for Developers dashboard:
        1. If you do not yet have an app, click Create App.
          1. Select Consumer, click Next.
          2. Basic information screen:
            1. Add an app name field, input a unique name.
            2. Click Create app button. 
    3. Return to Meta for Developers dashboard.
    4. Add product, Facebook Login, click Set up (hold off on further changes until indicated in step 9(g) below).
    5. Under sidebar Settings→Basic:
      1. Under App domains, set the domain from step-5(n) i.e. https://<your-region>-<project-id>.cloudfunctions.net
      2. Under Privacy Policy URL, set it to your company’s privacy policy URL.
      3. Under User data deletion, set it to your company’s data deletion instructions or callback URL.
      4. Click bottom option, Add platform.
        1. Select Website and add url from step-5(n) under Site URL.
      5. Click on Save changes.
    6. Under Settings→Advanced:
      1. Turn on Native or desktop app?
    7. Under Products→Facebook Login→Settings:
      1. Set Client OAuth login to Yes.
      2. Set Web OAuth login to Yes.
      3. Set Enforce HTTPS to Yes.
      4. Set Use Strict Mode for redirect URIs to Yes.
      5. Set Valid OAuth Redirect URIs to url in step-5(n)-i.
    8. Click on Save changes.
    9. In the top of the window set the App Mode to Live.
    10. Under Settings→Basic keep a note of the App ID and App Secret.
  10. Firebase Facebook Login
    1. Enable Facebook sign-in method in Firebase console:
      1. Go to the Firebase console under Authentication→Sign-in method→Add new provider, choose Facebook to add it into the list of providers.

      2. Under Facebook, set the App ID and App secret from Step-9(j).

         

  11. Firebase Database Rules:
    1. In the Realtime Database section in the Firebase console, under Rules make sure to disable read/write so that no user can access the project but just make authentication requests.

The post OAuth 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.

]]>
Logging & Data

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.

]]> Speech Recognition https://ride.ict.usc.edu/support/documentation/examples/speech-recognition/?utm_source=rss&utm_medium=rss&utm_campaign=speech-recognition Tue, 06 Apr 2021 00:43:33 +0000 https://ride.ict.usc.edu/?page_id=3519 Demonstrates how to use Microsoft speech recognition in RIDE.

The post Speech Recognition appeared first on RIDE.

]]>
Logging & Data

Speech Recognition

Overview

Demonstrates how to use Microsoft speech recognition in RIDE.

Page Contents

Example Speech Recognition Image
ExampleSpeechRecognition

Purpose

Demonstrates how to use Microsoft speech recognition in RIDE.

How to Use

  1. Hit Play
  2. Click on the Continuous speech button
  3. Talk into your microphone
  4. See that the words that you spoke appear on the UI

Scene Location & Name

Assets/Ride/Examples/Speech/SpeechRecognizer/ExampleSpeechRecognition.unity

Setup Requirements 

A microphone is required for this scene to function properly.
 
Add the Assets/Ride/Examples/Speech/SpeechRecognizer/SpeechManager.prefab to enable the service and Assets/Ride/Examples/Speech/SpeechRecognizer/SpeechRecognitionMenuobject.prefab into the scene in order to provide an interface for the user.
 
Reference ExampleSpeechRecognizer.cs to see how the speech recognizer service is setup.

The post Speech Recognition appeared first on RIDE.

]]> File Storage System https://ride.ict.usc.edu/support/documentation/examples/file-storage-system/?utm_source=rss&utm_medium=rss&utm_campaign=file-storage-system Mon, 05 Apr 2021 23:56:27 +0000 https://ride.ict.usc.edu/?page_id=3484 Shows how to upload and download files from cloud services AWS S3 and Azure Blob.

The post File Storage System appeared first on RIDE.

]]>
Logging & Data

File Storage System

Overview

Shows how to upload and download files from cloud services AWS S3 and Azure Blob.

Page Contents

Purpose

Shows how to upload and download files from cloud services AWS S3 and Azure Blob.

How to Use

Hit play and examine the unity console to see the downloading and uploading logs output by the file storage systems.

Scene Location & Name

Assets/Ride/Examples/Services/File/ExampleFileStorageSystem.unity

Setup Requirements 

The “Example” game object has the ExampleFileStorageSystem attached to it. This script creates the IFileStorageSystems AWSFileStorageS3System and AzureBlobFileStorageSystem.

The post File Storage System appeared first on RIDE.

]]> Sockets https://ride.ict.usc.edu/support/documentation/examples/sockets/?utm_source=rss&utm_medium=rss&utm_campaign=sockets Mon, 05 Apr 2021 23:48:34 +0000 https://ride.ict.usc.edu/?page_id=3474 Demonstrates how to open, send data over, and close a TCP socket in RIDE.

The post Sockets appeared first on RIDE.

]]>
Logging & Data

Sockets

Overview

Demonstrates how to open, send data over, and close a TCP socket in RIDE.

Page Contents

Example Sockets Image
ExampleSockets

Purpose

Demonstrates how to open, send data over, and close a TCP socket in RIDE.

How to Use

 1. Build standalone version of just ExampleSockets scene.
2. Launch standalone build; choose Receiver, then Connect.
3. Unity editor, open ExampleSockets scene and click Play to run scene.
4. Choose Sender, then Connect.
5. If successful, “I’m connected!” message will appear in both windows.
6. Input text in entry field and click Send to display messages inside log.

Scene Location & Name

Assets/Ride/Examples/Services/Sockets/ExampleSockets.unity

Setup Requirements 

Add the Assets/Ride/Examples/Services/DIS/ConnectionMenu.prefab in the scene in order to provide the user with the GUI elements. Examine ExampleSockets.cs attach to the “Example” gameobject to see how the sockets are established.

The post Sockets appeared first on RIDE.

]]> DIS Messages https://ride.ict.usc.edu/support/documentation/examples/dis-messages/?utm_source=rss&utm_medium=rss&utm_campaign=dis-messages Mon, 05 Apr 2021 23:37:15 +0000 https://ride.ict.usc.edu/?page_id=3468 Demonstrates how to use RIDE systems to send and receive Distributed Interactive Simulation (DIS) messages.

The post DIS Messages appeared first on RIDE.

]]>
Logging & Data

DIS Messages

Overview

Demonstrates how to use RIDE systems to send and receive Distributed Interactive Simulation (DIS) messages.

Page Contents

Example DIS Image 01
ExampleDIS

Purpose

Demonstrates how to use RIDE systems to send and receive Distributed Interactive Simulation (DIS) messages.

How to Use

1. Build standalone version of just ExampleDIS scene.
2. Launch standalone build; choose Receiver, then Connect.
3. Unity editor, open ExampleDIS scene and click Play to run scene.
4. Choose Sender, then Connect.
5. If successful, network messages will appear in both windows.

Scene Location & Name

Assets/Ride/Examples/Services/DIS/ExampleDIS.unity

Setup Requirements 

Add the Assets/Ride/Examples/Services/DIS/ConnectionMenu.prefab object into the scene in order to provide a network connect user interface for the user.

Reference Example ExampleDIS.cs to see how DISSender and DISReceiver are setup.

The post DIS Messages appeared first on RIDE.

]]> Localization https://ride.ict.usc.edu/support/documentation/examples/localization/?utm_source=rss&utm_medium=rss&utm_campaign=localization Wed, 27 Jan 2021 20:06:27 +0000 https://ride.ict.usc.edu/?page_id=2452 Demonstrates how to load, display, and switch between different languages

The post Localization appeared first on RIDE.

]]>
Logging & Data

Localization

Overview

Demonstrate how to load, display, and switch between different languages.

Page Contents

Example Localization Image 02
ExampleLocalization

Purpose

The example demonstrates how you can load, display, and switch between different text strings at runtime.  This feature allows you to display your UI/UX in different languages, catering to the end users’ preferred language.

How to Use

The IGroupSystem allows you to logically group agents together. Agents can exists in one or more groups.  Groups can have one or more sub groups.  You can also build relationships between groups.

Scene Location & Name

Assets/Ride/Examples/Services/ExampleLocalization.unity

Setup Requirements 

This scene uses the “Localizer” object which allows you to load different language text files.  Examine the files “en-us.txt” and “es-sp.txt” to see how you can add more strings to those files, or use them as examples for creating new localization .txt files in the language of your choosing. When you are ready to load them at runtime, drop them to the  end of the languages array on the Localizer object. 

In the scene, under Canvas is a game object called “Dropdown”.  Select it and, in the options section, type the name of your language that will display. 

ExampleLocalization Script

Add this script to an object in your scene to enable the switch of languages at runtime.

ILocalizationSystem Script

Referenced by ExampleLocalization script for group definitions. API reference here.

The post Localization 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.

]]>
Logging & Data

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.

]]> 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.

]]>
Logging & Data

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.

]]> 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.

]]>
Logging & Data

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.

]]>