TABLE OF CONTENTS

GameOptions/GameOptions.Accel_Data [ Types ]

[ Top ] [ GameOptions ] [ Types ]

FUNCTION

 Data for showing keyboard shortcuts

SOURCE

   type Accel_Data is record
      Shortcut: Unbounded_String;
      Entry_Name: Unbounded_String;
      Config_Name: Unbounded_String;
   end record;

PARAMETERS

 Shortcut    - Keyboard shortcut
 Entry_Name  - Name of the text entry which will be showing this shortcut
 Config_Name - The name of the entry in keyboard configuration file

GameOptions/GameOptions.Accels [ Variables ]

[ Top ] [ GameOptions ] [ Variables ]

FUNCTION

 Array with data to show keyboard shortcuts

SOURCE

   Accels: array(1 .. 53) of Accel_Data :=
     (1 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 1)),
         Entry_Name => To_Unbounded_String(Source => ".menu.shipinfo"),
         Config_Name => To_Unbounded_String(Source => "ShipInfo")),
      2 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 2)),
         Entry_Name => To_Unbounded_String(Source => ".menu.orders"),
         Config_Name => To_Unbounded_String(Source => "Orders")),
      3 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 3)),
         Entry_Name => To_Unbounded_String(Source => ".menu.crafts"),
         Config_Name => To_Unbounded_String(Source => "Crafting")),
      4 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 4)),
         Entry_Name => To_Unbounded_String(Source => ".menu.messages"),
         Config_Name => To_Unbounded_String(Source => "LastMessages")),
      5 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 5)),
         Entry_Name => To_Unbounded_String(Source => ".menu.knowledge"),
         Config_Name => To_Unbounded_String(Source => "Knowledge")),
      6 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 6)),
         Entry_Name => To_Unbounded_String(Source => ".menu.waitorders"),
         Config_Name => To_Unbounded_String(Source => "WaitOrders")),
      7 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 7)),
         Entry_Name => To_Unbounded_String(Source => ".menu.gamestats"),
         Config_Name => To_Unbounded_String(Source => "GameStats")),
      8 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 8)),
         Entry_Name => To_Unbounded_String(Source => ".menu.help"),
         Config_Name => To_Unbounded_String(Source => "Help")),
      9 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 9)),
         Entry_Name => To_Unbounded_String(Source => ".menu.gameoptions"),
         Config_Name => To_Unbounded_String(Source => "GameOptions")),
      10 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 10)),
         Entry_Name => To_Unbounded_String(Source => ".menu.quit"),
         Config_Name => To_Unbounded_String(Source => "Quit")),
      11 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Menu_Accelerator(Index => 11)),
         Entry_Name => To_Unbounded_String(Source => ".menu.resign"),
         Config_Name => To_Unbounded_String(Source => "Resign")),
      12 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 1)),
         Entry_Name => To_Unbounded_String(Source => ".menu.menu"),
         Config_Name => To_Unbounded_String(Source => "GameMenu")),
      13 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 2)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapoptions"),
         Config_Name => To_Unbounded_String(Source => "MapOptions")),
      14 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 3)),
         Entry_Name => To_Unbounded_String(Source => ".map.zoomin"),
         Config_Name => To_Unbounded_String(Source => "ZoomInMap")),
      15 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 4)),
         Entry_Name => To_Unbounded_String(Source => ".map.zoomout"),
         Config_Name => To_Unbounded_String(Source => "ZoomOutMap")),
      16 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 5)),
         Entry_Name => To_Unbounded_String(Source => ".movement.upleft"),
         Config_Name => To_Unbounded_String(Source => "MoveUpLeft")),
      17 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 6)),
         Entry_Name => To_Unbounded_String(Source => ".movement.up"),
         Config_Name => To_Unbounded_String(Source => "MoveUp")),
      18 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 7)),
         Entry_Name => To_Unbounded_String(Source => ".movement.upright"),
         Config_Name => To_Unbounded_String(Source => "MoveUpRight")),
      19 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 8)),
         Entry_Name => To_Unbounded_String(Source => ".movement.left"),
         Config_Name => To_Unbounded_String(Source => "MoveLeft")),
      20 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 10)),
         Entry_Name => To_Unbounded_String(Source => ".movement.wait"),
         Config_Name => To_Unbounded_String(Source => "WaitInPlace")),
      21 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 9)),
         Entry_Name => To_Unbounded_String(Source => ".movement.right"),
         Config_Name => To_Unbounded_String(Source => "MoveRight")),
      22 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 11)),
         Entry_Name => To_Unbounded_String(Source => ".movement.downleft"),
         Config_Name => To_Unbounded_String(Source => "MoveDownRight")),
      23 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 12)),
         Entry_Name => To_Unbounded_String(Source => ".movement.down"),
         Config_Name => To_Unbounded_String(Source => "MoveDown")),
      24 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 13)),
         Entry_Name => To_Unbounded_String(Source => ".movement.downright"),
         Config_Name => To_Unbounded_String(Source => "MoveDownRight")),
      25 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 14)),
         Entry_Name => To_Unbounded_String(Source => ".movement.moveto"),
         Config_Name => To_Unbounded_String(Source => "MoveTo")),
      26 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 15)),
         Entry_Name => To_Unbounded_String(Source => ".map.center"),
         Config_Name => To_Unbounded_String(Source => "CenterMap")),
      27 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 16)),
         Entry_Name => To_Unbounded_String(Source => ".map.centerhomebase"),
         Config_Name => To_Unbounded_String(Source => "CenterMapOnHomeBase")),
      28 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 17)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapupleft"),
         Config_Name => To_Unbounded_String(Source => "MoveMapUpLeft")),
      29 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 18)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapup"),
         Config_Name => To_Unbounded_String(Source => "MoveMapUp")),
      30 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 19)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapupright"),
         Config_Name => To_Unbounded_String(Source => "MoveMapUpRight")),
      31 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 20)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapleft"),
         Config_Name => To_Unbounded_String(Source => "MoveMapLeft")),
      32 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 21)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapright"),
         Config_Name => To_Unbounded_String(Source => "MoveMapRight")),
      33 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 22)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapdownleft"),
         Config_Name => To_Unbounded_String(Source => "MoveMapDownLeft")),
      34 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 23)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapdown"),
         Config_Name => To_Unbounded_String(Source => "MoveMapDown")),
      35 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 24)),
         Entry_Name => To_Unbounded_String(Source => ".map.mapdownright"),
         Config_Name => To_Unbounded_String(Source => "MoveMapDownRight")),
      36 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 25)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursorupleft"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorUpLeft")),
      37 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 26)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursorup"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorUp")),
      38 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 27)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursorupright"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorUpRight")),
      39 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 28)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursorleft"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorLeft")),
      40 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 29)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursorright"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorRight")),
      41 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 30)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursordownleft"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorDownLeft")),
      42 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 31)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursordown"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorDown")),
      43 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 32)),
         Entry_Name => To_Unbounded_String(Source => ".map.cursordownright"),
         Config_Name => To_Unbounded_String(Source => "MoveCursorDownRight")),
      44 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 33)),
         Entry_Name => To_Unbounded_String(Source => ".map.clickmouse"),
         Config_Name => To_Unbounded_String(Source => "LeftClickMouse")),
      45 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 34)),
         Entry_Name => To_Unbounded_String(Source => ".movement.fullstop"),
         Config_Name => To_Unbounded_String(Source => "FullStop")),
      46 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 35)),
         Entry_Name => To_Unbounded_String(Source => ".movement.quarterspeed"),
         Config_Name => To_Unbounded_String(Source => "QuarterSpeed")),
      47 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 36)),
         Entry_Name => To_Unbounded_String(Source => ".movement.halfspeed"),
         Config_Name => To_Unbounded_String(Source => "HalfSpeed")),
      48 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_Map_Accelerator(Index => 37)),
         Entry_Name => To_Unbounded_String(Source => ".movement.fullspeed"),
         Config_Name => To_Unbounded_String(Source => "FullSpeed")),
      49 =>
        (Shortcut => To_Unbounded_String(Source => Get_Full_Screen_Accel),
         Entry_Name =>
           To_Unbounded_String(Source => ".interface.fullscreenkey"),
         Config_Name => To_Unbounded_String(Source => "FullScreen")),
      50 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_General_Accelerator(Index => 1)),
         Entry_Name => To_Unbounded_String(Source => ".ui.resizefirst"),
         Config_Name => To_Unbounded_String(Source => "ResizeFirst")),
      51 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_General_Accelerator(Index => 2)),
         Entry_Name => To_Unbounded_String(Source => ".ui.resizesecond"),
         Config_Name => To_Unbounded_String(Source => "ResizeSecond")),
      52 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_General_Accelerator(Index => 3)),
         Entry_Name => To_Unbounded_String(Source => ".ui.resizethird"),
         Config_Name => To_Unbounded_String(Source => "ResizeThird")),
      53 =>
        (Shortcut =>
           To_Unbounded_String(Source => Get_General_Accelerator(Index => 4)),
         Entry_Name => To_Unbounded_String(Source => ".ui.resizefourth"),
         Config_Name => To_Unbounded_String(Source => "ResizeFourth")));

GameOptions/GameOptions.Close_Options_Command [ Commands ]

[ Top ] [ GameOptions ] [ Commands ]

FUNCTION

 Save all options and back to the map

SOURCE

   function Close_Options_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.

RESULT

 This function always return TCL_OK

COMMANDS

 CloseOptions oldscreen
 Oldscreen is name of the screen to which the game should return.
 Can be 'map' or 'combat'.

GameOptions/GameOptions.Reset_Keys_Command [ Commands ]

[ Top ] [ GameOptions ] [ Commands ]

FUNCTION

 Reset the selected group of keys to their default values

SOURCE

   function Reset_Keys_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.

RESULT

 This function always return TCL_OK

COMMANDS

 ResetKeys group
 Group is the group of keys which will be resetted. Possible values are
 movement, map, menu

GameOptions/GameOptions.Set_Default_Fonts_Command [ Commands ]

[ Top ] [ GameOptions ] [ Commands ]

FUNCTION

 Set the default values for fonts

SOURCE

   function Set_Default_Fonts_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

 SetDefaultFonts

GameOptions/GameOptions.Set_Fonts_Command [ Commands ]

[ Top ] [ GameOptions ] [ Commands ]

FUNCTION

 Set the selected font

SOURCE

   function Set_Fonts_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.

RESULT

 This function always return TCL_OK

COMMANDS

 SetFonts fontfield
 Fontfield is the name of the spinbox which value changed.

GameOptions/GameOptions.Show_Options_Command [ Commands ]

[ Top ] [ GameOptions ] [ Commands ]

FUNCTION

 Show the game options to the player

SOURCE

   function Show_Options_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.
 Interp      - Tcl interpreter in which command was executed.
 Argc        - Number of arguments passed to the command.
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 ShowOptions

GameOptions/GameOptions.Show_Options_Tab_Command [ Commands ]

[ Top ] [ GameOptions ] [ Commands ]

FUNCTION

 Show the selected options tab

SOURCE

   function Show_Options_Tab_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

 ShowOptionsTab