Oolite Bulletins

Code: Select all

Methods

worldScripts["OxpConfig Server"]._register(pointer_to_my_object)
// add oxp to list of oxps oxpconfig does handle
worldScripts["OxpConfig Server"]._unregister(pointer_to_my_object)
// remove from list
worldScripts["OxpConfig Server"]._changed(pointer_to_my_object)
// notify OxpConfig_Server that oxp has changed values

/* my_object is a wrapper object to hold all data that is needed for OxpConfig_Server.
      properties
        name              type          optional  meaning
        General           object
          Script_name     string                  oxp worldscript name, normally equal to this.name of calling script
          Display_name    string                  the name you want OxpConfig to display to the user
          Display_on      string                  used to determine where OxpConfig will show the values. 
                                                  "Game options" = show on F2 - F7 screen
                                                  "Ship/Station Interface" = show on F4 screen through interface OxpConfig
          Notify_type     string                  tells OxpConfig when to send notifications
                                                  "Dynamic" = at every change
                                                  "Dynamic_group" = when user leaves group page
                                                  "Changes_completed" = when user leaves oxp configuration pages
          Notify_handler  pointer                 points to a function that will be called by OxpConfig_Server when user has changed values
          Bool_info       string        y         description shown when user goes to "change booleans" page, defaults to empty
          Number_info     string        y         shown when user goes to "change numbers" page, defaults to empty
          Bitmask_info    string        y         shown when user goes to "change bitmasks" page, defaults to empty
        Booleans          array         y         
          Parent          pointer   
          Child           string                  Parent & Child are combined to access variable
          Hide            boolean                 false = variable will be shown to user
          Default         boolean                 used for "set to default" option
          Description     string                  user-visible description
        Numbers           array         y         
          Parent          pointer
          Child           string                  Parent & Child are combined to access variable
          Hide            boolean                 false = variable will be shown to user
          Default         integer                 used for "set to default" option
          Max             integer                 highest value allowed for number
          Description     string                  user-visible description
        Bitmasks          array         y         
          Parent          pointer
          Child           string                  Parent & Child are combined to access variable
          Hide            boolean                 false = variable will be shown to user
          Default         integer                 used for "set to default" option
          Max             integer                 highest value allowed for bitmask, should be a (power of 2) -1
          Description     string array            user-visible descriptions
          
examples

this._sc_oxpconfig =
  {
    General:
      {
        Script_name: "Shield Cycler",
        Display_name: "Shield Cycler",
        Display_on: "Ship/Station Interface"
        Notify_type: "Dynamic",
        Notify_handler: this._sc_user_changed_values,
        Bool_info: "enable / disable Shield Cycler oxp functionality & the devices it manages",
        Number_info: "Threshold % determines when adjusting is done. 100 = always, 0 = never. Start configuration is the configuration that will be set upon launch (3 = equal, 2 = fwd, 1= aft, 0 = disabled).",
        Bitmask_info: "enable / disable the availability of the settings for manual cycling. Note : if you disable all, Shield Cycler oxp will enable the disabled setting"
      },
    Booleans:
      [
        { Parent:this._sc_settings.general, Child:"disabled", Default:false, Hide:false, Description:"disable SC OXP." },
        { Parent:this._sc_settings.general, Child:"sc_disabled", Default:false, Hide:false, Description:"disable cycler devices." }
      ],
    Numbers:
      [
        { Parent:this._sc_settings.sc, Child:"threshold", Default:100, Max:100, Hide:true, Description:"threshold %" },
        { Parent:this._sc_settings.sc, Child:"start_configuration", Default:3, Max:3, Hide:true, Description:"launch setting" }
      },
    Bitmasks:
      [
        { Parent: this._sc_settings.sc, Child:"cycler_mask", Default:0x001, Max:0x00f, Hide:true, Description:["Disabled","Aft","Forward","Equal"] }
      ]
  };


worldScripts["OxpConfig Server"]._register(this._sc_oxpconfig)
worldScripts["OxpConfig Server"]._unregister(this._sc_oxpconfig)
worldScripts["OxpConfig Server"]._changed(this._sc_oxpconfig)

this._sc_user_changed_values = function(bitmask)
{
// process user changes to variables
};