 |
VR-Forces 5.0.3 Developer's Guide
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces 5.0.3 Developer's Guide
|
This DtVrfSimulatedSimObjectFacadeInterface class will provide accessors for data that is available to VRF simulated objects only. Remote object that are not simulated by VR-Forces will not be able to use this proxy. Use the isUsable method to check validity.
This class is not thread safe. It should only be used in the context of a single thread/object.
If this class is not usable, methods will return a default value
Protected Member Functions | |
| virtual DtSimObjectReference | simObject () const =0 |
| virtual void | setupDecorator () |
| DtVrfSimulatedSimObjectFacadeInterface::DtVrfSimulatedSimObjectFacadeInterface | ( | ) |
CTOR.
|
virtual |
| bool DtVrfSimulatedSimObjectFacadeInterface::isUsable | ( | ) | const |
Make this call after construction to see if the supplied sim object can use this class.
| int DtVrfSimulatedSimObjectFacadeInterface::sessionId | ( | ) | const |
If present, the vrf session this is in. Default -1.
| bool DtVrfSimulatedSimObjectFacadeInterface::activated | ( | ) | const |
Whether or not this object is activated. Default true.
| bool DtVrfSimulatedSimObjectFacadeInterface::assumeUnknownIsHostile | ( | ) | const |
Whether or not this object assumes unknown objects are hostile. Default false.
| bool DtVrfSimulatedSimObjectFacadeInterface::independentlyTasked | ( | ) | const |
Whether or not this sim object is independently tasked. Default true.
| bool DtVrfSimulatedSimObjectFacadeInterface::underFire | ( | ) | const |
Whether or not this sim object is under fire. Default false.
| bool DtVrfSimulatedSimObjectFacadeInterface::isTasked | ( | ) | const |
Whether or not this sim object is tasked. Default false.
The extended data associated with the given key. Default null string.
The extended data map. Default null map.
The extended label at the given index. Default null string.
The extended labels map. Default null map.
| DtString DtVrfSimulatedSimObjectFacadeInterface::label | ( | ) | const |
Label of the object. Default null string.
| bool DtVrfSimulatedSimObjectFacadeInterface::invulnerable | ( | ) | const |
Whether or not this item is invulnerable. Default false.
| bool DtVrfSimulatedSimObjectFacadeInterface::invisible | ( | ) | const |
Whether or not this item is invisible. Default false.
| DtEchelonId DtVrfSimulatedSimObjectFacadeInterface::echelonId | ( | ) | const |
Echelon id. Default null echelon id.
| bool DtVrfSimulatedSimObjectFacadeInterface::sensorsKilled | ( | ) | const |
Whether or not the sensors are active. Default true.
| bool DtVrfSimulatedSimObjectFacadeInterface::occupantsHidden | ( | ) | const |
If there are default occupants in a visual, whether or not they are hidden. Default false.
| bool DtVrfSimulatedSimObjectFacadeInterface::hasPlan | ( | ) | const |
Whether or not this sim object has a plan. Default is false.
| bool DtVrfSimulatedSimObjectFacadeInterface::executingPlan | ( | ) | const |
Whether or not this sime object is executing a plan. Default is false.
| const DtRwProperties& DtVrfSimulatedSimObjectFacadeInterface::stateProperties | ( | ) | const |
State properties of this sim object. Default is empty properties list.
| const DtRwProperties& DtVrfSimulatedSimObjectFacadeInterface::parameterProperties | ( | ) | const |
Since this is a function of the object parameters, this will always return a value whether or not this is vrf simulated.
| bool DtVrfSimulatedSimObjectFacadeInterface::undetectable | ( | ) | const |
Whether or not this sim object is undetectable. Default is false.
| DtString DtVrfSimulatedSimObjectFacadeInterface::activity | ( | ) | const |
If assigned, the activity this sim object is performing. Default is null string.
| DtString DtVrfSimulatedSimObjectFacadeInterface::engagementRules | ( | ) | const |
The current engagement rules of this sim object. Default is fre-at-will.
| bool DtVrfSimulatedSimObjectFacadeInterface::invisibleSetByUser | ( | ) | const |
Whether or not if this sim object is invisible it was set by the user. Default is false.
| bool DtVrfSimulatedSimObjectFacadeInterface::isVrfSimulated | ( | ) | const |
Whether or not this sim object is simulated by VF-Forces. Default is false.
| DtString DtVrfSimulatedSimObjectFacadeInterface::overlay | ( | ) | const |
If this sim object is on an overlay, what overlay is it on. Default is null string.
| bool DtVrfSimulatedSimObjectFacadeInterface::fuelLevelsFrozen | ( | ) | const |
Whether or not fuel levels are frozen. Default is false.
| bool DtVrfSimulatedSimObjectFacadeInterface::munitionLevelsFrozen | ( | ) | const |
Whether or not munition levels are frozen. Default is false.
| bool DtVrfSimulatedSimObjectFacadeInterface::isSubordinateOfForceLevel | ( | ) | const |
Whether or not this sim object is a subordinate of force level. Default is true.
| bool DtVrfSimulatedSimObjectFacadeInterface::hasTarget | ( | ) | const |
Will return true if this vrforces object has a target to fire on.
| bool DtVrfSimulatedSimObjectFacadeInterface::blockParachute | ( | ) | const |
Returns true if the parachute is blocked from opening.
| bool DtVrfSimulatedSimObjectFacadeInterface::onTerrainSurface | ( | ) | const |
Returns true if the DtOnTerrainSurface flag is not there or is there and is set to 1. All non vr-forces objects will return false.
|
protectedpure virtual |
Implemented by subclasses to return the sim object this class represents.
Implemented in DtSimObjectFacade< DtVrfSimulatedSimObjectFacadeInterface >.
|
protectedvirtual |
Reimplemented in DtSimObjectFacade< DtVrfSimulatedSimObjectFacadeInterface >.