Settings

Scripting with the InventoolSettings class.

The InventoolSettings class provides miscellaneous settings used all across Inventool.

Access the Settings

You can access the settings with Inventool.Settings.

var settings = Inventool.Settings;

Fields & Properties

Name
Description
Type
Acess

databaseName

The name of the database.

string

public

strictCurrencyValueTypes

If the numeric value types should match when doing math with currencies.

bool

public

defaultMaxLevel

The default max level of a StatProfile.

int

public

useStatAbbreviations

If the stat text should use the abbreviated name instead of the full name.

bool

public

sortingAlgorithm

The sorting algorithm.

InventoolSettings.AutomaticSortingAlgorithm

public

itemDropCollisionMode

The item drop collision mode.

ItemDrop.CollisionMode

public

itemDropBillboard

If the item drop sprite should have billboarding enabled.

bool

public

itemDropTimeout

The length of time before an item drop is removed.

float

public

itemDropRange

The range in which the item drop spawns in the game world relative to the player's position when the player drops an item.

float

public

maxItemStack

The maximum amount of a single item stack.

int

public

enchantmentLimitType

The enchantment limit type.

EnchantmentLimitType

public

globalEnchantmentLimit

A hard limit on the number of times an item can be enchanted. This is used for all items if the enchantment limit type is set to Global.

int

public

itemUniqueStatLimit

A hard limit on the number of unique stats an item can have through enchanting.

int

public

hideItemEnchantmentDetails

If enabled, the enchantment details will be hidden in the item hover details popup.

bool

public

displayEnchantedAmount

If the amount of times an item has been enchanted should be displayed to the player.

bool

public

enchantedAmountTextColor

The color of the enchanted amount text.

Color

public

buyingType

The type that determines how selling is handled.

Shopkeeper.TransactionStepType

public

sellingType

The type that determines how selling is handled.

Shopkeeper.TransactionStepType

public

shopSubtextColor

The color of all shop item's subtext.

Color

public

showShopSubtypes

If item subtypes should be displayed in the shop filter list.

bool

public

debugLogMode

Controls the debug messages logged in the console.

InventoolSettings.DebugLogMode

public

storageWithdrawIcon

Currency withdraw icon for the storage.

Sprite

public

storageWithdrawIconColorTint

The storage currency withdraw icon color tint.

Color

public

storageDepositIcon

Currency deposit icon for the storage.

Sprite

public

storageDepositIconColorTint

The storage currency deposit icon color tint.

Color

public

statDisplayMode

How stats are displayed in the item hover details.

InventoolSettings.StatDisplayMode

public

localizationSettings

The active localization settings.

InventoolLocalizationSettings

public

IsLocalizationEnabled

If localization is enabled. Localization is enabled if localizationSettings is not null.

bool

public

DebugLogMode

Name
Description

None

No logs.

Normal

Normal logs.

StatDisplayMode

Name
Description

IconAndText

Displays both the stat icon and test.

IconOnly

Displays only the stat icon.

TextOnly

Displays only the stat text.

AutomaticSortingAlgorithm

Name
Description

SizeDesc

Sorts items by size descending.

SizeAsc

Sorts items by size ascending.

FirstToLast

Items are sorted in the order they were obtained, with the first ones obtained appearing first.

EnchantmentLimitType

Name
Description

Global

Use a global enchantment limit for all items.

Individual

Use an enchantment limit specific to the individual item.

Last updated