Inventool Settings

⚙️ InventoolSettings Class

Inventool's settings.

Namespace: Esper.Inventool

Access: public

Type: class

Inherits: ScriptableObject


📦 Fields

Access
Field
Type
Description

public

databaseName

string

The name of the database.

public

strictCurrencyValueTypes

bool

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

public

defaultMaxLevel

int

The default max level of a StatProfile.

public

excludeLevelOneFromScaling

bool

If scaling should exclude the first level from the calculation.

public

useStatAbbreviations

bool

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

public

sortingAlgorithm

AutomaticSortingAlgorithm

The sorting algorithm.

public

itemDropCollisionMode

ItemDrop.CollisionMode

The item drop collision mode.

public

itemDropDefaultPrefab

ItemDrop

The default item drop prefab spawned if a custom one for the item doesn't exist.

public

itemDropBillboard

bool

If the item drop sprite should have billboarding enabled.

public

itemDropTimeout

float

The length of time before an item drop is removed.

public

itemDropRange

float

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

public

maxItemStack

int

The maximum amount of a single item stack.

public

stackMultipliesWeight

bool

If the item stack amount should count towards the total weight of the item stack.

public

itemDatasetReference

Dataset

The item dataset reference. This is used by all items to allow custom item data fields to be available in the Inventool editor window.

public

enchantmentLimitType

EnchantmentLimitType

The enchantment limit type.

public

globalEnchantmentLimit

int

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.

public

itemUniqueStatsLimit

int

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

public

hideItemEnchantmentDetails

bool

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

public

displayEnchantedAmount

bool

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

public

enchantedAmountTextColor

Color

The color of the enchanted amount text.

public

buyingType

Shopkeeper.TransactionStepType

The type that determines how buying is handled.

public

sellingType

Shopkeeper.TransactionStepType

The type that determines how selling is handled.

public

shopSubtextColor

Color

The color of all shop item's subtext.

public

showShopSubtypes

bool

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

public

debugLogMode

DebugLogMode

Controls the debug messages logged in the console.

public

storageWithdrawIcon

Sprite

Currency withdraw icon for the storage.

public

storageWithdrawIconColorTint

Color

The storage currency withdraw icon color tint.

public

storageDepositIcon

Sprite

Currency deposit icon for the storage.

public

storageDepositIconColorTint

Color

The storage currency deposit icon color tint.

public

statDisplayMode

StatDisplayMode

How stats are displayed in the item hover details.

public

localizationSettings

InventoolLocalizationSettings

The active localization settings.


🔍 Properties

Access
Property
Type
Description

public

IsLocalizationEnabled

bool

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


🧩 Nested Enums

public enum DebugLogMode

Supported log modes.

Value
Description

None

No logs.

Normal

Normal logs.

public enum StatDisplayMode

Supported stat display modes.

Value
Description

IconAndText

Displays both the stat icon and text.

IconOnly

Displays only the stat icon.

TextOnly

Displays only the stat text.

public enum AutomaticSortingAlgorithm

Supported automatic item sorting algorithms.

Value
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.

public enum EnchantmentLimitType

Supported enchantment limit types.

Value
Description

Global

Use a global enchantment limit for all items.

Individual

Use an enchantment limit specific to the individual item.

Access the Settings

You can access the settings with Inventool.Settings.

var settings = Inventool.Settings;

Last updated