TABLE OF CONTENTS

Messages/Messages [ Packages ]

[ Top ] [ Packages ]

FUNCTION

 Provides code for manipulate in game messages

SOURCE

package Messages is

Messages/Messages.Message_Color [ Types ]

[ Top ] [ Messages ] [ Types ]

FUNCTION

 Colors of messages

SOURCE

   type Message_Color is (WHITE, YELLOW, GREEN, RED, BLUE, CYAN) with
      Default_Value => WHITE;

Messages/Messages.Message_Type [ Types ]

[ Top ] [ Messages ] [ Types ]

FUNCTION

 Types of messages

SOURCE

   type Message_Type is
     (DEFAULT, COMBATMESSAGE, TRADEMESSAGE, ORDERMESSAGE, CRAFTMESSAGE,
      OTHERMESSAGE, MISSIONMESSAGE) with
      Default_Value => DEFAULT;

Messages/Messages.Message_Data [ Records ]

[ Top ] [ Messages ] [ Records ]

FUNCTION

 Data structure for messages

SOURCE

   type Message_Data is record
      Message: Unbounded_String;
      M_Type: Message_Type;
      Color: Message_Color;
   end record;

PARAMETERS

 Message  - Text of message
 M_Type   - Type of message
 Color    - Color used for show message

Messages/Messages.Default_Message_Color [ Constants ]

[ Top ] [ Messages ] [ Constants ]

FUNCTION

 The default color of the in-game messages

SOURCE

   Default_Message_Color: constant Message_Color := WHITE;

Messages/Messages.Default_Message_Type [ Constants ]

[ Top ] [ Messages ] [ Constants ]

FUNCTION

 The default type of the in-game messages

SOURCE

   Default_Message_Type: constant Message_Type := DEFAULT;

Messages/Messages.Empty_Message [ Constants ]

[ Top ] [ Messages ] [ Constants ]

FUNCTION

 The empty in-game message

SOURCE

   Empty_Message: constant Message_Data :=
     (Message => Null_Unbounded_String, M_Type => Default_Message_Type,
      Color => Default_Message_Color);

Messages/Messages.Add_Message [ Subprograms ]

[ Top ] [ Messages ] [ Subprograms ]

FUNCTION

 Add new message to list

SOURCE

   procedure Add_Message
     (Message: String; M_Type: Message_Type;
      Color: Message_Color := WHITE) with
      Pre => Message'Length > 0;

PARAMETERS

 Message  - Text of message to add
 M_Type   - Type of message to add
 Color    - Color of message to add

Messages/Messages.Clear_Messages [ Subprograms ]

[ Top ] [ Messages ] [ Subprograms ]

FUNCTION

 Remove all messages

SOURCE

   procedure Clear_Messages with
      Import => True,
      Convention => C,
      External_Name => "clearMessages";

Messages/Messages.Formated_Time [ Subprograms ]

[ Top ] [ Messages ] [ Subprograms ]

FUNCTION

 Format game time

SOURCE

   function Formated_Time(Time: Date_Record := Game_Date) return String with
      Post => Formated_Time'Result'Length > 0;

PARAMETERS

 Time - Game time to format. Default is current game time

RESULT

 Formatted in YYYY-MM-DD HH:MM style in game time

Messages/Messages.Get_Last_Message_Index [ Subprograms ]

[ Top ] [ Messages ] [ Subprograms ]

FUNCTION

 Get last message index

SOURCE

   function Get_Last_Message_Index return Natural;

RESULT

 List index of the last message

Messages/Messages.Get_Message [ Subprograms ]

[ Top ] [ Messages ] [ Subprograms ]

FUNCTION

 Get Nth message of selected type

SOURCE

   function Get_Message
     (Message_Index: Integer; M_Type: Message_Type := DEFAULT)
      return Message_Data;

PARAMETERS

 Message_Index - If positive, get Nth message from start of list if
                 negative, get Nth message from the end of the messages
                 list
 M_Type        - Type of messages to check. Default all messages

RESULT

 Selected message or empty message if nothing found

Messages/Messages.Messages_Amount [ Subprograms ]

[ Top ] [ Messages ] [ Subprograms ]

FUNCTION

 Get amount of selected type messages

SOURCE

   function Messages_Amount(M_Type: Message_Type := DEFAULT) return Natural;

PARAMETERS

 M_Type - Type of messages to search. Default is all messages

RESULT

 Amount of messages of selected type