Jump to content
  • entries
    3
  • comments
    0
  • views
    991

Licenses - Notes for Mod Authors


Nuascura

167 views

First, a guide:

  • BM_Licenses is the central script
  • BM_Player is for Player Quest Alias and any Events that run with said alias
  • BM_Licenses_Utility holds shared/common functions AND functions that external mods may wish to use
  • Scripts prefixed with BM_ME indicate that they are Magic Effects linked to a spell or enchantment
  • Scripts prefixed with BM_D indicate they are dialogue scripts holding start and end fragments
  • Scripts prefixed with BM_Licenses indicate they are quest scripts


If there's a license you'd like to hook into, check the corresponding license variable. For example, checking Whore License validity is just a simple check of [hasWhoreLicense] == true. Some notes on these license variables:

  • If a license feature is disabled, the corresponding license variable is always true.
  • If a license feature is enabled, the corresponding license validity is updated based on two conditions. Pseudocode for Whore License, which doesn't consider state of the license feature itself:
    • IF player has more than one of the corresponding license book item AND expiration time isn't -1
      • player has whore license
    • ELSE
      • player doesn't have whore license

 

To check whether a license feature is enabled/disabled, check the MCM variable. Ex. isWhoreLicenseFeatureEnabled

To check whether a license is in an active cycle, verify that the corresponding BM_Licenses variable != 1. Ex. whoreLicenseExpirationTime != 1

To check whether a license is in cooldown, verify that the corresponding BM_Licenses variable != 1. Ex. whoreLicenseCooldownTime != 1

 

Any future common functions should be available under BM_Licenses_Utility script.

 

"Licenses" is the name of this mod and its MCM menu; this is the name by which this mod should be referred to. "BMLE" is the internally-used unique identifier for Licenses, an acronym of "BananasManiac's Licenses (Enhanced)." Use "Licenses (BMLE)" when a more unique public identifier is required.

Edited by Nuascura

0 Comments


Recommended Comments

There are no comments to display.

Guest
This blog entry is now closed to further comments.
×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue. For more information, see our Privacy Policy & Terms of Use