Symbol Configuration
MarkTypes
The xml element MarkTypes defines the mark object types that can be used in a session. A user can put mark objects on his or her map.
MarkType
Defines a mark objects type properties.
The mark type is defined with the following properties :
<source>
<MarkTypes>
<MarkType> ... </MarkType>
<MarkType> ... </MarkType>
...
<MarkType> ... </MarkType>
</MarkTypes>
</source>
The xml element MarkType defines a mark object type properties.
The mark type is defined with the following properties:
Property |
Value |
---|---|
IDName |
The identification name. This name must be unique, only one mark can have a specific IDName. Value example = "A","B" |
Multiple |
If it can exist more than one mark of this type of mark on the map at the same time. Value example="true", "false" |
AutoRemove |
If the mark should be automatically removed after a specific time. Value example= "true", "False" |
AutoRemoveTime |
Number of seconds that the mark should be visible on the map. Value example = "20" |
Flash |
If the mark should be flashing on the map. Value example= "true", "False" |
CreateSound |
The sound that should be activated when a role receive a mark. Value example = "sound.wav" |
<Source>
<MarkType
IDName = "F12"
Multiple = "false"
AutoRemove = "true"
AutoRemoveTime = "10"
Flash = "true"
CreateSound = "bottle-open.wav" />
</Source>
Mark Type Image
The image representing this mark object on the map should have the file name IDName with 'M12.gif'
as a extension ( <IDName>M12.gif).
The image file should be stored in the map image catalog <C3FIRE-MAP-IMAGES>, located at
<C3FIRE-WWW-ROOT>/pic/
Mark Send Rules
The xml element MarkSendRules defines rules that describes how a mark should be send between the roles (players).
MarkSendRule
A mark send rule is defined with the following properties :
Property |
Value |
---|---|
SenderRoleIDNames |
The senders that can send the marks defined by this rule. Value example = "X,Y", "Ch" |
MarkIDNames |
The marks that can be send. Value example = "A,B,C" |
ReceiverRoleIDNames |
The receivers of the mark Value example= "X,Y", "Ch" /> |
<Source>
<MarkSendRule
SenderRoleIDNames = "Y"
MarkIDNames = "F1,F2"
ReceiverRoleIDNames = "X" />
</Source>