Class l2df.class.storage

Last updated 2021-05-28 15:24:22

Storage class.

Inherited from l2df.Class.

Info:

Functions

Storage:init() Storage initialization.
Storage:reset() Reset storage flushing all stored data.
Storage:add(object[, reload=false]) Add new object to storage.
Storage:addById(object, id[, reload=false]) Add object to storage with provided id.
Storage:addByKey(object, key[, reload=false]) Add object to storage with provided key.
Storage:remove(object) Remove object from storage.
Storage:removeById(id) Remove object from storage by ID.
Storage:getById(id) Return object from storage by ID.
Storage:getByKey(key) Return object from storage by key.
Storage:has(object) Checks for object in storage.
Storage:enum([skipNil=false]) Enumerate storage data #1.
Storage:pairs([skipNil=false]) Enumerate storage data #2.
Storage:first() Get first stored element.
Storage:last() Get last stored element.


Functions

Methods
Storage:init()
Storage initialization.
Storage:reset()
Reset storage flushing all stored data.
Storage:add(object[, reload=false])
Add new object to storage.

Parameters:

  • object mixed
  • reload boolean (default false)

Returns:

  1. number
  2. mixed
Storage:addById(object, id[, reload=false])
Add object to storage with provided id.

Parameters:

  • object mixed
  • id number
  • reload boolean (default false)

Returns:

  1. number
  2. mixed
Storage:addByKey(object, key[, reload=false])
Add object to storage with provided key.

Parameters:

  • object mixed
  • key string
  • reload boolean (default false)

Returns:

  1. number
  2. mixed
Storage:remove(object)
Remove object from storage.

Parameters:

  • object mixed

Returns:

    number
Storage:removeById(id)
Remove object from storage by ID.

Parameters:

  • id number

Returns:

    number
Storage:getById(id)
Return object from storage by ID.

Parameters:

  • id number

Returns:

    mixed
Storage:getByKey(key)
Return object from storage by key.

Parameters:

Returns:

    mixed
Storage:has(object)
Checks for object in storage.

Parameters:

  • object mixed

Returns:

    boolean
Storage:enum([skipNil=false])
Enumerate storage data #1.

Parameters:

  • skipNil boolean (default false)

Returns:

    function
Storage:pairs([skipNil=false])
Enumerate storage data #2.

Parameters:

  • skipNil boolean (default false)

Returns:

    function
Storage:first()
Get first stored element.

Returns:

    mixed
Storage:last()
Get last stored element.

Returns:

    mixed