Properties that only Helms have - Catman-232/Homebrewery GitHub Wiki

^{This page was up to date as of version 4.6.40}
An item's param.txthb file is a JSON formatted set of properties that HB will try to parse into data. You do not need to have every single property in a file, as any you don't have will be given its default value, which is displayed in each code block below.

The file starts with a left brace: {, property names go in speech marks with a colon afterwards: "property": , values go after the colon and will have a comma after them: 10, or "stringvalue", unless it is the last one in the file: 10 or "stringvalue", and finally the file ends with a right brace }

"_helmRender": "",

String
This property is where you define either a vanilla or custom ArmorRender for the Helm. It must be the name of a ArmorRender, such as the ones here: Meshes-and-ScriptableArmorRenders#Helms

A custom Mesh example would be: Catman-Homebrewery-ArmorRender-BunhostEars
You can use #local# instead of your mod's name as a convenience, e.g. #local#-ArmorRender-BunhostEars

"_helmOverrideMesh": "",

String
This property is where you define either a vanilla or custom Mesh for the Helm. It overrides the mesh listed in _helmRender but keep its position values for the 5 races, assuming 5 Meshes are present in the ScriptableArmorRender. It must be the name of a Mesh, such as the ones here: Meshes-and-ScriptableArmorRenders#_helmOverrideMesh

A custom Mesh example would be: Catman-Homebrewery-Mesh-CoolMesh
You can use #local# instead of your mod's name as a convenience, e.g. #local#-Mesh-CoolMesh

"_useHelmHairDisplay": false,

Boolean (true or false, no speechmarks)
When true, the helm will cause the character's hair to swap to an alternate vanilla hair mesh specific to each race that's designed to not clip with helmets. Those meshes are simply modified versions of existing ones so they will look familiar or repetitive. Funnily enough that mesh doesn't appear if you're bald.

"_blendHelmValue": 0,

Float (decimal places allowed)
A value from 0 to 100 that's exclusive to Kubolds and Byrdles. It overrides the shapekey value of the Byrdle's back of head feather spiky bits, which they have a slider for. 100 is completely flattened. It also kind of does the same thing for Kubolds, the spikes on the back of their head become more blunt the closer the setting is to 100. The meshes and armorrenders list shows the values the game's own items are using with the meshes. Below is a general list of values:

"_isFullHelm": false,

Boolean (true or false, no speechmarks)
When true, the character's entire head, hair and face will be hidden while wearing the helm. You'll require the next two properties for full effect.

"_hideEars": false,

Boolean (true or false, no speechmarks)
When true, the helm will hide the character's ears. This doesn't affect Byrdles.

"_hideMisc": false,

Boolean (true or false, no speechmarks)
When true, the helm will hide the character's misc parts. Imp & Kubold horns, and Poon Antlers, does not affect Byrdles and Changs.

"_hideHair": false,

Boolean (true or false, no speechmarks)
When true, this custom property will make HB disable the hair renderer for the wearer, effectively hiding their hair. This used to be a vanilla property but was removed for some reason, I don't think my implementation has much in common with Kiseff's though.

"_noFlip": false,

Boolean (true or false, no speechmarks)
When true, this custom property will make HB check if a player wearing the helm has the left handed toggle on (which mirrors the whole character) and then flip the helm to unmirror it.