Config/Config Vehicle
Vehicles
The main configuration for all vehicles in a session are stored in the <Vehicles> element at top level the session configuration.
<Vehicles>
<Vehicle>...</Vehicle>
<Vehicle>...</Vehicle>
...
</Vehicles>
Vehicle Main
The main configuration for a vehicles are stored in the <Vehicle> element inside <Vehicles> element.
The vehicle main configuration element contain:
- Vehicle general information
- Module specific information
- Images
- Text displayed in user interface
- User interface information
<Vehicles>
<Vehicle
IDName = "CP"
NameShort = "CP"
NameLong = "Command Patrol"
Type = "Command Patrol"
Activity = ""
Assignment = ""
Description = ""
DescriptionHTML = ""
DriveCompetence = ""
Equipment = ""
Free = "1"
HomeBase = "Army Post"
InteractionDistance = "1.0"
LatLonAlt = ""
LatLonAltGoto = ""
LatLonAltProposal = ""
LatLonAltRequest = ""
LatLonAltSuggestion = ""
Location = "Army Post"
LocationGoto = ""
LocationProposal = ""
LocationRequest = ""
LocationSuggestion = ""
MapZoneCanGoTo = "Blue"
MobilisingTime = "90"
MoveFlying = "False"
MoveFlyingIsHovering = "False"
MoveFlyingLandingLocations = ""
MovingSpeedMax = "1200.0"
MovingSpeedNormal = "600.0"
NameList = "CP"
Points = "0.0"
Pos = ""
PosGoto = ""
PosProposal = ""
PosRequest = ""
PosSuggestion = ""
RoadPathColor = "#0000FF"
SeatAmount = "5"
Task = ""
UnitID = "CP"
ViewDistance = "1.0"
VisibleFromAir = "True" >
<Aid />
<Bomb/>
<Fuel />
<Money/>
<Supply/>
<Transport/>
<Water/>
<Texts>...</Texts>
<Images>...</Images>
<VehicleUI/>
</Vehicle>
Vehicle general information
Parameters |
Description |
---|---|
IDName |
Value example = "CP" |
NameShort |
Value example = "CP" |
NameLong |
Value example= "Command Patrol" |
Type |
Value example = "Command Patrol" |
Activity |
Value example= "" |
Assignment |
Value example= "" |
Description |
Value example= "" |
DescriptionHTML |
Value example= "" |
DriveCompetence |
Value example= "" |
Equipment |
Value example= "" |
Free |
Value example= "1" |
HomeBase |
Value example= "Army Post" |
InteractionDistance |
Value example= "1.0" |
LatLonAlt |
Value example= "" |
LatLonAltGoto |
Value example= "" |
LatLonAltProposal |
Value example= "" |
LatLonAltRequest |
Value example= "" |
LatLonAltSuggestion |
Value example= "" |
Location |
Value example= "Army Post" |
LocationGoto |
Value example= "" |
LocationProposal |
Value example= "" |
LocationRequest |
Value example= "" |
LocationSuggestion |
Value example= "" |
MapZoneCanGoTo |
Value example= "Blue" |
MobilisingTime |
Value example= "90" |
MoveFlying |
Value example= "False" |
MoveFlyingIsHovering |
Value example= "False" |
MoveFlyingLandingLocations |
Value example= "" |
MovingSpeedMax |
Value example= "1200.0" |
MovingSpeedNormal |
Value example= "600.0" |
NameList |
Value example= "CP" |
Points |
Value example= "0.0" |
Pos |
Value example= "" |
PosGoto |
Value example= "" |
PosProposal |
Value example= "" |
PosRequest |
Value example= "" |
PosSuggestion |
Value example= "" |
RoadPathColor |
Value example= "#0000FF" |
SeatAmount |
Value example= "5" |
Task |
Value example= "" |
UnitID |
Value example= "CP" |
ViewDistance |
Value example= "1.0" |
VisibleFromAir |
Value example= "True" > |
<Vehicles>
<Vehicle
IDName = "CP"
NameShort = "CP"
NameLong = "Command Patrol"
Type = "Command Patrol"
Activity = ""
Assignment = ""
Description = ""
DescriptionHTML = ""
DriveCompetence = ""
Equipment = ""
Free = "1"
HomeBase = "Army Post"
InteractionDistance = "1.0"
LatLonAlt = ""
LatLonAltGoto = ""
LatLonAltProposal = ""
LatLonAltRequest = ""
LatLonAltSuggestion = ""
Location = "Army Post"
LocationGoto = ""
LocationProposal = ""
LocationRequest = ""
LocationSuggestion = ""
MapZoneCanGoTo = "Blue"
MobilisingTime = "90"
MoveFlying = "False"
MoveFlyingIsHovering = "False"
MoveFlyingLandingLocations = ""
MovingSpeedMax = "1200.0"
MovingSpeedNormal = "600.0"
NameList = "CP"
Points = "0.0"
Pos = ""
PosGoto = ""
PosProposal = ""
PosRequest = ""
PosSuggestion = ""
RoadPathColor = "#0000FF"
SeatAmount = "5"
Task = ""
UnitID = "CP"
ViewDistance = "1.0"
VisibleFromAir = "True" >
Properties
Property |
Value |
---|---|
IDName |
Possible values = "True", "False" |
NameShort |
Value example = "100" |
NameLong |
Value example = "50" |
Type |
Value example = "10" |
Activity |
Possible values are depending on the active module. Main activities are:
|
Assignment |
This value defines what assignment the vehicle are assigned to when the session starts. Possible values are depending on the scenario and what are happening in the session. |
Description |
General description of this vehicle. Free text. |
DescriptionHTML |
General description of this vehicle. The text should be written in html. |
DriveCompetence |
The Competence the driver and operator needs to have to be able to drive or operate the vehicle. The value should be a ',' seperated list of competence ID names. |
Equipment |
The Equipments that are in the vehicle |
Free |
True if the Vehicle can be assigned to a new asignment. Possibel values: "True","False","1","0","Yes","No" |
HomeBase |
The home location or station for this vehicle. Value should be a ID name for a location. |
InteractionDistance |
The maximum distance this vehicle can have to an object,vehilce or person when performing some interaction. The value is should be defined in the same scale at how the position is defined in the session. If the session uses longitude and latitude then the value is based on that. Value example = "100" |
LatLonAlt |
The current position of the vehicle. Defined with Latetude, Longetude and Altitude The position can be defined by all values "<Latetude>,<Longetude>,<Altitude>", or only two values "<Latetude>,<Longetude>". |
LatLonAltGoto |
The position that the vehicle currently are moving towards. Defined with Latetude, Longetude and Altitude The position can be defined by all values "<Latetude>,<Longetude>,<Altitude>", or only two values "<Latetude>,<Longetude>". |
LatLonAltProposal |
The position an operator is asking a decision tool to get comments on. Defined with Latetude, Longetude and Altitude The position can be defined by all values "<Latetude>,<Longetude>,<Altitude>", or only two values "<Latetude>,<Longetude>". |
LatLonAltRequest |
A position that some other player or decision support tool recommend the vehicle to move towards. Defined with Latetude, Longetude and Altitude The position can be defined by all values "<Latetude>,<Longetude>,<Altitude>", or only two values "<Latetude>,<Longetude>". |
LatLonAltSuggestion |
A position that some decision support tool give as a suggestion on where to move towards. Defined with Latetude, Longetude and Altitude The position can be defined by all values "<Latetude>,<Longetude>,<Altitude>", or only two values "<Latetude>,<Longetude>". |
Location |
The current location of the vehicle The location should be defined by a name given position on the map. |
LocationGoto |
The location that the vehicle currently are moving towards. The location should be defined by a name given position on the map. |
LocationProposal |
The location an operator is asking a decision tool to get comments on. The location should be defined by a name given position on the map. |
LocationRequest |
A location that some other player or decision support tool recommend the vehicle to move towards. The location should be defined by a name given position on the map. |
LocationSuggestion |
A location that some decision support tool give as a suggestion on where to move towards. The location should be defined by a name given position on the map. |
MapZoneCanGoTo |
Zone areas that this vehicle can be in. A vehicle can not move to a position outside its allowed zoones. If the zoon are empty "" the Vehicle can go to any zoon on the map. Example: "Road,Feeld", "Water", "Road,Feeld,Montain", "Red,Blue". |
MobilisingTime |
"90" |
MoveFlying |
If the vehicle can fly Possibel values: "True","False","1","0","Yes","No" |
MoveFlyingIsHovering |
If the vhecle can hover. standing still while flying. Possibel values: "True","False","1","0","Yes","No" |
MoveFlyingLandingLocations |
Locations where the vehicle can land. |
MovingSpeedMax |
The vehicles maximum speed. "1200.0" |
MovingSpeedNormal |
The Vehicle preferred speed. "600.0" |
NameList |
"CP" |
Points |
The number of point this vehicle have get in the game. "0.0" |
Pos |
|
PosGoto |
|
PosProposal |
|
PosRequest |
|
PosSuggestion |
|
RoadPathColor |
The color of the route that his unit are following when it moves on the map "#0000FF" |
SeatAmount |
The number of seats this vehicle have. Value example: "5" |
Task |
|
UnitID |
|
ViewDistance |
|
VisibleFromAir |
If this vehicle are visible from air |
Module specific information
<Vehicle>
...
<Aid />
<Bomb/>
<Fuel />
<Money/>
<Supply/>
<Transport/>
<Water/>
...
</Vehicle>
<Fuel
Active = "True"
Amount = "100"
BuySellFrom_Control = "None"
BuySellFrom_Distance = "10"
BuySellFrom_ScorePoints = "0.0"
BuySellFrom_Speed = "1.0"
BuySellFrom_ToStations = ""
BuySellFrom_ToVehicles = ""
BuySellTo_Control = "None"
BuySellTo_Distance = "10"
BuySellTo_FromStations = ""
BuySellTo_FromVehicles = ""
BuySellTo_ScorePoints = "0.0"
BuySellTo_Speed = "1.0"
DropControl = "None"
DropScorePoints = "0.0"
DropSpeed = "1.0"
GiveFrom_Control = "None"
GiveFrom_Distance = "10"
GiveFrom_ScorePoints = "0.0"
GiveFrom_Speed = "1.0"
GiveFrom_ToStations = ""
GiveFrom_ToVehicles = ""
GiveTo_Control = "None"
GiveTo_Distance = "10"
GiveTo_FromStations = ""
GiveTo_FromVehicles = ""
GiveTo_ScorePoints = "0.0"
GiveTo_Speed = "1.0"
LoadFrom_Control = "None"
LoadFrom_Distance = "10"
LoadFrom_ScorePoints = "0.0"
LoadFrom_Speed = "10"
LoadFrom_ToStations = ""
LoadFrom_ToVehicles = ""
LoadTo_Control = "None"
LoadTo_Distance = "10"
LoadTo_FromStations = "Army Post"
LoadTo_FromVehicles = ""
LoadTo_ScorePoints = "0.0"
LoadTo_Speed = "10"
MakeControl = "None"
MakeScorePoints = "0.0"
MakeSpeed = "0"
MovingCountDownAmount = "2.0"
OutOfEffect = "HomeBase"
OutOfEffectAmount = "0"
OutOfEffectScorePoints = "0.0"
OutOfEffectTime = "10"
StorageIDName = ""
StorageSize = "100"
StorageVehicle = "False"
TakeFrom_Control = "None"
TakeFrom_Distance = "30"
TakeFrom_ScorePoints = "0.0"
TakeFrom_Speed = "1.0"
TakeFrom_ToStations = ""
TakeFrom_ToVehicles = ""
TakeTo_Control = "None"
TakeTo_Distance = "30"
TakeTo_FromStations = ""
TakeTo_FromVehicles = ""
TakeTo_ScorePoints = "0.0"
TakeTo_Speed = "1.0" />
Properties
Property |
Value |
---|---|
Active |
Possible values = "True", "False" |
Amount |
Value example = "100" |
BuySellFrom_Control |
Value example = "None" |
BuySellFrom_Distance |
Value example = "10" |
BuySellFrom_ScorePoints |
Value example = "0.0" |
BuySellFrom_Speed |
Value example = "1.0" |
BuySellFrom_ToStations |
This vehicle can sell fuel from this vehicle to the following stations. Value example = "" |
BuySellFrom_ToVehicles |
This vehicle can sell fuel from this vehicle to the following vehicles. Value example = "" |
BuySellTo_Control |
Value example = "None" |
BuySellTo_Distance |
Value example = "10" |
BuySellTo_ScorePoints |
Value example = "0.0" |
BuySellTo_Speed |
Value example = "1.0" |
BuySellTo_FromStations |
This vehicle can buy fuel from the following stations. Value example = "" |
BuySellTo_FromVehicles |
This vehicle can buy fuel from the following vehicles. Value example = "" |
Value example = "" |
Texts
The texts possible to use for this object are defined in the <Texts> element.
<Texts>
<Text/>
<Text/>
...
<Text/>
</Texts>
A text is defined with the following properties:
Parameters |
Description |
Only Used In |
---|---|---|
Name |
The identification name. Should be unique for this object. Example value: "ShortName", "Description-HTML" |
|
Type |
The formatting type of the text. Possible values: "Normal","Formatted", "Html" |
|
BackgroundColor |
The background color used when displayed in a text format supported display area. Exampe values: "#FF0000", "#FF9A00" |
|
FontName |
The font name used when displayed in a text format supported display area. Example values: "Arial" |
|
FontSize |
The font size used when displayed in a text format supported display area. Example values: "12" |
|
FontStyleBold |
If the font style should have bold activated when displayed in a text format supported display area. Possible values: "True","False","Yes","No" |
|
FontStyleItalic |
If the font style should have italic activated when displayed in a text format supported display area. Possible values: "True","False","Yes","No" |
|
Text |
The text that should be used. Example values: "Hello World" |
|
TextColor |
The text color used when displayed in a text format supported display area. Exampe values: "#FF0000", "#FF9A00" |
|
ZeroPos |
The position correction for the displayed in a text format supported display area. Example values: "-5,-4" |
Xml configuration example:
<Text
Name = "MapReal"
Type = "Formatted"
BackgroundColor = ""
FontName = "Arial"
FontSize = "24"
FontStyleBold = "True"
FontStyleItalic = "False"
Text = "Village A"
TextColor = "#EEEEEE"
ZeroPos = "-50,-50" />
Images
The images possible to use for this object are defined in the <Images> element.
<Images>
<Image/>
<Image/>
...
<Image/>
</Images>
A Image is defined with the following properties:
Parameters |
Description |
Only Used In |
---|---|---|
Name |
The identification name. Should be unique for this object. Example value: "ShortName", "Description-HTML" |
|
CreateMethod |
How the image is crated. Possible values: "Load","Create" |
|
BackgroundColor |
The background color used when displayed in a text format supported display area. Exampe values: "#FF0000", "#FF9A00" |
|
BorderColor |
The background color of the border around the image Exampe values: "#FF0000", "#FF9A00" |
|
BorderSize |
The size of the border around the image Example values: "1" |
|
FileName |
A relative path and file name to the image file. Example value: "Station/ArmyPost.png" |
|
FontName |
The font name used when displayed in a text format supported display area. Example values: "Arial" |
|
FontSize |
The font size used when displayed in a text format supported display area. Example values: "12" |
|
FontStyleBold |
If the font style should have bold activated when displayed in a text format supported display area. Possible values: "True","False","Yes","No" |
|
FontStyleItalic |
If the font style should have italic activated when displayed in a text format supported display area. Possible values: "True","False","Yes","No" |
|
Size |
The size of the created image. Example values: "80,20" |
|
Text |
The text that should be used. Example values: "Hello World" |
|
TextColor |
The text color used when displayed in a text format supported display area. Exampe values: "#FF0000", "#FF9A00" |
|
ZeroPos |
The position correction for the displayed in a text format supported display area. Example values: "-5,-4" |
Xml configuration example:
<Image
Name = "MapReal"
BackgroundColor = "#AAAAFF"
BorderColor = "#000000"
BorderSize = "0"
CreateMethod = "Load"
FileName = "Station/VillageA.png"
FontName = ""
FontSize = ""
FontStyleBold = ""
FontStyleItalic = ""
Size = ""
Text = ""
TextColor = ""
ZeroPos = "" />
User interface
<Vehicle>
...
<VehicleUI
...
/>
</Vehicle>