• Tutorials

  • Home
  • GPDL Party Variables

    DungeonCraft Help Home

    There are several variables associated with each party as a group. Time-of-day and direction facing are examples. All of the variables are available to the GPDL program. Some of the variables can be modified. Each variable has one function to access the value of the variable and, if the variable is modifiable, one function to set the value.

    All the functions are of the same form:

    To access a variable:

       $GET_PARTY_xxxxxx();

    To set the value of a variable:

       $SET_PARTY_xxxxxx(value);

    In both cases, the xxxxxx is the name of the particular variable of interest In the $SET_PARTY_xxxxxx functions, the value parameter will be assigned to the party's variable if it is a legal value. You cannot set the party's direction to 17.835, for example. The GPDL conversion of strings to numbers follows the general rules (See Data Type Conversions)

    Following is a list of all the $GET and $SET functions associated with the party. The type of value is one of the following:

    String - Such as a name.

    Integer - Such as an age

    Float - A 'real' number such as 3.14159

    Each entry in the table also indicates whether the variable can be modified with the corresponding $SET_PARTY_xxxxx function.

     Function name        data type  Settable?
      $GET_PARTY_FACING     Integer    Yes
      $GET_PARTY_DAYS       Integer    Yes
      $GET_PARTY_HOURS      Integer    Yes
      $GET_PARTY_MINUTES    Integer    Yes
      $GET_PARTY_ACTIVECHAR Integer    Yes