WsfBMAuxDataZoneAttachment¶
-
WsfBMAuxDataZoneAttachmentConstruction:
WsfBMAuxDataZoneAttachment newObj = WsfBMAuxDataZoneAttachment();Clone:WsfBMAuxDataZoneAttachment newObj = WsfBMAuxDataZoneAttachment(other);
WsfBMAuxDataZoneAttachment is a convenience structure for pairing a WsfZone with a context and priority on a platform-parts Auxiliary data. Context in this case means zone type: DA, MEZ, FEZ, or JEZ. This capability can be used by supporting scripts to initialize weapon zones or DA zone perception within the battle manager models.
Methods¶
- void Add(string attachment_scope, double priority, string wsfzonedefinition_name, string zone_type)¶
Adds a zone attachment to the structure. More than one zone can be added for the case of a part that has multiple zone attachments.
Parameters
string attachment_scope: platform or global. If platform, indicates that the zone definition is to be found on the platform the part is attached to. If global, indicates the zone may be found in the static zone interface.
double priority: Zone priority 1.0 being the highest priority.
string wsfzonedefinition_name: Name of the referenced WsfzoneDefinition for reference later.
string zone_type: zone type mnemonic. One of: DA, MEZ, FEZ, or JEZ
- int GetCount()¶
Returns count of number of zones added to collection for this attachment instance.
- bool IsNthScopeGlobal()¶
Returns true if the nth zone in the collection is global scope, otherwise it is implied platform scope.
- bool IsNthScopePlatform()¶
Returns true if the nth zone in the collection is platform scope, otherwise it is implied global scope.
- double GetNthPriority()¶
Returns the nth zones priority in the collection.
- bool IsNthTypeMEZ()¶
Returns true if the nth zone in the collection is a MEZ, otherwise false.
- bool IsNthTypeFEZ()¶
Returns true if the nth zone in the collection is a FEZ, otherwise false.
- bool IsNthTypeJEZ()¶
Returns true if the nth zone in the collection is a JEZ, otherwise false.
