Interface IScenarioSystem
defines the functionality that can be performed on a scenario
Inherited Members
Namespace: Ride.Scenario
Assembly: cs.temp.dll.dll
Syntax
public interface IScenarioSystem : IRideSystem, IApiInject, IIdentity
Methods
Name | Description |
---|---|
AddAgent(RideID) | convenience function to convert the data structure Unit to the main AddAgent function and add the agent |
AddAgent(RideID, RideID) | convenience function to convert the data structure Unit to the main AddAgent function and add the agent |
AddAgent(RideID, Unit) | convenience function to convert the data structure Unit to the main AddAgent function and add the agent |
AddAgent(Unit) | convenience function to convert the data structure Unit to the main AddAgent function and add the agent |
AddLocationMarker(RideID, RideVector3, String) | Adds a marker onto the terrain that displays a positon's coordinates. |
AddLocationMarker(RideVector3, String) | Adds a marker onto the terrain that displays a positon's coordinates. |
AddOrdnance(RideID, RideVector3, Single, Single) | Adds ordnance to the terrain that shows its minimum safe distance. |
AddOrdnance(RideID, String, RideVector3, RideQuaternion, OrdnanceAppearanceFlags, Single, Single) | Adds ordnance to the terrain that shows its minimum safe distance. |
AddOrdnance(RideVector3, Single, Single) | Adds ordnance to the terrain that shows its minimum safe distance. |
AddPath(IEnumerable<IWaypoint>) | Creates a path with the given waypoints |
AddScenarioEvent(RideID, IScenarioEvent) | Adds the given event to the given scenario |
AddScenarioEvent(IScenarioEvent) | Adds the given event to the main scenario |
AddTagsToEntity(RideID, IEnumerable<RideParameter>) | Add the set of tags to the entity |
AddTagsToEntity(RideID, String[], Object) | Adds metadata of the given object to the entity using the tag |
AddTagToEntity(RideID, String, Object) | Adds metadata of the given object to the entity using the tag |
AddWaypoint(RideID, RideVector3, Single) | Adds an area of interest to the scenario |
AddWaypoint(RideID, RideVector3, WaypointFlags, Single) | Adds and area of interest to the scenario |
AddWaypoint(RideVector3, Single) | Adds an area of interest to the scenario |
AddWaypoint(RideVector3, WaypointFlags, Single) | Adds and area of interest to the scenario |
AreAllAgentsDead(RideID, Team) | Check if all the agents on a team are dead |
AreAllAgentsDead(Team) | Check if all the agents on a team are dead |
ClearScenario() | |
ClearScenario(RideID) | deletes all the data in the IScenario so you can run a new clean clear fresh scenario from scratch |
GetAgents() | Returns an traversable container of all the agents in a scenario |
GetAgents(RideID) | Returns an traversable container of all the agents in a scenario |
GetAgents(RideID, RideVector3, Single) | Returns all the agents within a certain range |
GetAgents(RideID, RideVector3, Single, Team) | Return all agents of a certain team within a range |
GetAgents(RideID, Team) | gets all the agents on one specific team |
GetAgents(RideVector3, Single) | Returns all the agents within a certain range |
GetAgents(RideVector3, Single, Team) | Return all agents of a certain team within a range |
GetAgents(Team) | gets all the agents on one specific team |
GetEntitiesByAttributes(EntityAttributes) | Find and return all entities in the scene that match all of the given attributes |
GetEntityByLocation(RideID, RideVector3, String, Single) | Searches all entities in the scenario that have the given tag and are within the given distance |
GetEntityByLocation(RideVector3, String, Single) | Searches all entities in the scenario that have the given tag and are within the given distance |
GetEntityByTag(String) | Searches all entities in the scnario that have the given tag |
GetEntityByTagValue(String, Single, Func<Single, Single, Boolean>) | Searches all entities in the scenario that have the given tag and meet the given condition |
GetEntityName(RideID) | Returns the entity's name |
GetEntityTags(RideID) | Returns all the tags associated with the given entity |
GetEntityTagValue<T>(RideID, String) | Gets the entity tag value |
GetLocationMarker(RideID) | Gets a location marker given its ID. |
GetLocationMarkers() | Gets all location markers in the default scenario. |
GetLocationMarkers(RideID) | Gets all location markers in a scenario. |
GetOrdnanceData(RideID) | |
GetOrdnanceData(RideID, RideID) | |
GetScenarioElapsedTime() | Returns the elapsed time of the main scenario |
GetScenarioElapsedTime(RideID) | Returns the elapsed time of the given scenario |
GetWaypointData(RideID) | |
GetWaypointData(RideID, RideID) | |
InsertEntity(RideVector3, RideQuaternion, IEnumerable<RideParameter>, RideID) | Insert a generic entity into the scenario |
InsertWaypoint(RideID, Waypoint, IEnumerable<RideParameter>) | Inserts the waypoint data into the api without creating a visual representation. Useful for when you place waypoints in the scene prior to starting the scene |
InsertWaypoint(Waypoint, IEnumerable<RideParameter>) | Inserts the waypoint data into the api without creating a visual representation. Useful for when you place waypoints in the scene prior to starting the scene |
IsScenarioRunning() | Is the current scenario running? |
IsScenarioRunning(RideID) | Is the given scenario running? |
LoadScenario(RideID, String) | Loads a scenario into the data structure of the IScenario format specifically loading agents and a terrain as well as other initial starting data needed for running a simulation |
LoadScenario(String) | Loads a scenario into the data structure of the IScenario format specifically loading agents and a terrain as well as other initial starting data needed for running a simulation |
LoadScenarioFromFile(RideID, String) | a convenience wrapper function to Load a scenario from disk using the path toe file which reads in that file and then calls LoadScenario |
LoadScenarioFromFile(String) | a convenience wrapper function to Load a scenario from disk using the path toe file which reads in that file and then calls LoadScenario |
ModifyTagValue(RideID, String, Single) | Modifies the tag metadata |
RemoveAgent(RideID) | Removes the agent with the given id from the scenario |
RemoveAgent(RideID, RideID) | Removes the agent with the given id from the scenario |
RemoveAllAgents() | Remove all the agents from all scenarios |
RemoveAllLocationMarkers() | Remove all location markers from the default scenario. |
RemoveAllLocationMarkers(RideID) | Remove all location markers from a given scenario. |
RemoveLocationMarker(RideID) | Removes a location marker from the default scenario. |
RemoveOrdnance(RideID) | |
RemoveTagFromEntity(RideID, String) | Removes the metadata from the entity |
RemoveWaypoint(RideID) | Removes the given waypoint from the scenario. |
RemoveWaypoint(RideID, RideID) | Removes the given waypoint from the scenario. |
SaveScenario(RideID, String) | Serializes the data in the scenario and saves it in the filename which gets created and contains the saved data |
SaveScenario(String) | Serializes the data in the scenario and saves it in the filename which gets created and contains the saved data |
SetEntityName(RideID, String) | Set the name of the entity |
StartScenario() | Starts the main sceanrio, enabling its scenario events and initializing its start time |
StartScenario(RideID) | Starts the given scenario, enabling its scenario events and initializing its start time |
StopScenario() | Stops the main scenario, disabling its scenario events |
StopScenario(RideID) | Stops the given scenario, disabling its scenario events |