Lukkit
  • Home
  • Getting Started
    • Installing Lukkit
    • Your First Plugin
    • Packing and Publishing
  • Storage
    • The StorageObject
    • Example
  • Commands
    • Command Options
    • Command Event
    • Examples
  • Gui
    • Create a simple inv
    • Create an advanced inv
    • Run function if an inventory item has been clicked
  • Events
    • Examples
    • Event List
      • Block
      • Enchantment
      • Entity
      • Hanging
      • Inventory
      • Player
      • Server
      • Vehicle
      • Weather
      • World
  • Globals
    • Global Functions
    • Global Variables
      • Plugin
      • Logging
      • Utilities
  • Wrappers
  • Examples
    • Discord Webhooks (http)
    • Toggle Fly
    • Hello, world!
Powered by GitBook
On this page
  • storage:getType(): "yaml" or "json"
  • storage:exists(path: string): boolean
  • storage:setDefaultValue(): boolean
  • storage:setValue(path: string, value: any): boolean
  • storage:getValue(path: string): any
  • storage:clearValue(path: string): boolean
  • storage:save()
  1. Storage

The StorageObject

PreviousStorageNextExample

Last updated 6 years ago

This is the object returned when calling . Here it is represented as storage.

storage:getType(): "yaml" or "json"

Returns the type of the storage object, it will be either "yaml" or "json".

storage:exists(path: string): boolean

Returns true if the path exists in the storage file and false if not

storage:setDefaultValue(): boolean

Sets the default value for a path. Returns true if the value is set and false if not

storage:setValue(path: string, value: any): boolean

Sets the value of the path in the storage file. Returns false if there was an error setting the value.

storage:getValue(path: string): any

Gets the value from the storage file from its path.

storage:clearValue(path: string): boolean

Deletes the value from the storage file from its path. Returns false if there was an error setting the value.

storage:save()

Save the current storage object to its file. It is recommended to do this on plugin disable.

plugin.getStorageObject(file: string)