TABLE OF CONTENTS

RecruitUI/RecruitUI.Recruits_Sort_Orders [ Types ]

[ Top ] [ RecruitUI ] [ Types ]

FUNCTION

 Sorting orders for the list of available recruits in base

SOURCE

   type Recruits_Sort_Orders is
     (NAMEASC, NAMEDESC, GENDERASC, GENDERDESC, FACTIONDESC, FACTIONASC,
      PRICEASC, PRICEDESC, ATTRIBUTEASC, ATTRIBUTEDESC, SKILLASC, SKILLDESC,
      NONE) with
      Default_Value => NONE;

OPTIONS

 NAMEASC       - Sort recruits by name ascending
 NAMEDESC      - Sort recruits by name descending
 GENDERASC     - Sort recruits by gender ascending
 GENDERDESC    - Sort recruits by gender descending
 FACTIONASC    - Sort recruits by faction ascending
 FACTIONDESC   - Sort recruits by faction descending
 PRICEASC      - Sort recruits by price ascending
 PRICEDESC     - Sort recruits by price descending
 ATTRIBUTEASC  - Sort recruits by attribute ascending
 ATTRIBUTEDESC - Sort recruits by attribute descending
 SKILLASC      - Sort recruits by skill ascending
 SKILLDESC     - Sort recruits by skill descending
 NONE       - No sorting recruits (default)

HISTORY

 6.4 - Added

RecruitUI/RecruitUI.Default_Recruits_Sort_Order [ Constants ]

[ Top ] [ RecruitUI ] [ Constants ]

FUNCTION

 Default sorting order for the available recruits in base

SOURCE

   Default_Recruits_Sort_Order: constant Recruits_Sort_Orders := NONE;

HISTORY

 6.4 - Added

RecruitUI/RecruitUI.Modules_Indexes [ Variables ]

[ Top ] [ RecruitUI ] [ Variables ]

FUNCTION

 Indexes of the available recruits in base

SOURCE

   Recruits_Indexes: Positive_Container.Vector;

RecruitUI/RecruitUI.Recruit_Index [ Variables ]

[ Top ] [ RecruitUI ] [ Variables ]

FUNCTION

 The index of currently selected recruit

SOURCE

   Recruit_Index: Positive;

RecruitUI/RecruitUI.Recruit_Table [ Variables ]

[ Top ] [ RecruitUI ] [ Variables ]

FUNCTION

 Table with info about the available recruits

SOURCE

   Recruit_Table: Table_Widget (Amount => 6);

RecruitUI/RecruitUI.Recruits_Sort_Order [ Variables ]

[ Top ] [ RecruitUI ] [ Variables ]

FUNCTION

 The current sorting order for the available recruits in base

SOURCE

   Recruits_Sort_Order: Recruits_Sort_Orders := Default_Recruits_Sort_Order;

HISTORY

 6.4 - Added

RecruitUI/RecruitUI.Get_Highest_Attribute [ Subprograms ]

[ Top ] [ RecruitUI ] [ Subprograms ]

FUNCTION

 Get the highest attribute's name of the selected recruit

SOURCE

   function Get_Highest_Attribute
     (Base_Index, Member_Index: Positive) return Unbounded_String is

PARAMETERS

 Base_Index   - The index of the base in which the recruit's attributes
                will be check
 Member_Index - The index of the recruit which attributes will be check

RESULT

 The name of the attribute with the highest level of the selected recruit

HISTORY

 6.5 - Added
 7.6 - Renamed parameters to Base_Index and Member_Index

RecruitUI/RecruitUI.Get_Highest_Skill [ Subprograms ]

[ Top ] [ RecruitUI ] [ Subprograms ]

FUNCTION

 Get the highest skill's name of the selected recruit

SOURCE

   function Get_Highest_Skill
     (Base_Index, Member_Index: Positive) return Unbounded_String is

PARAMETERS

 Base_Index   - The index of the base in which the recruit's skills will
                be check
 Member_Index - The index of the recruit which skills will be check

RESULT

 The name of the skill with the highest level of the selected recruit

HISTORY

 6.5 - Added
 7.6 - Renamed parameters to Base_Index and Member_Index

RecruitUI/RecruitUI.Get_Recruit_Index [ Subprograms ]

[ Top ] [ RecruitUI ] [ Subprograms ]

FUNCTION

 Get the index of the currently selected recruit

SOURCE

   function Get_Recruit_Index return Positive is

RESULT

 The index of the currently selected recruit

RecruitUI/RecruitUI.Hire_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Hire the selected recruit

SOURCE

   function Hire_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. Unused

RESULT

 This function always return TCL_OK

COMMANDS

 Hire

RecruitUI/RecruitUI.Negotiate_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Show negotation UI to the player

SOURCE

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

 Negotiate

RecruitUI/RecruitUI.Negotiate_Hire_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Update information about hiring of the selected recruit

SOURCE

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

 NegotiateHire

RecruitUI/RecruitUI.Show_Recruit_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Show the selected base available recruits

SOURCE

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

 ShowRecruit

RecruitUI/RecruitUI.Show_Recruit_Info_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Show information about the selected recruit

SOURCE

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

RESULT

 This function always return TCL_OK

COMMANDS

 ShowRecruitInfo recruitindex
 RecruitIndex is a index of the recruit which menu will be shown

RecruitUI/RecruitUI.Show_Recruit_Tab_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Show the selected information about the selected recruit

SOURCE

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

 ShowMemberTab

RecruitUI/RecruitUI.Sort_Recruits_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Sort the list of available recruits in base

SOURCE

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

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

RecruitUI/RecruitUI.Validate_Negotiate_Command [ Commands ]

[ Top ] [ RecruitUI ] [ Commands ]

FUNCTION

 Validate value of numeric fields in negotiate dialog

SOURCE

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

 ValidateNegotiate field value
 Field is Tcl path to the field which will be validated, value is
 the new value of the field to validate