Moodle Framework

Makes it easy to add moodles for modders.

Fellow modders:

IsoPlayer ModData.Moodles was removed. If you own a mod accessing it directly, please remove that access. Use MF.getMoodle and check against nil. That should be enough.

Moodle mods users:

You can use this mod for backward compatibility until moodle modders update their interface usage.

Reports:

If you have errors, report with console.txt on Official PZ Discord: mod_support channel.

Moodle Framework Configuration

If you want colors to be easier to distinguish, you can set to white the reference color for moodles (default on). (same as B41 colors) If you want colors to be vanilla-dark, you can set to grey the reference color for moodles. (same as B42 colors) This applies to both vanilla and modded moodles. You can also deactivate various displays to enhance mod compatibility. Modded Backgrounds with small extensions right or down are now handled too.

How to create a new moodle

If you wanna create a Moodle * then follow the next steps, replacing * by your moodle name.

1/ Moodle Texture

Add Moodle *.png under media\ui. Should be 30 by 30 pixels png with alpha enabled. Note you can also has specific textures per moodle level: e.g. *_Bad_2.png or *_Good_4.png

2/ Texture

Add the following text under media\lua\shared\Translate\EN\Moodles.json

{
"Moodles_*_Good_lvl1": "text_1",
"Moodles_*_Good_desc_lvl1": "text_desc_1",
"Moodles_*_Good_lvl2": "text_2",
"Moodles_*_Good_desc_lvl2": "text_desc_2",
"Moodles_*_Good_lvl3": "text_3",
"Moodles_*_Good_desc_lvl3": "text_desc_3",
"Moodles_*_Good_lvl4": "text_4",
"Moodles_*_Good_desc_lvl4": "text_desc_4",

"Moodles_*_Bad_lvl1": "text_1",
"Moodles_*_Bad_desc_lvl1": "text_desc_1",
"Moodles_*_Bad_lvl2": "text_2",
"Moodles_*_Bad_desc_lvl2": "text_desc_2",
"Moodles_*_Bad_lvl3": "text_3",
"Moodles_*_Bad_desc_lvl3": "text_desc_3",
"Moodles_*_Bad_lvl4": "text_4",
"Moodles_*_Bad_desc_lvl4": "text_desc_4"
}

(json format: don't put a comma on the last entry) You can implement only a subset of this as long as you call only the implemented part.

3/ Moodle object creation

Add these lines in your mod:

require "MF_ISMoodle"
MF.createMoodle(*);

4/ Moodle value updates

Access your moodle from your code with

require "MF_ISMoodle"
MF.getMoodle(*,playerNum):setValue(myNewMoodleValue)--float

0.0 <= myNewMoodleValue <=1.0 Missing playerNum will make the mod incompatible with SplitScreen.

For tuning options see dedicated discussion

Limitations

• Not tested with splitscreen. (it is expected to work since last version)
• Oscillations are not based on vanilla value and the behaviour may depend on performances.

Credits where it is due

• This is inspired from the (removed) mod Zombie Camouflage moodle management by the awesome Dislaik.

Known mods using this

• More Traits
• Dynamic Traits and Expanded Moodles
• Auto Sewing
• ProteinsMoodle
• CannotAttackMoodle
• SixthSense
• Excrementum
• MoodleCombatSpeed
• Nuclear Winter
• MoodleSanity
• SanityMoodleRocky
• Rick's MLC Concussion
• General Anxiety
• MoodleDog
• Evolving Traits World (ETW)
• Weather Moodles
• Seismic Events
• More Smokes
• Serious Cigarette Withdrawl
• More Moodles
• Out of Breath Moodle
• Dirtiness Sickness
• BCU Mod
• Radiated Zones
• Sleepy Moodle
• Pregnancy