Skip to main content
Link
Menu
Expand
(external link)
Document
Search
Copy
Copied
Obenseuer Modding Framework
Home
Features
Install
Getting started
Your first mod
Logging
Config
Keybinds
Using events
Save data
Patching
Packaging
Visual Studio template
When things run
Once or again and again
One play session
Starting the game
Loading and playing
Saving and quitting
Which hook should I use
Cookbook
Give an item
Pay the player
React to a new day
Add a Mods menu page
Add an HTML panel
Ship an item icon
Guides
Content
Content models
Gameplay and economy
UI and HTML views
Using the framework alongside other mods
API reference
Framework basics
Conditions
Debug
Common tasks
Turning it on and off
What the trace shows
Limits
The log file
Checking the trace itself
Details
Framework core classes
Common tasks
Plugin
CorePatcher
CoreLog
Events
GameTime
Wallet
SaveData
Survival
CameraView
Tweaks
TweakState
ModMenu
MainMenuButtons
ComputerApps
PlayerLook
Details
Developer menu
Framework helpers
Common tasks
CoreMod
CorePatcher short helpers
Events.WhenReady
Details
Framework mods
Common tasks
Attributes and base class
Settings
Loading
Identity and version
Dependencies
Mods menu
Loader-specific members
Details
Game save data
Common tasks
Copying one saved object
Self-check
Save folder and Peek
Bound slots: SaveData.Bind
Details
Global flags
Main menu
Common tasks
MainMenuButtons
Add
SetControlsEnabled
IsOpen
The MODS button
Details
Save slots
Settings
Common tasks
GameSettings
Keybinds
Localization
Details
Start choices
Tutorial
People
Characters
Janitors
Mod NPC routines
Common tasks
Orders
Routines
Details
Mod NPCs
Common tasks
Types and members
Spawn
SpawnWithLook
Look and shape
SpawnSaved
Saving
Extras
What you can't do (yet)
Details
NPC actions
Common tasks
How every action works
Moving and hurting
Following the player
Speaking
Looking
Sending an NPC to another scene
What you can't do (yet)
Details
NPC animation
Common tasks
Playing and stopping on an NPC
Playing on any animator
How a clip looks on the NPC
Movement and the NPC's own routine
Bad values
What you can't do (yet)
Details
NPC appearance
Common tasks
Meshes and materials
Two kinds of body
Looks of slider characters
Blend shapes
Characters from the game and characters your mod added
What you can't do (yet)
Details
NPC control
Common tasks
Taking and releasing an NPC
What each flag changes
Rules for taking an NPC
What you can't do (yet)
Release on a dead NPC
Scene loads and saves
Details
NPC movement
Common tasks
Moving an NPC
Rules for moving an NPC
What you can't do (yet)
Details
NPC schedules
NPCs
Common tasks
Finding NPCs
NPCs in the loaded scenes
Details
Under the hood
Relationships
Robbers
Tenants
Traders
Common tasks
Reading a trader
Changing a trader's money
Changing prices
Buying from and selling to a trader
Details
Law and crime
Law actions
Pursuit
Surveillance
Common tasks
Cameras and the checks
Events
What you can't do (yet)
Details
Animals and plants
Animal actions
Common tasks
Orders
Tame and wild
What you can't do (yet)
Details
Animals
Autofarms
Breeding
Growing stations
Plant actions
Player life and skills
Contests
Common tasks
Reading contests
Rat fight payout factors
What you can't do (yet)
Details
Custom skills
Common tasks
Skills
The character panel rows
Banners
Saving
Details
Item consumables
Jobs
Medical
Common tasks
Treatments and prices
Details
Player
Common tasks
PlayerState
Wait stations
Damage and breakdown intercepts
Skills
Effects
Subscriptions
Travel
Camera
A longer example
Details
Player movement
Common tasks
Reading how the player moves
Speed and jump multipliers
Holding the player in place
Locking only the mouse look
Crouching
Other things that change how the player moves
Details
Sleep events
Wardrobe
Weapons
Common tasks
Held weapons
Reloading
Events
Hit power
Flashlight
Osrat signal detector
What you can't do (yet)
Details
Items and crafting
Crafting sources
Crafting stations
Common tasks
The calls
Speed
Quality
More than one mod
Saving
Start and stop
Pause and resume
What you can't do (yet)
Details
Crafting upgrades
Extractables
Furniture
Common tasks
Defining furniture
Models
Blueprints and flatpacks
World spawning
Details
Inventory
Common tasks
Names
Player inventory
Item stacks
Containers
Try it out
Unloaded storage
Details
Item givers
Items
Common tasks
Lookup
ItemDef
Notes
Held model
Details
Loot pools
Common tasks
How picking works
Reading
Adding and removing
The ContainerFilled event
Details
Recipes and crafting
Common tasks
Recipes
Crafting stations
Growing plants
What you can't do (yet)
Details
Recycling
Registry
Common tasks
IDs
Items
Item icons
Models
Recipes
Save manifest
Missing items
Worked example: Spicy Sewer Jerky
Limits
Details
Resource nodes
Stack actions
World item events
Common tasks
Events
World item ids
Expiry default
Details
Storage panel
Recipe filter
Inventory sources
Money and shops
Base shops
Common tasks
Shops
Buying
Selling
Details
Card games
Common tasks
Tables and games
Payout factors
Details
Casino
Common tasks
The machines
Events
Payout factors
What you can't do (yet)
Details
Economy
Common tasks
Money (Cash)
Cash.Oc and Cash.Rm
Shops
Banking
Bank ledger
Player shops
Mail
Legal services
Details
Fuel
Common tasks
Gas stations
Buying fuel
Fuel items
Details
Invoices
Common tasks
Listing and sending bills
The name on the bill
Money
How invoices are paid and saved
Invoice senders in the level
What you can't do (yet)
Details
Market shops
Shop hours
Shop stock
Common tasks
Shop keys
Traders
Vending machines
Removing your mod
What is saved
Details
Places and travel
Doors
Common tasks
Finding doors
Opening and closing
Opening hours
Door events
Details
Elevators
Hotels
Common tasks
Listing and renting rooms
Details
Housing
Common tasks
Apartments and tenants
Evictions
Building
Building areas
Catalogue
What you can't do (yet)
Details
Interaction and locks
Common tasks
Interactions
Locks and doors
Details
Ladders
Landmarks
Common tasks
Game landmarks
Custom landmarks
Saving
What you can't do (yet)
Limits
Details
Levels
Common tasks
Level changers
What you can't do (yet)
Details
Renovations
Common tasks
Reading renovations
The states
Ordering a renovation
The Finished event
What you can't do (yet)
Details
Scene logic
Scene looks
Common tasks
The rules
Check from the Mods menu
Looking for a look
Loading a look
Putting a look on a body
Putting a look on the body's own skeleton
Limits
Details
Scene state
Tarp doors
Time control
Common tasks
Clock speed, timers and the minute event
When the framework forgets your settings
Details
Train actions
Train tickets
Trains
Common tasks
The minitrain
Trains on the track
Switches and loaders
Pieces of track
Events
Details
World
Common tasks
WorldWeather
WorldPower
WorldWater
WorldRadiation
WorldLocation
WorldClock
Details
World sky
Common tasks
Setting and clearing
The values
How several mods share the sky
How the framework keeps your values in place
What you can't do (yet)
Details
Objects and devices
Blast sites
Breakables
Common tasks
Listing and breaking objects
Locks
Smashed
Details
Cleaning
Dishwashers
Drones
Common tasks
Reading and controlling drones
Air nodes
Node passes
Route
Details
Flood gates
Common tasks
Reading and controlling gates
Turning the power back on
Details
Hazards
Instruments
Common tasks
Guitars
Playing notes and songs
Events
What you can't do (yet)
Details
Lanterns
Lights
Common tasks
Simple lights
Multi-state lights
What you can't do (yet)
Details
Power devices
Common tasks
Listing and switching devices
Events
What you can't do (yet)
Details
Saunas
Seats
Showers
Signs
Spawners
Common tasks
Reading spawners
Changing respawn settings
Spawning now
The Spawned event
Details
Surfaces
Tanks
World objects
Common tasks
Finding objects
Scene paths
Mod data on a world object
Spawn
What stays after a save and a load
Details
Phones, mail and media
Books
Computer desk
Computer files
Mail schedules
Mailboxes
Common tasks
Reading mailboxes
What you can't do (yet)
Details
Notes
Parcel lockers
Phone lines
Common tasks
Phone numbers
Phones and calls
Events
What you can't do (yet)
Details
Phones
Radios
Televisions
Screen and UI
Audio
Common tasks
Playing the game's own sounds
Playing your own clip
Loading a WAV file
Building a clip from numbers
Volumes
Changing a volume for this session
Ambient sound (soundscape)
What you can't do (yet)
Details
HUD
Common tasks
Hud
Bars
ConsoleCommands
Achievement
GameDifficulty
Difficulty presets
TaskItems
What you can't do (yet)
Details
Screen effects
Common tasks
Which calls throw and which return false
Shake
Fading to black
Death message
FOV override
Vignette
Blur
Details
UI
Common tasks
Setting up your project
Windows
Controls
The model preview
Colours and shapes
What has not been tested in a running game
Details
UI state
Input capture
Web UI
Common tasks
Install and requirements
The WebUi class
The WebView class
Pinning
Frame hosts
Navigation
Shared assets
Theme
Messages from the shim
Details
Story
Dialogue authoring
Common tasks
Writing a conversation
Responses to a game conversation
Branches under a game NPC line
Text callbacks
Narration
Self-check
Details
Quest authoring
Common tasks
Ids
Making a task
Changing a task
Saving
Testing your tasks
Details
Quests, dialogue and law
Common tasks
Rules for all three APIs
Quests (experimental)
Dialogue
Law (experimental for Arrest)
Details
Online play
Multiplayer
Common tasks
Steam
Net
Lobby
Version check
Presence
Blob
Details
Obenseuer Modding Framework new game options API
Obenseuer Modding Framework world props API
Events
Examples
FAQ
Glossary
Status
Search Obenseuer Modding Framework
API reference
Animals and plants
Animal actions
What you can't do (yet)
What you can’t do (yet)
You can’t make an animal follow the player. See the note under “Tame and wild” above.