Inventool Documentation
  • Inventool Documentation
  • đŸ•šī¸Quick Start
    • Installation
    • Start Creating
  • 💡General
    • Running the Demo
    • Menu Options
    • UI Updates
    • UI Customizations
      • uGUI
      • UI Toolkit
    • Custom Item Drops
  • 🎓Tutorials
    • Demo Walkthrough
  • âœī¸Editors
    • Inventool
      • Inventory
      • Equipment
      • Items
      • Currencies
      • Crafting
      • Dismantling
      • Enchanting
      • Stats
        • Stat IDs
        • Attributes
      • Settings
    • Item Type Manager
    • Localization Editor
    • Stats Editor
    • Merchants
      • Shopkeeper
      • Craftsman
      • Enchanter
    • Storage
    • Loot
      • Loot Box
      • Item Pouch
      • Currency Pouch
    • Components
      • Initializer
      • UI
        • uGUI
          • Inventool Window
          • Split UI
            • Inventory Window UGUI
            • Equipment Window UGUI
            • Key Items Window UGUI
            • Crafting Window UGUI
            • Enchanting Window UGUI
            • Storage Window UGUI
            • Shop Window UGUI
            • Selector UGUI
          • Action Menu UGUI
          • Hover Details UGUI
          • Confirm Prompt UGUI
          • Quantity Prompt UGUI
          • Character Viewer Element UGUI
        • UI Toolkit
          • Inventool Window
          • Split UI
            • Inventory Window
            • Equipment Window
            • Key Items Window
            • Crafting Window
            • Enchanting Window
            • Storage Window
            • Shop Window
          • Action Menu
          • Hover Details
          • Confirm Prompt
          • Quantity Prompt
        • Character Viewer
      • Overworld Merchant
      • Storage Keeper
      • Item Drop
      • Item Spawner
      • Input
        • Cross Input Support
        • Cross Input Support UGUI
          • Target Selectable
  • 📄Scripting API
    • Initialization
    • Inventory
    • Equipment
      • Equipment Slot
    • Items
      • Item
      • Item Type
      • Item Stack
      • Item Drop
      • Item Spawner
      • Loot Box
      • Item Pouch
    • Currencies
      • Currency Identity
      • Currency
        • Value
      • Currency Pouch
    • Crafting
      • Craft
      • Crafter
    • Enchanting
      • Enchantment
    • Stats
      • Stat Identity
      • Attribute
      • Stat
        • Stat Value
          • Value
        • Effectiveness
      • Stat Profile
    • Storing
      • Storage
      • Storage Keeper
    • Settings
    • Merchants
      • Shopkeeper
      • Craftsman
      • Enchanter
      • Overworld Merchant
    • UI
      • uGUI
        • Inventool Window UGUI
        • Split UI
          • Draggable Window UGUI
            • Inventory Window UGUI
            • Equipment Window UGUI
            • Key Items Window UGUI
            • Crafting Window UGUI
            • Enchanting Window UGUI
            • Storage Window UGUI
            • Shop Window UGUI
          • Selector UGUI
        • Action Menu UGUI
        • Hover Details UGUI
        • Confirm Prompt UGUI
        • Quantity Prompt UGUI
        • Draggable Element UGUI
          • Equipment Slot Element UGUI
          • Item Slot Element UGUI
          • Item Stack Element UGUI
        • Action Menu Option UGUI
        • Currency Element UGUI
        • Inventory Filter UGUI
        • Inventory Slot UGUI
        • Key Item Element UGUI
        • Shop Item Element UGUI
        • Storage Currency Element UGUI
        • Stat Element UGUI
      • UI Toolkit
        • Inventool Window
        • Split UI
          • Draggable Window
            • Inventory Window
            • Equipment Window
            • Key Items Window
            • Crafting Window
            • Enchanting Window
            • Storage Window
            • Shop Window
        • Action Menu
        • Hover Details
        • Confirm Prompt
        • Quantity Prompt
        • Item Elements
          • Item Stack Element
          • Equipment Slot Element
          • Item Slot Element
          • Shop Item Element
      • Action Menu Option
      • Character Viewer
    • Events
    • Sounds
    • Saving & Loading
      • Inventory & Equipment
      • Storage
    • Input
      • Cross Input Support
      • Cross Input Support UGUI
    • Localization
      • Localization Settings
      • Localizer
  • đŸ› ī¸Support
    • Getting Help
  • 📚Changelogs
    • Latest Releases
    • Future Plans
  • ⭐Rate Me?
Powered by GitBook
On this page
  • Access the Settings
  • Fields & Properties
  • DebugLogMode
  • StatDisplayMode
  • AutomaticSortingAlgorithm
  1. Scripting API

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

itemEnchantmentLimit

The number of times a single item can be enchanted.

int

public

hideItemEnchantmentDetails

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

bool

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.

PreviousStorage KeeperNextMerchants

Last updated 19 days ago

📄