-----XAZ instructions and notes-----

There are a few global settings that you can use to influence how the mod works.

Changing a setting is done through the console: "set zbfSettingUpdateInterval to 1.0" will set the setting called zbfSettingUpdateInterval to the value 1.0. 

Settings:

zbfSettingUpdateInterval set to zero (less than 0.1 to be exact) to prevent perodic refresh of the effect. Default 1.0, refresh every second. Only used for the player character.
zbfSettingNPCUpdateInterval same as zpfSettingUpdateInterval but used for NPCs.
zbfSettingSpeedMult set to slow player down when hobbled.
zbfSettingDisableEffects set to 1 to disable all effects from items in this mod. Will not reset already applied effects, but those effects will not refresh.

All items when worn have effects on the player or Npc. Putting on cuffs will bind the hands and feet and slow the actor down. A lot of other effects can be applied on the actor, such as disabling magic, preventing sprinting, fighting and so on.

To enable this all items have keywords attached to them which enable one or many behaviors. For regular use, you don't need to know this, but it may help you determine why you don't get what you want. For modders creating new items or using existing ones this may be useful. Some keywords will only affect the player at the moment.

Keywords and description:

zbfWeaponPunishment - Keyword for the crops, whips etc.
zbfWornAnkles, zbfWornCollar, zbfWornGag, zbfWornWrist - Cosmetic keywords, to be used by modders wanting to detect that an npc or player is gagged, shackled, etc.
zbfEffectNoActivate - Prevents starting dialogue, activating and picking up items. Only affects the player.
zbfEffectNoFighting - Prevents drawing weapons. Only affects the player.
zbfEffectNoInventory - Prevents access to the inventory. Only affects the player.
zbfEffectNoMagic - Prevents shout and magic by unequipping on each update.
zbfEffectNoMove - Prevents moving, sets movement speed to zero.
zbfEffectNoSneak - Prevents sneaking. Only affects the player.
zbfEffectOpenMouth - Forces the mouth open (for gags), overrides SetExpression.
zbfEffectSetExpression - Sets the expression to fear.
zbfEffectSlowMove - Slows movement speed to zbfSettingSpeedMult.
zbfEffectWrist - Plays the hands bound animation.

For modders:

Everything works by applying an effect on each actor when an item is worn. This effect refreshes every zbfSettingUpdateInterval seconds (or zbfSettingNpcUpdateInterval if an npc). The script will check for keywords on worn items, and if found do some action on the actor, and if not found do something else. For instance, if zbfEffectOpenMouth is worn the script will run SetExpressionOverride on the actor and if not, it will run ClearExpressionOverride on that actor.

Further animations are intercepted to prevent certain obvious breaks of bindings. If zbfEffectWrist are worn, then you can't fall and lose your bindings.

Equip slots are as follows:
44 - Mask (blindfold)
45 - Collar
48 - Cuffs
51 - Ankles
52 - Belt
55 - Gag


-----Useful Console Commands-----

Lists of useful console commands. Type into them into the console ...

Testing Animations on the Player Only . eg animation ( zazapc001 - HandBehindStand)
player.playidle zazapc001

Testing Animations on the Player Only with animated objects. eg animation ( zazapcao001 - Gibbet Kneel)
player.playidle zazapcao001

Completely disable equip effects
set zbfSettingDisableEffects to 1

Disable just the slow down effect
set zbfSettingSpeedMult to 100

Reset animation/pose on an actor (must be targetted in the console)
playidle zbfIdleForceReset

Enable timed refresh of bondage effects on both the player and npcs (1.0s)
set zbfSettingUpdateInterval to 1.0
set zbfSettingNpcUpdateInterval to 1.0

Find an item id
help "zbf" - Lists all items named zbf-something (covers all items).
help "zbf gag" - Lists all items named zbf gag-something (covers all gags).. etc

Spawn a chest with all items from this mod
player.placeatme XX010001
(XX is the load order for the .esm file)


-----Changes-----

V004:
* Optional configuration menu (enable ZazAnimationPackConfig.esp) which requires SkyUI.
* Whips leave marks.
* Added all animation objects as statics.
* Default effect refresh timers set to 0 (disabled). This should make sure the mod clashes less with animations while still being mostly useful for the player character and npc. Timers can still be enabled through the console.
* Effects now take care not to reset properties and animations unless instructed to. This should make enabling timers less of an issue.
* Removed "loose" wrist ropes. No restraints prevent inventory access. Functionality remains for modders.
* Removed character creation overrides (femaleheadbrowschargen.tri and femaleheadbrowsrace.tri) because these files were giving some people issues.
* Added a chest with all items from this mod. Spawn by "player.placeatme XX010001" where XX is the load order of this mod.
* Renamed rope to leather binds and introduced rope bonds.
* 5 new hogtie animations with rope from hands to feet. (ZazApcAo051-ZazApcAo055)
* 5 new hanging shackle animations. (ZazApcAo301-ZazApcAo305)
* Bug: zbf Collar Ai didn't work properly
* Bug: zbf effects are now overlapping (not stacking).
