WorldHygiene

public static class WorldHygiene

Namespace SideHustle

Added in 3.0.0

Ready-made sets of the world hygiene flags on GamemodeDescriptor, so a World gamemode does not have to know which five booleans belong together. Each method sets the flags on the descriptor you pass and returns it, and only ever switches flags ON: anything you set yourself stays set. Since 3.0.0.

Methods

CleanWorld

public static GamemodeDescriptor CleanWorld(
    GamemodeDescriptor descriptor,
    params string[] allowedQuestTitles)

Types: GamemodeDescriptor

Added in 3.0.0

A clean scratch world: vanilla quests blocked (except allowedQuestTitles), the intro skipped and saving blocked for the session. Fits most World gamemodes.

Parameter
descriptor	The descriptor to change. Null logs a warning and returns null.
allowedQuestTitles	Quest titles that may still start, e.g. “PropHunt”; see GamemodeDescriptor.AllowedQuestTitles. None keeps the titles already set.

Returns The same descriptor, so the call fits inside API.Register.

Arena

public static GamemodeDescriptor Arena(
    GamemodeDescriptor descriptor,
    params string[] allowedQuestTitles)

Types: GamemodeDescriptor

Added in 3.0.0

CleanWorld plus no NPC reactions to gunfire and no vanilla player death - for a gamemode whose players shoot and whose eliminations are its own (the set PropHunt uses).

Parameter
descriptor	The descriptor to change. Null logs a warning and returns null.
allowedQuestTitles	Quest titles that may still start, e.g. “PropHunt”; see GamemodeDescriptor.AllowedQuestTitles. None keeps the titles already set.

Returns The same descriptor, so the call fits inside API.Register.