Defines Mod Helpers config settings. More...

Inherits ModConfig.

Static Public Attributes
static ModHelpersConfig	Instance => ModContent.GetInstance<ModHelpersConfig>()
	Gets the stack-merged singleton instance of this config file. More...

Properties
bool	DebugModeCheats = false `[get, set]`
	Enables cheat codes. Also requires 'privileged user' status enabled. More...

bool	DebugModeHelpersInfo = false `[get, set]`
	Outputs (to log) debug information relevant to specific Helpers functions (where applicable). Developers only. More...

bool	DebugModeNetInfo = false `[get, set]`
	Outputs (to log) network message information (sends and receives of PacketProtocol). More...

bool	DebugModePacketInfo = false `[get, set]`
	Logs PacketProtocol payload content. More...

bool	DebugModeUnhandledExceptionLogging = true `[get, set]`
	Catches and logs unhandled exceptions (before crash). More...

bool	DebugModeDumpAlsoServer = false `[get, set]`
	Allows users to invoke 'data dumps' (see DataDump service) on behalf of the server (without being the 'privileged' user). More...

bool	DebugModeDisableSilentLogging = false `[get, set]`
	Disables logging of "silenced" exceptions. More...

bool	DebugModeMenuInfo = false `[get, set]`
	Displays the current menu's ID in bottom right. More...

bool	DebugModeEntityGroupDisplay = false `[get, set]`
	Displays all entity groups in the log on mod load. More...

bool	DebugModeMouseInfo = false `[get, set]`
	Displays info at the mouse's location. More...

bool	DebugModeMiscInfo = false `[get, set]`
	Shows misc. debug info. More...

bool	DisableControlPanel = false `[get, set]`
	Disables control panel outright. More...

int	ControlPanelIconX = 0 `[get, set]`
	Control panel icon's X coordinate on screen. Negative values align the button from the right edge. More...

int	ControlPanelIconY = 0 `[get, set]`
	Control panel icon's Y coordinate on screen. Negative values align the button from the bottom edge. More...

int	InboxIconX = 2 `[get, set]`
	Horizontal X coordinate of in-game inbox icon. Negative values align the button from the right edge. More...

int	InboxIconY = 80 `[get, set]`
	Horizontal Y coordinate of in-game inbox icon. Negative values align the button from the bottom edge. More...

int	ModIssueReportErrorLogMaxLines = 15 `[get, set]`
	Quantity of the latest log entries to pass along with issue reports. More...

bool	WorldModLockEnable = true `[get, set]`
	Enables mod locking per world (prevents playing a world with missing mods). More...

bool	WorldModLockMinimumOnly = true `[get, set]`
	Sets mod locking to expect only the exact set of mods it was locked with, and no more. More...

bool	CustomPlayerDataAsText = false `[get, set]`
	Save custom player data as (json) text. More...

bool	DisableAllInternetFeatures `[get, set]`
	Shorthand for disabling all internet functions More...

bool	ModCallCommandEnabled = false `[get, set]`
	Allows calling `Mod.Call(...)` via. chat/console commands. Use at your own risk! More...

int	PacketRequestRetryDuration = 60 * 4 `[get, set]`
	Duration (in game ticks) to wait in expectation of a reply before a retry attempt of a given packet is made. More...

bool	IsServerGaugingAveragePing = true `[get, set]`
	Server occasionally pings clients to guage their latency. More...

int	PingUpdateDelay = 60 * 15 `[get, set]`
	Duration between latency pings per client. More...

bool	DisableModMenuTweaks = false `[get, set]`
	Disables mod tags UI for mod browser and mod info. More...

bool	DisableModTags = false `[get, set]`
	Disables mod tags UI for mod browser and mod info. More...

bool	DisableJudgmentalTags = true `[get, set]`
	Disable 'judgmental' mod tags. More...

bool	DisableModMenuUpdates = false `[get, set]`
	Disables mod version updates overlay display in the mod menu. More...

bool	DisableOwnIPCheck = true `[get, set]`
	Disables IP address checks from checkip.dyndns.org. More...

bool	CoalAsTile = true `[get, set]`
	Coal items can be placed like tiles. More...

bool	AddCrimsonLeatherRecipe = true `[get, set]`
	Adds crimson biome alternatve recipe for leather. More...

Detailed Description

Defines Mod Helpers config settings.

Definition at line 16 of file Config.cs.

Member Data Documentation

◆ Instance

ModHelpersConfig HamstarHelpers.ModHelpersConfig.Instance => ModContent.GetInstance<ModHelpersConfig>()

static

Gets the stack-merged singleton instance of this config file.

Definition at line 20 of file Config.cs.

Property Documentation

◆ AddCrimsonLeatherRecipe

bool HamstarHelpers.ModHelpersConfig.AddCrimsonLeatherRecipe = true

getset

Adds crimson biome alternatve recipe for leather.

Definition at line 317 of file Config.cs.

◆ CoalAsTile

bool HamstarHelpers.ModHelpersConfig.CoalAsTile = true

getset

Coal items can be placed like tiles.

Definition at line 309 of file Config.cs.

◆ ControlPanelIconX

int HamstarHelpers.ModHelpersConfig.ControlPanelIconX = 0

getset

Control panel icon's X coordinate on screen. Negative values align the button from the right edge.

Definition at line 131 of file Config.cs.

◆ ControlPanelIconY

int HamstarHelpers.ModHelpersConfig.ControlPanelIconY = 0

getset

Control panel icon's Y coordinate on screen. Negative values align the button from the bottom edge.

Definition at line 140 of file Config.cs.

◆ CustomPlayerDataAsText

bool HamstarHelpers.ModHelpersConfig.CustomPlayerDataAsText = false

getset

Save custom player data as (json) text.

Definition at line 199 of file Config.cs.

◆ DebugModeCheats

bool HamstarHelpers.ModHelpersConfig.DebugModeCheats = false

getset

Enables cheat codes. Also requires 'privileged user' status enabled.

Definition at line 41 of file Config.cs.

◆ DebugModeDisableSilentLogging

bool HamstarHelpers.ModHelpersConfig.DebugModeDisableSilentLogging = false

getset

Disables logging of "silenced" exceptions.

Definition at line 84 of file Config.cs.

◆ DebugModeDumpAlsoServer

bool HamstarHelpers.ModHelpersConfig.DebugModeDumpAlsoServer = false

getset

Allows users to invoke 'data dumps' (see DataDump service) on behalf of the server (without being the 'privileged' user).

Definition at line 77 of file Config.cs.

◆ DebugModeEntityGroupDisplay

bool HamstarHelpers.ModHelpersConfig.DebugModeEntityGroupDisplay = false

getset

Displays all entity groups in the log on mod load.

Definition at line 98 of file Config.cs.

◆ DebugModeHelpersInfo

bool HamstarHelpers.ModHelpersConfig.DebugModeHelpersInfo = false

getset

Outputs (to log) debug information relevant to specific Helpers functions (where applicable). Developers only.

Definition at line 48 of file Config.cs.

◆ DebugModeMenuInfo

bool HamstarHelpers.ModHelpersConfig.DebugModeMenuInfo = false

getset

Displays the current menu's ID in bottom right.

Definition at line 91 of file Config.cs.

◆ DebugModeMiscInfo

bool HamstarHelpers.ModHelpersConfig.DebugModeMiscInfo = false

getset

Shows misc. debug info.

Definition at line 112 of file Config.cs.

◆ DebugModeMouseInfo

bool HamstarHelpers.ModHelpersConfig.DebugModeMouseInfo = false

getset

Displays info at the mouse's location.

Definition at line 105 of file Config.cs.

◆ DebugModeNetInfo

bool HamstarHelpers.ModHelpersConfig.DebugModeNetInfo = false

getset

Outputs (to log) network message information (sends and receives of PacketProtocol).

Definition at line 55 of file Config.cs.

◆ DebugModePacketInfo

bool HamstarHelpers.ModHelpersConfig.DebugModePacketInfo = false

getset

Logs PacketProtocol payload content.

Definition at line 62 of file Config.cs.

◆ DebugModeUnhandledExceptionLogging

bool HamstarHelpers.ModHelpersConfig.DebugModeUnhandledExceptionLogging = true

getset

Catches and logs unhandled exceptions (before crash).

Definition at line 70 of file Config.cs.

◆ DisableAllInternetFeatures

bool HamstarHelpers.ModHelpersConfig.DisableAllInternetFeatures

getset

Shorthand for disabling all internet functions

Definition at line 211 of file Config.cs.

◆ DisableControlPanel

bool HamstarHelpers.ModHelpersConfig.DisableControlPanel = false

getset

Disables control panel outright.

Definition at line 122 of file Config.cs.

◆ DisableJudgmentalTags

bool HamstarHelpers.ModHelpersConfig.DisableJudgmentalTags = true

getset

Disable 'judgmental' mod tags.

Definition at line 284 of file Config.cs.

◆ DisableModMenuTweaks

bool HamstarHelpers.ModHelpersConfig.DisableModMenuTweaks = false

getset

Disables mod tags UI for mod browser and mod info.

Definition at line 269 of file Config.cs.

◆ DisableModMenuUpdates

bool HamstarHelpers.ModHelpersConfig.DisableModMenuUpdates = false

getset

Disables mod version updates overlay display in the mod menu.

Definition at line 291 of file Config.cs.

◆ DisableModTags

bool HamstarHelpers.ModHelpersConfig.DisableModTags = false

getset

Disables mod tags UI for mod browser and mod info.

Definition at line 277 of file Config.cs.

◆ DisableOwnIPCheck

bool HamstarHelpers.ModHelpersConfig.DisableOwnIPCheck = true

getset

Disables IP address checks from checkip.dyndns.org.

Definition at line 300 of file Config.cs.

◆ InboxIconX

int HamstarHelpers.ModHelpersConfig.InboxIconX = 2

getset

Horizontal X coordinate of in-game inbox icon. Negative values align the button from the right edge.

Definition at line 151 of file Config.cs.

◆ InboxIconY

int HamstarHelpers.ModHelpersConfig.InboxIconY = 80

getset

Horizontal Y coordinate of in-game inbox icon. Negative values align the button from the bottom edge.

Definition at line 161 of file Config.cs.

◆ IsServerGaugingAveragePing

bool HamstarHelpers.ModHelpersConfig.IsServerGaugingAveragePing = true

getset

Server occasionally pings clients to guage their latency.

Definition at line 250 of file Config.cs.

◆ ModCallCommandEnabled

bool HamstarHelpers.ModHelpersConfig.ModCallCommandEnabled = false

getset

Allows calling Mod.Call(...) via. chat/console commands. Use at your own risk!

Definition at line 227 of file Config.cs.

◆ ModIssueReportErrorLogMaxLines

int HamstarHelpers.ModHelpersConfig.ModIssueReportErrorLogMaxLines = 15

getset

Quantity of the latest log entries to pass along with issue reports.

Definition at line 172 of file Config.cs.

◆ PacketRequestRetryDuration

int HamstarHelpers.ModHelpersConfig.PacketRequestRetryDuration = 60 * 4

getset

Duration (in game ticks) to wait in expectation of a reply before a retry attempt of a given packet is made.

Definition at line 242 of file Config.cs.

◆ PingUpdateDelay

int HamstarHelpers.ModHelpersConfig.PingUpdateDelay = 60 * 15

getset

Duration between latency pings per client.

Definition at line 259 of file Config.cs.

◆ WorldModLockEnable

bool HamstarHelpers.ModHelpersConfig.WorldModLockEnable = true

getset

Enables mod locking per world (prevents playing a world with missing mods).

Definition at line 181 of file Config.cs.

◆ WorldModLockMinimumOnly

bool HamstarHelpers.ModHelpersConfig.WorldModLockMinimumOnly = true

getset

Sets mod locking to expect only the exact set of mods it was locked with, and no more.

Definition at line 189 of file Config.cs.

The documentation for this class was generated from the following file:

Project/HamstarHelpers/Config.cs

Static Public Attributes

Properties

Detailed Description

Member Data Documentation

◆ Instance

Property Documentation

◆ AddCrimsonLeatherRecipe

◆ CoalAsTile

◆ ControlPanelIconX

◆ ControlPanelIconY

◆ CustomPlayerDataAsText

◆ DebugModeCheats

◆ DebugModeDisableSilentLogging

◆ DebugModeDumpAlsoServer

◆ DebugModeEntityGroupDisplay

◆ DebugModeHelpersInfo

◆ DebugModeMenuInfo

◆ DebugModeMiscInfo

◆ DebugModeMouseInfo

◆ DebugModeNetInfo

◆ DebugModePacketInfo

◆ DebugModeUnhandledExceptionLogging

◆ DisableAllInternetFeatures

◆ DisableControlPanel

◆ DisableJudgmentalTags

◆ DisableModMenuTweaks

◆ DisableModMenuUpdates

◆ DisableModTags

◆ DisableOwnIPCheck

◆ InboxIconX

◆ InboxIconY

◆ IsServerGaugingAveragePing

◆ ModCallCommandEnabled

◆ ModIssueReportErrorLogMaxLines

◆ PacketRequestRetryDuration

◆ PingUpdateDelay

◆ WorldModLockEnable

◆ WorldModLockMinimumOnly