Under the hood

This page uses Transform from Unity. The glossary says what each one is.

How the framework reads the game, for modders who want to dig deeper.

Npcs

• NPCDirector.globalDatabase holds rows from StreamingAssets/NPCBehavior.json.
• NPCManager.AddNpcToList raises Spawned, before Start runs. NPCManager.RemoveNpcFromList raises Despawned.
• NPCInfo.ChangeState raises Died on a move to Dead. Only NPCInfo.Kill sets Dead, and nothing in the game calls it.
• Position is the live transform. Otherwise it is NPCData.state.currentPosition.
• UpdateFade hides NPCs farther than hideDistance (20). hideAlways (ChangeHiddenStatus) hides them at any distance.
• FadeGameObject.Hide and FadeGameObject.Show call SetActive; culling sets only culled. FadeGameObjectController.ShowAll runs on save.
• Present reads isHidden, hideAlways, the parent and CurrentScene, and culled via AccessTools.Field.
• InScene() lists NPCInfo components. IsDirector checks for a database entry.
• Handle is the component’s GUID field. Otherwise it is scene:Name[index]/.... Copies of a prefab can share it.

Feature groups

• Spawn and despawn use obenseuer.moddingframework.npcs. Death uses obenseuer.moddingframework.npcs.died. Relationships use obenseuer.moddingframework.npcs.relationship.