WSF
WsfPlatformScriptMethods Namespace Reference

Functions

 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, PerceptionProcessor, 0, "WsfPerceptionProcessor", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, PerceivedAssets, 0, "Array<WsfAssetPerception>", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, PerceivedThreats, 0, "Array<WsfTrack>", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, UplinkProcessor, 0, "WsfUplinkProcessor", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, IsUplinkingTo, 1, "bool", "WsfPlatform")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, UplinkCount, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, UplinkCapable, 0, "bool", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, UplinkPlatformEntry, 1, "WsfPlatform", "int")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, StartUplinking_1, 1, "bool", "WsfPlatform")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, StartUplinking_2, 2, "bool", "WsfPlatform, WsfTrack")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, StopUplinking, 1, "bool", "WsfPlatform")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, MaxSupportedUplinks, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, Detonate, 1, "void", "string")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, Weapon, 1, "WsfWeapon", "string")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WeaponCount, 0, "int", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WeaponEntry, 1, "WsfWeapon", "int")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, TimeSinceWeaponLastFiredFor, 1, "double", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, TimeSinceWeaponLastTerminatedFor, 1, "double", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WeaponsPendingFor, 1, "int", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WeaponsActiveFor, 1, "int", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, RoundsCompleteFor, 1, "int", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, RoundsFiredAt, 1, "int", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, SalvosFiredAt, 1, "int", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, ActiveWeaponPlatformsFor, 1, "WsfPlatformList", "WsfTrackId")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WeaponEngagement, 0, "WsfWeaponEngagement", "")
aReturnVal SetBool (hasOpSub)
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, GetSubsCentroid, 0, "WsfGeoPoint", "")
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WithinFieldOfView_1, 2, "bool", "WsfTrack, string")
 bool withinFieldOfView = WithinFieldOfView(WsfTrack aTrack, string aSensorOrWeapon)
 UT_DEFINE_SCRIPT_METHOD_EXT (WsfPlatform, WithinFieldOfView_2, 2, "bool", "WsfPlatform, string")
 bool withinFieldOfView = WithinFieldOfView(WsfPlatform aPlatform, string aSensorOrWeapon)

Variables

WsfStringId subType = WsfStringId(aVarArgs[0].GetString())
bool hasOpSub = ::HasOperationalSubordinate(aObjectPtr, subType, checked)

Function Documentation

◆ SetBool()

aReturnVal WsfPlatformScriptMethods::SetBool ( hasOpSub )

References hasOpSub.

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [1/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
ActiveWeaponPlatformsFor ,
1 ,
"WsfPlatformList" ,
"WsfTrackId"  )

Returned the number of salvos that have been fired for the specified task. int count = RoundsFiredAt(WsfTrackId aTrackId);

References WsfWeapon::ActiveWeaponPlatformsFor(), platformPtr, and SIMULATION.

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [2/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
Detonate ,
1 ,
"void" ,
"string"  )

Detonate(string aResult); Detonates the current platform. If not a weapon platform then it just deletes the platform. aResult is one of the detonation codes from WsfWeaponEngagement.

References WsfWeaponEngagement::cDUD, WsfWeaponEngagement::Find(), simTime, SIMULATION, WsfWeaponEngagement::StringToEnum(), WsfWeaponEngagement::Terminate(), and TIME_NOW.

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [3/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
GetSubsCentroid ,
0 ,
"WsfGeoPoint" ,
""  )

WsfGeoPoint centroid = GetSubsCentroid() Returns the centroid of the subordinates on this platform's default command chain

References WsfGeoPoint::Clone(), WsfCommandChain::GetDefaultNameId(), and WsfCommandChain::GetSubordinates().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [4/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
IsUplinkingTo ,
1 ,
"bool" ,
"WsfPlatform"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [5/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
MaxSupportedUplinks ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [6/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
PerceivedAssets ,
0 ,
"Array<WsfAssetPerception>" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [7/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
PerceivedThreats ,
0 ,
"Array<WsfTrack>" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [8/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
PerceptionProcessor ,
0 ,
"WsfPerceptionProcessor" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [9/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
RoundsCompleteFor ,
1 ,
"int" ,
"WsfTrackId"  )

Returned the number of weapons that are complete for the specified task. int count = RoundsCompleteFor(WsfTrackId aTrackId);

References WsfWeapon::RoundsCompleteFor().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [10/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
RoundsFiredAt ,
1 ,
"int" ,
"WsfTrackId"  )

Returned the number of rounds that have been fired for the specified task. int count = RoundsFiredAt(WsfTrackId aTrackId);

References WsfWeapon::RoundsFiredAt().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [11/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
SalvosFiredAt ,
1 ,
"int" ,
"WsfTrackId"  )

Returned the number of salvos that have been fired for the specified task. int count = RoundsFiredAt(WsfTrackId aTrackId);

References WsfWeapon::SalvosFiredAt().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [12/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
StartUplinking_1 ,
1 ,
"bool" ,
"WsfPlatform"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [13/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
StartUplinking_2 ,
2 ,
"bool" ,
" WsfPlatform,
WsfTrack"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [14/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
StopUplinking ,
1 ,
"bool" ,
"WsfPlatform"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [15/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
TimeSinceWeaponLastFiredFor ,
1 ,
"double" ,
"WsfTrackId"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [16/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
TimeSinceWeaponLastTerminatedFor ,
1 ,
"double" ,
"WsfTrackId"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [17/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
UplinkCapable ,
0 ,
"bool" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [18/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
UplinkCount ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [19/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
UplinkPlatformEntry ,
1 ,
"WsfPlatform" ,
"int"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [20/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
UplinkProcessor ,
0 ,
"WsfUplinkProcessor" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [21/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
Weapon ,
1 ,
"WsfWeapon" ,
"string"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [22/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WeaponCount ,
0 ,
"int" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [23/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WeaponEngagement ,
0 ,
"WsfWeaponEngagement" ,
""  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [24/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WeaponEntry ,
1 ,
"WsfWeapon" ,
"int"  )

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [25/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WeaponsActiveFor ,
1 ,
"int" ,
"WsfTrackId"  )

Returned the number of weapons that are active for the specified task. int count = WeaponsActiveFor(WsfTrackId aTrackId);

References WsfWeapon::WeaponsActiveFor().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [26/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WeaponsPendingFor ,
1 ,
"int" ,
"WsfTrackId"  )

Returned the number of weapons that are pending for the specified task. int count = WeaponsPendingFor(WsfTrackId aTrackId);

References WsfWeapon::WeaponsPendingFor().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [27/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WithinFieldOfView_1 ,
2 ,
"bool" ,
" WsfTrack,
string"  )

bool withinFieldOfView = WithinFieldOfView(WsfTrack aTrack, string aSensorOrWeapon)

References simTime, TIME_NOW, trackPtr, WsfSensor::WithinFieldOfView(), and WsfWeapon::WithinFieldOfView().

◆ UT_DEFINE_SCRIPT_METHOD_EXT() [28/28]

WsfPlatformScriptMethods::UT_DEFINE_SCRIPT_METHOD_EXT ( WsfPlatform ,
WithinFieldOfView_2 ,
2 ,
"bool" ,
" WsfPlatform,
string"  )

bool withinFieldOfView = WithinFieldOfView(WsfPlatform aPlatform, string aSensorOrWeapon)

References platformPtr, simTime, TIME_NOW, WsfSensor::WithinFieldOfView(), and WsfWeapon::WithinFieldOfView().

Variable Documentation

◆ hasOpSub

bool WsfPlatformScriptMethods::hasOpSub = ::HasOperationalSubordinate(aObjectPtr, subType, checked)

Referenced by SetBool().

◆ subType

WsfStringId WsfPlatformScriptMethods::subType = WsfStringId(aVarArgs[0].GetString())

bool hasOpSub = HasOperationalSubordinate(string aType) This emulates the Suppressor SUB-STATUS IS SUB-OP (or SUB-O/A) resource allocation phrase.

Copyrights Multiple, All Rights Reserved