Please put this on github so we don't need to download a workshop mod to enjoy your work.

The mod is not necessary for anything, it won't make anything work, nothing will show up in game. It's simply example code to help other mod developers learn how to expose options for their mods. That's it, that's all.

Is it compatible with Britas?

So is this necessary for Bandits in build 42 or nah?

So this is getting pretty confusing - is this needed for Bandits in B42 or not? A lot of the information here seem to be conflicting.

this isnt a mod for anyone wondering. its nothing if you got here trying to get bandits to work

great work soldier

Thanks cdshmirtz

nakhrin, it is revolved around the Bandits mod, and this is the option for B42 users. At least that's how I got here.

Does this mod has any dependency on another mod? I don't recall downloading it.

Appreciate it so much!!!

legend!

@Ivechy - Are you on build 42? Did you customize your own script for creating the options you want?

If so, create a discussion with your script and maybe I can help!

no matter what i do i can not get this mod to show up in game. i have tried everything.

Thanks for your work !

Thanks dhert, good stuff

@molecule31 - This is a known issue that has been reported to the developers. The "Save" function for the new ModOptions saves to the file "ModOptions.ini". However, the "Load" function uses file "modOptions.ini". On Windows, this would be the same file. On Linux, this is 2 different files.

Hey, apparently, the mod menu on the Linux build works but does not save parameters I've banging my head against the wall for more than a week and all I had to do was put pz through proton to make the mod menu work, I'm so frustrated now

@dhert @PePePePePeil
There actually is a callback, but its for the whole object, not specific settings.
Your modOption object has an apply function you can override that is called whenever the user applies settings

Discussion link because comments do not allow adequate formatting:
https://gtm.steamproxy.vip/workshop/filedetails/discussion/3386860561/595136643598386903/

Thanks for the work done, very useful information.

This guy is the best.

@dhert
Thank you for your response and development request. I was hoping to process it only once when it is changed instead of every time to improve processing performance, I look forward to the ModOptions update, thank you!

@PePePePePeil - Unfortunately no, there's no function called when you change your options that you can hook in to. You'll just either have to keep querying your options directly when needed.
There's a "Modding Request" thread on the official Zomboid Discord, and I requested that an event be created when changes are applied (even provided a snippet of code for them to accomplish this), so hopefully there will be an event in a future update that you can use to re-read all of your settings.

Hello, thank you for providing a new sample of ModOptions. It is very helpful. Previously, with the Mod Options Mod, it was possible to hook into the OnApplyInGame function to perform some processing when settings were changed. Is it possible to achieve the same functionality with the ModOptions in Build 42?

Thanks, this is a helpful way to show the options.

@dhert - Thanks for checking! I decided to go with changing to booting of my mod to when the save loads. This was super helpful and I credited you in my B42 mod. You rock!

Just wanted to say that this was very helpful. Thank you!

There are no additional parameters, its just PZAPI.ModOptions:load().
The settings are loaded as part of the GameBoot, you're correct (specifically when the MainScreen's object is created).
That said, instead of calling load yourself and reading your options immediately after creating them, I would recommend adding an OnGameBoot function of your own to parse the values and set any local variables you need. Or, you can wait until OnGameStart since most options are typically unused until you start the game anyways.
I think it's probably best that all mods have a chance to load and create their options first, before the mod options load is performed.

Hey, Dhert! I was looking into this and found that the mod options are not loaded until sometime after the "OnGameBoot" event. I was poking around and saw PZAPI.ModOptions:load() and figured I could maybe force a load earlier in the process but I'm not sure what parameters that method is expecting. Any ideas?

Ha. I thought I mentioned that in some of the comments and tooltips.
But yea, for most of them its just "option:getValue()"
You don't have to store all of the configs like I did either. You can get your "options" table anytime via:
local options = PZAPI.ModOptions:getOptions("UNIQUEID")

Then get your individual options with:
local option = options:getOption("OptionID")

ok, for most of it, it is config.option:getValue()But
You you let me think Dhert.. it was supposed to be YOUR job, not mine

Did I missed it or the way to extract the config option value at runtime is not described ?
I think the way to get the option object is, but how do we extract something from it ?

You deserve a lot of good things and happy holidays <3

Awesome!

you're precious