Steam Sky 9.9 code documentation

Table of Contents Source files Index Constants Exceptions Subprograms Packages Commands Records Types Variables

TABLE OF CONTENTS

• 1. MCommands/MCommands.Sort_Saves_Command
• 2. MCommands/MCommands.Show_Main_Menu_Command
• 3. MCommands/MCommands.Show_Load_Game_Menu_Command
• 4. MCommands/MCommands.Set_Faction_Command
• 5. MCommands/MCommands.Set_Career_Command
• 6. MCommands/MCommands.Set_Base_Command
• 7. MCommands/MCommands.Random_Name_Command
• 8. MCommands/MCommands.New_Game_Command
• 9. MCommands/MCommands.Load_Game_Command
• 10. MCommands/MCommads.Show_Load_Game_Command
• 11. MCommands/MCommands.StartGame
• 12. MCommands/MCommands.Get_Save_Sort_Order
• 13. MCommands/MCommands.Get_Load_Table
• 14. MCommands/MCommands.Save_Sort_Order
• 15. MCommands/MCommands.LoadTable
• 16. MCommands/MCommands.Default_Save_Sort_Order
• 17. MCommands/MCommands.Save_Sort_Orders

---

MCommands/MCommands.Save_Sort_Orders [ Types ]

[ Top ] [ MCommands ] [ Types ]

FUNCTION

 Sorting orders for the saved games list

SOURCE

   type Save_Sort_Orders is
     (PLAYERASC, PLAYERDESC, SHIPASC, SHIPDESC, TIMEASC, TIMEDESC) with
      Default_Value => TIMEDESC;

OPTIONS

 PLAYERASC  - Sort by player name ascending
 PLAYERDESC - Sort by player name descending
 SHIPASC    - Sort by ship name ascending
 SHIPDESC   - Sort by ship name descending
 TIMEASC    - Sort by save time ascending
 TIMEDESC   - Sort by save time descending

---

MCommands/MCommands.Default_Save_Sort_Order [ Constants ]

[ Top ] [ MCommands ] [ Constants ]

FUNCTION

 Default sorting order for the saved game list

SOURCE

   Default_Save_Sort_Order: constant Save_Sort_Orders := TIMEDESC;

HISTORY

 6.6 - Added

---

MCommands/MCommands.LoadTable [ Variables ]

[ Top ] [ MCommands ] [ Variables ]

FUNCTION

 Table with info about the available saved games

SOURCE

   Load_Table: Table_Widget (Amount => 3);

---

MCommands/MCommands.Save_Sort_Order [ Variables ]

[ Top ] [ MCommands ] [ Variables ]

FUNCTION

 The current sorting order for the saved game list

SOURCE

   Save_Sort_Order: Save_Sort_Orders := Default_Save_Sort_Order;

---

MCommands/MCommands.Get_Load_Table [ Subprograms ]

[ Top ] [ MCommands ] [ Subprograms ]

FUNCTION

 Get the table with the list of the saved games

SOURCE

   function Get_Load_Table return Table_Widget is

RESULT

 The Table_Widtget with the list of available saved games

HISTORY

 6.6 - Added

---

MCommands/MCommands.Get_Save_Sort_Order [ Subprograms ]

[ Top ] [ MCommands ] [ Subprograms ]

FUNCTION

 Get the current sorting order for the saved games list

SOURCE

   function Get_Save_Sort_Order return Save_Sort_Orders is
   begin
      return Save_Sort_Order;
   end Get_Save_Sort_Order;

RESULT

 The current sorting order of the saved games list

HISTORY

 6.5 - Added

---

MCommands/MCommands.StartGame [ Subprograms ]

[ Top ] [ MCommands ] [ Subprograms ]

FUNCTION

 Start the game

SOURCE

   procedure Start_Game is

---

MCommands/MCommads.Show_Load_Game_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Show available saved games

SOURCE

   function Show_Load_Game_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 Client_Data - Custom data send to the command. Unused
 Interp      - Tcl interpreter in which command was executed.
 Argc        - Number of arguments passed to the command. Unused
 Argv        - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 ShowLoadGame

---

MCommands/MCommands.Load_Game_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Load the selected save file and start the game

SOURCE

   function Load_Game_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 Client_Data - Custom data send to the command. Unused
 Interp      - Tcl interpreter in which command was executed. Unused
 Argc        - Number of arguments passed to the command. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 LoadGame file
 File is the name of the saved game which will be loaded

---

MCommands/MCommands.New_Game_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Set all parameters and start a new game

SOURCE

   function New_Game_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 NewGame

---

MCommands/MCommands.Random_Name_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Generate random player or ship name

SOURCE

   function Random_Name_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 RandomName type
 Type is type of name which should be generated. Possible options are
 player or ship

---

MCommands/MCommands.Set_Base_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Set starting base description

SOURCE

   function Set_Base_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 SetBase

---

MCommands/MCommands.Set_Career_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Set career description

SOURCE

   function Set_Career_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 SetCareer

---

MCommands/MCommands.Set_Faction_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Set faction destription and available bases and careers

SOURCE

   function Set_Faction_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 Client_Data - Custom data send to the command. Unused
 Interp      - Tcl interpreter in which command was executed.
 Argc        - Number of arguments passed to the command. Unused
 Argv        - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 SetFaction

---

MCommands/MCommands.Show_Load_Game_Menu_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Show available options for the selected saved game

SOURCE

   function Show_Load_Game_Menu_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 ShowLoadGameMenu file
 File is the filename of the saved game to manipulate

---

MCommands/MCommands.Show_Main_Menu_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Clear the main game window and show main menu

SOURCE

   function Show_Main_Menu_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 ShowMainMenu

---

MCommands/MCommands.Sort_Saves_Command [ Commands ]

[ Top ] [ MCommands ] [ Commands ]

FUNCTION

 Sort the saved games list

SOURCE

   function Sort_Saves_Command
     (Client_Data: Integer; Interp: Tcl.Tcl_Interp; Argc: Interfaces.C.int;
      Argv: CArgv.Chars_Ptr_Ptr) return Interfaces.C.int with
      Convention => C;

PARAMETERS

 ClientData - Custom data send to the command. Unused
 Interp     - Tcl interpreter in which command was executed.
 Argc       - Number of arguments passed to the command. Unused
 Argv       - Values of arguments passed to the command. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 SortSaves x
 X is X axis coordinate where the player clicked the mouse button

Generated from ./src/ui/mainmenu-commands.adb with ROBODoc V4.99.44 on 2024-04-14 03:16:06