MWSE Perk Framework

MWSE Perk Framework is the evolution of the Perk System I designed for my character progression mod. The Perk Framework allows mod authors to create and register "Perks", similar to the mechanic seen in the Fallout franchise. These perks can either be included into a global list, to be used with large scale perk overhaul (like in KCP) or can be manually rewarded through other sources.

Registering Perks

Perks can be registered with the createPerk{} function. createPerk accepts a table parameter and accepts the following possible values:

[]id (string)- (required), this should be a unique string, similar to an Editor ID. Since perk data is indexed by ID, this MUST be completely unique

[]name (string)- (required) the Player-Facing name of the perk

[]description(string) -(required) A short player-facing description of the perk's effects.

[]isUnique(boolean) - if set to true, this perk will not be included in the Default Perk list (see Opening the Perk Menu) Use this if you only want the perk to be awarded from a specific source, and not to be able to be acquired from KCP or any other hypothetical mods that use this framework

[]lvlReq (number)- the Required Character level that must be reached for the player to be able to select the perk. Defaults to 0 if not specified

[]attributeReq (table)- this must be a table of attribute requirements, indexed by attribute name. this does not support OR behavior, only AND behavior ex.) {strength = 50, endurance = 60}

[]skillReq (table) - similar to attributeReq, but for required skills. ex.) {illusion = 50, shortBlade = 70, handToHand = 35}

[]werewolfReq (boolean) - if set to true, only werewolf players can take the perk

[]vampireReq (boolean) - if set to true, only vampire players can take the perk

[]perkReq (table) - an array-style table of perkIDs, representing the perks must be previously acquired to take this one. ex.) {"some PerkID", "some other perkID"}

[]customReq (function) - If a function is passed here, it will be ran whenever the framework checks the requirements for a perk. If it does not return true, the perk will not be available for the player to acquire. ex.) customReq = function() if tes3.player.object.name == "fargoth" then return true else return false end end

--fargoth only perk lol

[]customReqText (string) - Unique text to display in the requirements section, intended to be used with customReq, but can be used on it's own

[]perkExclude (table) - this can be a table of perk IDs that player must NOT have in order to acquire the perk. This can be used to make perks that are mutually exclusive with each other

[]hideInMenu (boolean) - if set to tru