TABLE OF CONTENTS

SUCargo/SUCargo.Cargo_Sort_Orders [ Types ]

[ Top ] [ SUCargo ] [ Types ]

FUNCTION

 Sorting orders for the player ship cargo

SOURCE

   type Cargo_Sort_Orders is
     (NAMEASC, NAMEDESC, DURABILITYASC, DURABILITYDESC, TYPEASC, TYPEDESC,
      AMOUNTASC, AMOUNTDESC, WEIGHTASC, WEIGHTDESC, NONE) with
      Default_Value => NONE;

OPTIONS

 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
 NONE           - No sorting items (default)

HISTORY

 6.4 - Added

SUCargo/SUCargo.Default_Cargo_Sort_Order [ Constants ]

[ Top ] [ SUCargo ] [ Constants ]

FUNCTION

 Default sorting order for items in the player's ship cargo

SOURCE

   Default_Cargo_Sort_Order: constant Cargo_Sort_Orders := NONE;

HISTORY

 6.4 - Added

SUCargo/SUCargo.Cargo_Indexes [ Variables ]

[ Top ] [ SUCargo ] [ Variables ]

FUNCTION

 Indexes of the player ship cargo

SOURCE

   Cargo_Indexes: Positive_Container.Vector;

SUCargo/SUCargo.Cargo_Sort_Order [ Variables ]

[ Top ] [ SUCargo ] [ Variables ]

FUNCTION

 The current sorting order of items in the player's ship cargo

SOURCE

   Cargo_Sort_Order: Cargo_Sort_Orders := Default_Cargo_Sort_Order;

SUCargo/SUCargo.Cargo_Table [ Variables ]

[ Top ] [ SUCargo ] [ Variables ]

FUNCTION

 Table with info about the player ship cargo

SOURCE

   Cargo_Table: Table_Widget (Amount => 5);

SUCargo/SUCargo.Drop_Item_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Drop selected amount of the selected item from the ship's cargo

SOURCE

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

 DropItem

SUCargo/SUCargo.Give_Item_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Give selected amount of the selected item from the ship's cargo to the
 selected crew member

SOURCE

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

 GiveItem

SUCargo/SUCargo.Show_Cargo_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Show the cargo of the player ship

SOURCE

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

 ShowCargo ?page?
 Optional paramater page is the number of the page of cargo list to show

SUCargo/SUCargo.Show_Cargo_Item_Info_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Show detailed information about the selected item in the player ship
 cargo

SOURCE

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

 ShowCargoItemInfo itemindex
 Itemindex is the index of the item which information will be show

SUCargo/SUCargo.Show_Drop_Item_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Show UI to drop the selected item from the ship cargo

SOURCE

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

 ShowDropItem itemindex
 Itemindex is the index of the item which will be set

SUCargo/SUCargo.Show_Give_Item_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Show UI to give the selected item from the ship cargo to the selected
 crew member

SOURCE

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

 ShowGiveItem itemindex
 Itemindex is the index of the item which will be set

SUCargo/SUCargo.Sort_Cargo_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Sort the player's ship's cargo list

SOURCE

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

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

SUCargo/SUCargo.Update_Max_Give_Amount_Command [ Commands ]

[ Top ] [ SUCargo ] [ Commands ]

FUNCTION

 Update max give amount after selecting the crew member

SOURCE

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

 UpdateMaxGiveAmount itemindex
 ItemIndex is the index of the item to give