Config/Config Role

Roles

Defines all roles (Players) in the session.

Role

Defines a role. A Role have a user interface and is controlled by a human player.

A role is defined with the following 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. Possible receivers can be roles and mail groups, they are identified with their IDNames. Value example = ""B,C,MG-BC,MG-All" Can send mail to roles 'A' and 'B', and mail groups 'MG-BC' and 'MG-All'.
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"
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" File: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 = "X"      
    LongName = "Ground Chief X"
    Type = "Human"      
    MailSendTo = "X,Y"      
    MapStartCenterScrollPos = "20,20"          
    MapDB = "false" 
    MapDBTo = ""      
    SeeAllFire = "true"      
    ControlUnits = "F1,F2,F3,F4"
    RemeberUnitPosOnMap = "true"
    RemeberFireOnMap = "false"
    UserInterfaceLayout = "Ground Chief"
    UnitInfoDisplayOutline = "Ground Chief"/>