C3Conflict Session Configuration

From C3LearningLabs

C3ll-head-under-construction-small.png

Session Configuration

Config Include File

The configuration can be splitted in a set of files each containing a specific configurtion.

How to use configuration include files are described in page Config Include File.

Session Info

The xml element SessionInfo contain information about a sessions classification in an experiment series. The information is used to classify a session in the experiment. The information in the SessionInfo element is used in the analyze phase after a session. is helps the anlyser to sort all logfiles generated in the experiment. The information is not used during a session. It does not affect the simulation. It is optional to complete the different properties of SessionInfo. A property can be left without information.

The SessionInfo is defined with the following properties:


<SessionInfo
   ExperimentGroup = "gl"
   ExperimentName = "gl1"
   ConditionNumber = "1"
   ConditionName = "Digital"
   ServerNumber = "0"
   ServerName = ""
   SessionType = ""
   SessionNumber   = "2"
   SessionName = ""
   SessionConfigFileName = "gl1-Condition1-Session2.con"
   SessionScenarioFileName = "gl1-Condition1-Session2.sce"
   SessionPicDirectory = ""
 />


Property

Value

ExperimentGroup

The name of the group or project that perform the experiment.

Value example = "gl",""

ExperimentName

The name of the experiment.

Value example = "gl1",""

ConditionNumber

The number of the condition.

Value example = "1",""

ConditionName

The name of the condition.

Value example = "Digital",""

ServerNumber

The number of the server.

Value example = "0",""

ServerName

The name of the server.

Value example = ""

SessionType

The type of the session.

Value example= ""

SessionNumber

The number of the session.

Value example = "2",""

SessionName

The name of the session.

Value example = ""

SessionConfigFileName

The name of the sessions configuration file.

Value example = "gl1-Condition1-Session2.con",""

SessionScenarioFileName

The name of the sessions scenario file.

Value example = "gl1-Condition1-Session2.sce",""

SessionPicDirectory

The name of the experiment.

Value example = ""


<Source>
   <SessionInfo
    ExperimentGroup = "gl"
    ExperimentName = "gl1"
    ConditionNumber = "1"
    ConditionName = "Digital"
    ServerNumber = "0"
    ServerName = ""
    SessionType = ""
    SessionNumber   = "2"
    SessionName = ""
    SessionConfigFileName = "gl1-Condition1-Session2.con"
    SessionScenarioFileName = "gl1-Condition1-Session2.sce"
    SessionPicDirectory = ""
  />
</Source>


Roles

The xml element Roles defines all roles (Players) in a session.

<Roles>

 <Role> ... </Role>
 <Role> ... </Role>
 ...
 <Role> ... </Role>

</Roles>


The xml element Role defines a player in a session and contain a set of basic properties. Beside the basic properties the activated modules can add properties for the roles. See documentation for each module.

The role has the following basic properties:


Property

Value

IDName

The identification name. This name must be unique, only one role can have a specific IDName. The
IDName is used to identify a role in the mail communication between the roles, in the mangers observation
tool etc.

Value example = "X", "Y", "Chief", "CH"

LongName

The long name is a used to be a describing name for a role

Value example = "Fire fighting unit chief X"

Type

The type of the role.

Possible Values = "Human"

MailSendTo

All mail addresses that this role can send mail to.

Value example = "X,Y,Chief,CH"

MapStartCenterScrollPos

The scroll pos of the map at start. The value is the position on the map that should be displayed in the center of the visible map area.

Value example = "20,20" MapStartCenterScrollPos

ControlUnits

The IDName of the units that this role control.

Value = "1,2,3,4"
Value example= "CP"

ControlStations

Value example = ""

LongName

Value example= "Pilot-1"

MailSendTo

Value example= "Blue"

MapDB

If the map manipulation should be send to some other role and displayed on that roles map.
Possible values = "True", "False"

Value example= "false"

MapDBTo

The roles that the map manipulation should be send to.
Value example = "X", "Y", "Chief", "CH"

Value example= ""

MapStartCenterScrollPos

Value example= "25,25"

Points

Value example= "1.0"

RemeberFireOnMap

If all fire simulation events should be remembered on the map.

If true then all fire events exposed on the map is remembered
also when they are not in the sight of units controlled by this
role. If false then all fire events vanish from the map when they
no longer is in sight of units controlled by this role.


Possible values = "True","False" Value example= "False" C3system-config-session-role-remember-fire-on-map-true-small.gif C3system-config-session-role-remeber-fire-on-map-false-small.gif

RemeberUnitPosOnMap

If the position of a unit that is not controlled by this role should be remembered on the map. If true then the
position of the unit is remembered on the map also when it is not in the sight of units controlled by this
role. Note, this remembered position may not after some time correspond with the units real position. If
false then the position vanish from the map when the unit is no longer in sight of units controlled by this role.

Possible values = "True", "False"
Value example= "false"

SeeAllFire

If all fire simulation events should be displayed on the map. If true then the role see all fire
Possible values = "True", "False"

Value example= "True"

SeeAllMap

Value example= "True"

SeeAllObjects

Value example= "True"

UnitInfoDisplayOutline

The name of the UnitInfoDisplayOutline that this role should have.
The UnitInfoDisplayOutlines are defined in the <UnitInfoDisplay> element in this xml file.

Value example = "Ground Chief"

See more in the menu selection session UI.
Value example= "Ground Chief"

UserInterfaceLayout

The name of the user interface layout that the role should have.
The user interfaces are defined in the <UserInterfaceLayout> element in this xml file.

Value example = "Ground Chief"

See more in the menu selection session UI.
Value example= "Blue" />

   <Role      
      IDName = "Blue"
      Type = "Human"
      ControlUnits = "CP"
      ControlStations = ""
      LongName = "Pilot-1"
      MailSendTo = "Blue"
      MapDB = "false"
      MapDBTo = ""
      MapStartCenterScrollPos = "25,25"
      Points = "1.0"
      RemeberFireOnMap = "False"
      RemeberUnitPosOnMap = "false"
      SeeAllFire = "False"
      SeeAllMap = "True"
      SeeAllObjects = "True"
      UnitInfoDisplayOutline = "Ground Chief"
      UserInterfaceLayout = "Blue" />

Object Types

The xml element ObjectTypes defines all the geographical object types in a session.

<source>
<ObjectTypes>
  <ObjectType> ... </ObjectType>
  <ObjectType> ... </ObjectType>
  ...
  <ObjectType> ... </ObjectType>
</ObjectTypes>
</source>

The xml element ObjectType defines a geographical object type and contain a set of basic properties. Beside the basic properties the activated modules can add properties for the ObjectTypes. See documentation for each module.

A geographical object type is defined with the following properties:

Property

Value

IDName

Value example= "Normal"

FireSpeed

Value example= "1"/>

<Source>
 <ObjectType
  IDName = "Normal"
  FireSpeed = "1"/>
</Source>

Property

Value

IDName

The identification name for a object type.

Value example = "Pine", "Birch", "House", "Water"

FireSpeed

The fire spread factor for this object. The ignite time is multiplied with this value.

Value example= "1"/>
Value example = "0.5"
For more information see the fire simulation documentation.

WaterRefillSpeed

The amount of water this object can to deliver every second to a unit that is refilling water from this object.
Apply on object type "water". Value example = "15"

Module : Water Logistic

Should only be defined if the module WaterLogistic is active.

FuelRefillSpeed

The amount of fuel this object can to deliver every second to a unit that is refilling fuel from this object. Apply on object type "fuel". Value example = "15"

Module : Fuel Logistic

Should only be defined if the module FuelLogistic is active.

<ObjectType

 IDName = "Water" 
 FireSpeed = "1"
 WaterRefillSpeed  = "15"
 FuelRefillSpeed  = "2.5"/>

Objects

The xml element Objects contains all map objects that should exist in the simulation.

Object

Defines where a map object should exist.

Configuration example:

<source>
<Objects>
  <Object> ... </Object>
  <Object> ... </Object>
  ...
  <Object> ... </Object>
 <Object Type = "Pine" Pos = "12,12" />
    <Object Type = "Pine" Pos = "12,11" />
    <Object Type = "Pine" Pos = "11,2" />
    <Object Type = "Birch" Pos = "38,23" />
    <Object Type = "Birch" Pos = "23,40" />
    <Object Type = "Birch" Pos = "2,32" />
    <Object Type = "House" Pos = "40,40" />
    <Object Type = "Water" Pos = "17,22" />
    <Object Type = "Fuel"  Pos = "11,12" />
    <Object Type = "Water"  Pos = "10,10" />
</Objects>
</source>


A object is defined with the following properties:

Property

Value

Type

The object type identification number.

Value example = "House"
Value example= "Pine"

Pos

Pos on the map

Value example = "2, 20"
Value example= "12,12"

<Source>
    <Object
        Type = "Pine" 
         Pos = "12,12" 
    />
</Source>

Object Image

The image representing this object on the map should have the file name IDName with '12.gif' as a
extension ( <IDName>12.gif).

Example : Pine12.gif

The image file should be stored in the map image catalog <C3FIRE-MAP-IMAGES> , located at <C3FIRE-WWW-ROOT>/pic/

Example : C:\c3fire\www\pic\Pine12.gif


The standard experiment setting defines four object types. They are Normal, Pine, Birch and House.
The module extended setting defines an additional object type, Water. The type must be represented
of an image, named and saved according to examples above.


Standard experiment setting

Normal : C3system-config-session-unit-window-image-normal12.gif

Pine : C3system-config-session-unit-window-image-pine12.gif

Birch : C3system-config-session-unit-window-image-birch12.gif

House : C3system-config-session-unit-window-image-house12.gif


Module extended setting
Water : C3system-config-session-unit-window-image-water12.gif


C3system-config-session-unit-window-image-geographical-objects.gif
The different
geographical objects

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

Vehicle general information

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:
"Idle","Moving"

  • Idle
  • Moving

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.
This value use to be "" if the vehicle are not assign to a specific assignment when the session starts.

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.
Value example = "LadderDriver,Driver,FireFighter"

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.
Value example = "Army Post"

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>".
Value example: ",,", ",".

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>".
Value example: ",,", ",".

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>".
Value example: ",,", ",".

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>".
Value example: ",,", ",".

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>".
Value example: ",,", ",".

Location

The current location of the vehicle

The location should be defined by a name given position on the map.
The location can be defined in the 1) map configuration, 2) Open Street Map data, or 3) In a dynamic assigned mission.
For more information on locations see Location Definitions.
Value example: "Army Post", "Mission A", "Moonstreet 20"

LocationGoto

The location that the vehicle currently are moving towards.

The location should be defined by a name given position on the map.
The location can be defined in the 1) map configuration, 2) Open Street Map data, or 3) In a dynamic assigned mission.
For more information on locations see Location Definitions.
Value example: "Army Post", "Mission A", "Moonstreet 20"

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.
The location can be defined in the 1) map configuration, 2) Open Street Map data, or 3) In a dynamic assigned mission.
For more information on locations see Location Definitions.
Value example: "Army Post", "Mission A", "Moonstreet 20"

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.
The location can be defined in the 1) map configuration, 2) Open Street Map data, or 3) In a dynamic assigned mission.
For more information on locations see Location Definitions.
Value example: "Army Post", "Mission A", "Moonstreet 20"

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.
The location can be defined in the 1) map configuration, 2) Open Street Map data, or 3) In a dynamic assigned mission.
For more information on locations see Location Definitions.
Value example: "Army Post", "Mission A", "Moonstreet 20".

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

Vehicle general information

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 = ""


Images

    <Vehicle>
        ...
        <Images>...</Images>
        ...
    </Vehicle>


Texts

    <Vehicle>
        ...
        <Texts>...</Texts>
        ...
    </Vehicle>


User interface

    <Vehicle>
        ...
        <VehicleUI
            ...
        />
    </Vehicle>



Stations

The configuration element <Stations> defines all the Stations in a session. The <Stations> element is located in the root element, at top level in the session configuration file. The <Stations> element can be moved to a separate configuration file, by using session include parameter ConfigIncludeFileStations in the main configuration file. For more instruction how to use session include, see Session Include. It is recommended to move the session configuration to a separate file.

<Stations>
  <Station> ... </Station>
  <Station> ... </Station>
  ...
  <Station> ... </Station>
</Stations>

Station

The configuration element <Station> defines a station and contain a set of basic properties. Beside the basic properties the activated modules can add properties for the Station. See documentation for each module.

A station is defined with the following properties:

    <Station
      IDName = "Army Post"
      NameShort = "Army Post"
      NameLong = "Army Post"
      Type = "Heltid"
      ControledBy = "AutoC3Basic"
      Description = ""
      DescriptionHTML = ""
      Location = "Army Post"
      Personnel = ""
      Points = "0.0"
      Pos = "10,10"
      Vehicle = "" >

        <Texts> ... </Texts>
        <Images> ... </Images>
        <StationUI> ... <StationUI>

        <ItemObjects> ... </ItemObjects>
        <ItemInteractions> ... </ItemInteractions>

        <!-- Module specific configuration -->
        <Aid> ... </Aid>
        <Bomb> ... </Bomb>
        <Fuel> ... </Fuel>
        <Money> ... </Money>
        <Supply> ... </Supply>
        <Transport> ... </Transport>
        <Water> ... </Water>

    </Station>

Main properties

A station is defined with the following main properties.

Station Parameters

Parameters

Description

Only Used In

IDName

The identification name. Should be unique, and are used in the configuration.

Example value: "S1", "Army Post", "Hospital"

NameShort

A standard short name
This parameter can be used, but will be deprecated, and should be removed in future versions. It will be replaced with the usage of the <Texts> ... </Texts> element described below.

NameLong

The size of the panel.

A standard long name
This parameter can be used, but will be deprecated, and should be removed in future versions. It will be replaced with the usage of the <Texts> ... </Texts> element described below.

Type

The stations type, based on Swedish standard.

Possible values are "Heltid" and "Deltid".

C3Rescue

ControledBy

How the station in controlled.

Possible values are "Player","AutoC3Basic".

Description

A standard description
This parameter can be used, but will be deprecated, and should be removed in future versions. It will be replaced with the usage of the <Texts> ... </Texts> element described below.

DescriptionHTML

A standard html description
This parameter can be used, but will be deprecated, and should be removed in future versions. It will be replaced with the usage of the <Texts> ... </Texts> element described below.

Location

The position this station is on, defined by a location ID.
This values is used if not parameter Pos is defined below.
The location should be defined in the <Locations> ... </Locations> element, described at Locations.

Personnel

The personnel that have their home station in this station is defined here.
The personnel is defined by personnel IDNames separated with ,.

Value Example = ""

Points

The number of points this station have.
The personnel is defined by personnel IDNames separated with ,.

Value Example = "234.5"

Pos

The position this station is on.
This values is used if it is defined. if this value is not defined the position will be defined by the if not parameter Location.

Vehicle

The vehicles that have their home station in this station is defined here.
The vehicles is defined by vehicle IDNames separated with ,.

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:

Text Parameters

Parameters

Description

Only Used In

Name

The identification name. Should be unique for this object.
Should be unique in this <Texts> ... <Texts> element.

Example value: "ShortName", "Description-HTML"

Type

The formatting type of the text.

Possible values: "Normal","Formatted", "Html"
Normal: The text is used as it is in the UI, Logfiles, etc.
Formatted: The text is formatted using the font and color description in this text, when displayed in a html supported display area.
Html: The text is formatted as html, when displayed in a html supported display area.

BackgroundColor

The background color used when displayed in a text format supported display area.
Hexadecimal color code definition "#FFFFFF", #(Red)(Green)(Blue)

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.
Hexadecimal color code definition "#FFFFFF", #(Red)(Green)(Blue)

Exampe values: "#FF0000", "#FF9A00"

ZeroPos

The position correction for the displayed in a text format supported display area.

Example values: "-5,-4"
If the value are (-5,-4) then the centre position for the text is moved 5 pixels towards west and 4 pixels towards north.

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:

Text Parameters

Parameters

Description

Only Used In

Name

The identification name. Should be unique for this object.
Should be unique in this <Texts> ... <Texts> element.

Example value: "ShortName", "Description-HTML"

CreateMethod

How the image is crated.

Possible values: "Load","Create"
Load: The image are loaded.
Create: The image is an text that is created with the defined formatting.

BackgroundColor

The background color used when displayed in a text format supported display area.
Hexadecimal color code definition "#FFFFFF", #(Red)(Green)(Blue)

Exampe values: "#FF0000", "#FF9A00"

BorderColor

The background color of the border around the image
Hexadecimal color code definition "#FFFFFF", #(Red)(Green)(Blue)

Exampe values: "#FF0000", "#FF9A00"

BorderSize

The size of the border around the image
Value is difined in pixels.

Example values: "1"

FileName

A relative path and file name to the image file.
The path is relative to:
<C3FIRE-IMAGES> = ...\C3LearningLabs\C3Fire\Client\Files\ROOT\Image\
Same structure for C3Rescue and C3Conflict.

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.
The value is in format "width,height"

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.
Hexadecimal color code definition "#FFFFFF", #(Red)(Green)(Blue)

Exampe values: "#FF0000", "#FF9A00"

ZeroPos

The position correction for the displayed in a text format supported display area.

Example values: "-5,-4"
If the value are (-5,-4) then the centre position for the text is moved 5 pixels towards west and 4 pixels towards north.

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 = "" />


StationUI

The startion UI element defines what UI configuration to use for this startion.
The startion UI is defined with the following properties:

Text Parameters

Parameters

Description

Only Used In

ActivityControlPanelName

The identification name of the station activity control user interface specification.
The specification should be defined in the <StationActivityControls> ... <StationActivityControls> element in the <UserInterfaceGlobal> element.

Example value: "Army Post"

ActivityControlPanelText

The text displayed at the border of the activity control panel.
The text should be defined in the <Texts> element.

Exampe values: "PanelText"

MapRealPosImage

The station image displayed on the map
The image should be defined in the <Images> element.

Exampe values: "MapReal"

MapRealPosText

The text displayed near the station image on the map
The text should be defined in the <Texts> element.

Exampe values: "MapReal"

Xml configuration example:

      <StationUI
        ActivityControlPanelName = "Army Post"
        ActivityControlPanelText = "PanelText"
        MapRealPosImage = "MapReal"
        MapRealPosText = "MapReal" />