About This File
HaJo Strip, Take, Drop - Furniture Hotkeys
A (very) small mod I created for myself to add some hotkey functions I was missing, as well as an (experimental) feature to "take and drop" furniture based on configuration sets. While its functionality was tested for some time in my savegames, there might be negative effects long term (save bloat, breaking things), so using this feature should be done with caution. Additionally, once a furniture object was "taken", theres no method to automatically restore it on its original position once the game was saved.
Description:
The initial reason behind this mod is very simple.
While playing with mods like YPS - Immersive Fashion I kept running into the issue that I initiated dialogue with its NPCs for certain actions but forgot to remove the potentially blocking armor parts before (e.g. gloves when trying to get a manicure). This would usually mean that I had to go through the dialogue again, or even might have to re-select my choices again.
I tried looking for a mod that already offered something like this, but (understandably) most armor hotkey mods were about pre-defined armor sets, which is of course incredibly useful, but not that helpful in my case, unless I always keep all the set presets up-to-date. I'd also think that a mod offering this does exist, but then I simply didn't find it I guess.
After that this mod turned into some kind of "testing ground" for me, which lead to adding some more hotkey-based features, too.
I might or might not expand these even more, this will likely depend on my own needs or if a given suggestion (if there are any) convinces me to add it.
With that being said, current features are:
- Optional modificator based on Dynamic Activation Key
-
5 optional "strip" hotkeys:
-
1. Configurable slots - All selected slots will be stripped
- The slotnames are based on my setup, you can rename them in \interface\translations\HaJo_STD_FH_english.txt if needed.
- 2. Head only
- 3. Body only
- 4. Gloves only
- 5. Boots/Feet only
-
1. Configurable slots - All selected slots will be stripped
-
While armor is stripped using one of these hotkeys its not possible to use another hotkey to prevent undesired situations. Re-Equipping armor using the same hotkey releases this "state".
- This "state" can also be released on the MCM if it bugs out.
-
1 Hotkey to "take and drop furniture" - Main reason for this was being able to use buckets found as furniture for PeeAndFart.
-
REQUIRES Extended Vanilla Menus
- If this is not found the whole section will be disabled.
- Based on configuration sets found in Data\SKSE\plugins\HaJo\TakeDropConfig.json
-
Sets can be added and removed ingame.
-
Using the Add option will prompt the user to add the required information. Theres no real validation if the given EditorIDs exist.
- Name - The name that will be displayed in the ListMenu.
- Furniture Editor ID - The EditorID of a furniture item. Use More Informative Console and similar to find these values.
- Misc Editor ID - The EditorID of a misc item
- Amount - The amount of misc items "taking" this furniture will give / required to place it.
- Distance - The distance from the player when placing the furniture. (See below for exceptions)
- Using the Remove option will show a list of all the found sets. Selecting one will remove it permanently from the config.
-
Using the Add option will prompt the user to add the required information. Theres no real validation if the given EditorIDs exist.
-
Hotkey behaviour will depend on crosshair target:
- Furniture is in crosshair - Furniture will be removed and a misc item declared in the config set will be added to the player inventory.
-
Nothing is in crosshair - A menu will be displayed based on the available (in player inventory) misc items that are declared in config sets. Selecting one of these will remove the item from the players inventory and will place the furniture in front of the player.
- No Object Manipulation Overhaul: Furniture will be placed facing the player in the pre-defined distance.
-
With Object Manipulation Overhaul: Furniture can be placed using this mod.
-
Spoiler
Basic_PLACE.json has to be changed so it allows placement of furniture. I think using this configuration should work.
[ { "Action": "Add", "Priority": 0, "ApplyTo": { "Type": "All" }, "OnTarget": { "Type":"All" } } ]
-
-
REQUIRES Extended Vanilla Menus
-
1 Hotkey to cast the Bathing spell of Dirt and Blood
- Requires Dirt and Blood to be installed.
- Probably the least tested feature, please tell me if it doesn't work.
- Some misc "debugging" options I was too lazy to remove yet, those are not necessarily related to this mods functions / hotkeys.
As written above, this was supposed to be a private mod trying to solve an "inconvenience" for myself.
If you notice any bugs, feel free to report them and I'll try my best to fix them. I'm open to suggestions, but please be aware that I don't intend to push regular updates here. I simply thought someone could use the current status quo.
Apart from that, anyone is free to take this mess and expand / improve / fix (you name it) it.
Some kind of showcase...
About the "take and drop" feature:
This feature uses a config file to define which furniture can be placed, which misc item will be given / removed, etc.
The safest way should be adding them using the MCM options, nevertheless heres a short example with explanations of an entry.
"0" :
Slot ID of this set. This HAS TO be unique and correspond to the position in the file. e.g. the 2nd entry has to use ID "1".
{
"Amount" : 1,
Amount of Misc Items this set gives / requires (int)
"Distance" : 120,
Distance to the player when placing this furniture (float)
"FurnitureEditorID" : "PAF_IndoorToiletFurniture",
Editor Id of the furniture object. No Validation, make sure there is no typo!
"MiscEditorID" : "Bucket01",
Editor Id of the misc item required / which will be added to inventory. No Validation, make sure there is no typo!
"Name" : "BucketToToilet"
Custom name of this set. Will be displayed in the selection list. Can be whatever, you might want to give it a meaningful name
}
Use this feature (if at all) with caution. While its functionality was tested, I have no idea about long term effects, especially when used alot.
There is a limit of 128 entries that will be read from the config. While this could be expanded I decided against it, as more entries will likely slow down the functionality. More entires in the config mean more entries have to be checked whenever the script is looking for a certain key, especially if its at the end of the list.
Personally I never used more than 5 sets yet and also can't think of that many use cases to begin with.
Requirements:
- The correct SKSE version for your game
- Powerofthree Papyrus Extender
- MCM Helper - Therefore no LE support
- (1.5.97 - 1.6.659 only) BEESL - Backported Extended ESL Support
- PapyrusUtil
- Dynamic Activation Key - Even if you don't want to use it as a hotkey modificator (This might change in the future)
- (optional) Extended Vanilla Menus - Required if you want to use the take and drop furniture part of this mod!
- (optional) Object Manipulation Overhaul - Only used if you use the take and drop furniture part of this mod.
- (optional) Dirt and Blood - Dynamic Visual Effects - Only if you want to use a hotkey to cast the Bathing spell of it.
and any of its pre-requisites. I linked their direct requirements below them for ease of use. You still have to check if these have requirements of their own!
Installation:
Nothing out of the ordinay, install as any other mod with a mod manager.
If you use Object Manipulation Overhaul you might have to adjust the PICK and PLACE config files of it to allow placement of furniture type objects.
Updating:
General recommendation to keep a backup of the previous version, apart from that there shouldn't be anything to be aware of.
Known Issues:
- The Strip Hotkeys do not care about DD Devices. I might add a check for this in the future, in the meantime try to restrain yourself while wearing restraints.
- I'm not sure about the cause, but I assume mod order changes as a reason or events forcing to unequip all items, the re-equipped armor might be off.
Future Plans:
- Masturbation hotkey - Still looking for the best method of implementation for best compatibility.
- SunHelm Fill Bottles hotkey using DynKey (personal preference)
- Add Slot 61 for custom armor toggle
- Multiple misc items per config entry
- Block base hotkey (e.g. 1-6 in the video above) when using modificator + hotkey
- Replace Furniture / Misc item hotkey without inventory interaction
- Suggestions...
Changelog:
Initial Release - v1.0
What's New in Version 1.1.1
Released
1.1.1
- Fixed condition for showing / hiding Bathing hotkey setting in MCM
1.1
-
Added correct version of the script
- Add Set function menus would not allow cancelling
- Used wrong defaults for amount and distance.
- Added screenshots of the other 2 MCM pages to the modpage