TABLE OF CONTENTS

SUCI/SUCI.Inventory_Sort_Orders [ Types ]

[ Top ] [ SUCI ] [ Types ]

FUNCTION

 Sorting orders for items inside various inventories

SOURCE

   type Inventory_Sort_Orders is
     (SELECTEDASC, SELECTEDDESC, NAMEASC, NAMEDESC, DURABILITYASC,
      DURABILITYDESC, TYPEASC, TYPEDESC, AMOUNTASC, AMOUNTDESC, WEIGHTASC,
      WEIGHTDESC, USEDASC, USEDDESC, NONE) with
      Default_Value => NONE;

OPTIONS

 SELECTEDASC    - Sort items by selected ascending
 SELETEDDESC    - Sort items by selected descending
 NAMEASC        - Sort items by name ascending
 NAMEDESC       - Sort items by name descending
 DURABILITYASC  - Sort items by durability ascending
 DURABILITYDESC - Sort items by durability descending
 TYPEASC        - Sort items by type ascending
 TYPEDESC       - Sort items by type descending
 AMOUNTASC      - Sort items by amount ascending
 AMOUNTDESC     - Sort items by amount descending
 WEIGHTASC      - Sort items by total weight ascending
 WEIGHTDESC     - Sort items by total weight descending
 USEDASC        - Sort items by use status (mobs inventory only) ascending
 USEDDESC       - Sort items by use status (mobs inventory only) descending
 NONE           - No sorting items (default)

HISTORY

 6.4 - Added
 7.8 - Added SELECTEDASC and SELECTEDDESC values

SUCI/SUCI.Default_Inventory_Sort_Order [ Constants ]

[ Top ] [ SUCI ] [ Constants ]

FUNCTION

 Default sorting order for items in various inventories

SOURCE

   Default_Inventory_Sort_Order: constant Inventory_Sort_Orders := NONE;

HISTORY

 6.4 - Added

SUCI/SUCI.Inventory_Indexes [ Variables ]

[ Top ] [ SUCI ] [ Variables ]

FUNCTION

 Indexes of the crew member items in inventory

SOURCE

   Inventory_Indexes: Positive_Container.Vector;

SUCI/SUCI.Inventory_Sort_Order [ Variables ]

[ Top ] [ SUCI ] [ Variables ]

FUNCTION

 The current sorting order of items in various inventories

SOURCE

   Inventory_Sort_Order: Inventory_Sort_Orders := Default_Inventory_Sort_Order;

SUCI/SUCI.Inventory_Table [ Variables ]

[ Top ] [ SUCI ] [ Variables ]

FUNCTION

 Table with info about the crew member inventory

SOURCE

   Inventory_Table: Table_Widget (Amount => 6);

SUCI/SUCI.Member_Index [ Variables ]

[ Top ] [ SUCI ] [ Variables ]

FUNCTION

 The index of the selected crew member

SOURCE

   Member_Index: Positive;

SUCI/SUCI.Move_Item [ Subprograms ]

[ Top ] [ SUCI ] [ Subprograms ]

FUNCTION

 Move the selected item to the player's ship's cargo

SOURCE

   procedure Move_Item(Item_Index, Amount: Positive) is

PARAMETERS

 Item_Index - The inventory index of the item to move
 Amount     - The amount of the item to move

HISTORY

 7.8 - Added

SUCI/SUCI.Reset_Selection [ Subprograms ]

[ Top ] [ SUCI ] [ Subprograms ]

FUNCTION

 Reset the currently selected items in the crew member inventory

SOURCE

   procedure Reset_Selection(Interp: Tcl_Interp) is

PARAMETERS

 Interp - The Tcl interpreter in which the selection will be reseted

HISTORY

 7.8 - Added

SUCI/SUCI.Move_Item_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Move the selected item to the ship cargo

SOURCE

   function Move_Item_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. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 MoveItem itemindex
 itemindex is the index of the item which will be set

SUCI/SUCI.Move_Items_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Move the selected items to the ships's cargo

SOURCE

   function Move_Items_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. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 MoveItems

SUCI/SUCI.Set_Use_Item_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Set if item is used by a crew member or not

SOURCE

   function Set_Use_Item_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. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 SetUseItem itemindex
 itemindex is the index of the item which will be set

SUCI/SUCI.Show_Inventory_Item_Info_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Show detailed information about the selected item in crew member
 inventory

SOURCE

   function Show_Inventory_Item_Info_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.
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 ShowInventoryItemInfo memberindex itemindex
 itemindex is the index of the item which will be show

SUCI/SUCI.Show_Member_Inventory_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Show inventory of the selected crew member

SOURCE

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

 ShowMemberInventory memberindex
 MemberIndex is the index of the crew member to show inventory

SUCI/SUCI.Show_Move_Item_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Show UI to move the selected item to the ship cargo

SOURCE

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

 ShowMoveItem itemindex
 itemindex is the index of the item which will be set

SUCI/SUCI.Sort_Crew_Inventory_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Sort the selected crew member inventory

SOURCE

   function Sort_Crew_Inventory_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. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

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

SUCI/SUCI.Toggle_All_Inventory_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Select or deselect all items in the crew member inventory

SOURCE

   function Toggle_All_Inventory_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. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 ToggleAllInventory action
 Action is the action which will be performed. Possible values are
 select or deselect

SUCI/SUCI.Toggle_Inventory_Item [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Select or deselect the selected item in the inventory

SOURCE

   function Toggle_Inventory_Item_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.
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 ToggleInventoryItem rowindex, itemindex
 Rowindex is the index of the row in which is the selected item,
 itemindex is the index of the selected item in crew member inventory.

SUCI/SUCI.Toggle_Inventory_Items_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Equip or unequip the selected items

SOURCE

   function Toggle_Inventory_Items_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. Unused
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 ToggleInventoryItems action
 Action is the action to do with the selected items. Possible values are
 equip and unequip

SUCI/SUCI.Update_Inventory_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Update inventory list of the selected crew member

SOURCE

   function Update_Inventory_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.
 Argv        - Values of arguments passed to the command.

RESULT

 This function always return TCL_OK

COMMANDS

 UpdateInventory memberindex page
 MemberIndex is the index of the crew member to show inventory, page
 is a number of the page of inventory list to show

SUCI/SUCI.Validate_Move_Amount_Command [ Commands ]

[ Top ] [ SUCI ] [ Commands ]

FUNCTION

 Validate amount of the item to move

SOURCE

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

 ValidateMoveAmount maxvalue amount button spinbox