Skip to main content

DeckRef

Proxy class representing a skill deck

Properties​

items​

</>
DeckRef.items: table

Get all items contained in the deck

core​

</>
DeckRef.core: table

Get all core items contained in the deck

normal​

</>
DeckRef.normal: table

Get all normal items contained in the deck

Functions​

level_get​

</>
DeckRef:level_get(
item: string--

item type identifier

) → number--

level

Get the deck level associated with an item

suggest_random_all​

</>
DeckRef:suggest_random_all() → string--

item identifier

Suggest a random selection from all items in all decks

suggest_random​

</>
DeckRef:suggest_random() → string--

item identifier

Suggest a random selection from all items in the deck

suggest_count_high​

</>
DeckRef:suggest_count_high() → string--

item identifier

Suggest a item with a high inventory count in the deck

suggest_count_low​

</>
DeckRef:suggest_count_low() → string--

item identifier

Suggest a item with a low inventory count in the deck

suggest_swap_category​

</>
DeckRef:suggest_swap_category() → string--

item identifier

Suggest a item to swap with from a same inventory category from all decks

Show raw api
{
    "functions": [
        {
            "name": "level_get",
            "desc": "Get the deck level associated with an item",
            "params": [
                {
                    "name": "item",
                    "desc": "item type identifier",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "level",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 34,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "suggest_random_all",
            "desc": "Suggest a random selection from all items in all decks",
            "params": [],
            "returns": [
                {
                    "desc": "item identifier",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 43,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "suggest_random",
            "desc": "Suggest a random selection from all items in the deck",
            "params": [],
            "returns": [
                {
                    "desc": "item identifier",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 51,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "suggest_count_high",
            "desc": "Suggest a item with a high inventory count in the deck",
            "params": [],
            "returns": [
                {
                    "desc": "item identifier",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 59,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "suggest_count_low",
            "desc": "Suggest a item with a low inventory count in the deck",
            "params": [],
            "returns": [
                {
                    "desc": "item identifier",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 67,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "suggest_swap_category",
            "desc": "Suggest a item to swap with from a same inventory category from all decks",
            "params": [],
            "returns": [
                {
                    "desc": "item identifier",
                    "lua_type": "string"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 75,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "items",
            "desc": "Get all items contained in the deck",
            "lua_type": "table",
            "source": {
                "line": 13,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "core",
            "desc": "Get all core items contained in the deck",
            "lua_type": "table",
            "source": {
                "line": 20,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        },
        {
            "name": "normal",
            "desc": "Get all normal items contained in the deck",
            "lua_type": "table",
            "source": {
                "line": 27,
                "path": "../../res/data/script/lib/system/deck_ref.lua"
            }
        }
    ],
    "types": [],
    "name": "DeckRef",
    "desc": "Proxy class representing a skill deck",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/system/deck_ref.lua"
    }
}