ObjStackList¶

Overview¶

An ObjStackList provides access to all active ObjStackEntities in the game world, as well as several methods to search for entities.

Info

All methods return an array of ObjStackEntities.

See each method for examples on how to use this list.

Functions¶

All¶

function ObjStackList.All() -> [ ObjStackEntity ]

Returns all active ObjStackEntities in the game world in an array.

Returns	Description
[ ObjStackEntity ]	An array of ObjStackEntities.

Example

local allObjStacks = ObjStackList.All()
for _,objStackEntity in ipairs(allObjStacks) do
    if objStackEntity:HasObj(config.Obj.LOGS) then
        -- found some logs
    end
end

ByName¶

function ObjStackList.ByName(name : String) -> [ ObjStackEntity ]

Returns any ObjStackEntity which contains an ObjEntry with a display name matching the given name value.

String matches are case-insensitive.
Matches are exact unless wildcard characters ? and/or * are provided.

Parameter	Type	Description
name	String	The string to match against `ObjType.name`.

Returns	Description
[ ObjStackEntity ]	An array of ObjStackEntities.

Example

-- At coord 0_50_50_32_32

found = ObjStackList.ByName("*logs*")
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,5,24)
--      1: Logs (count: 1, configID: 1511)
--  2: (stackSize: 1, coordGrid: 2,50,50,5,26)
--      1: Logs (count: 1, configID: 1511)
--  3: (stackSize: 1, coordGrid: 2,50,50,8,25)
--      1: Logs (count: 1, configID: 1511)
--  4: (stackSize: 1, coordGrid: 2,50,50,9,24)
--      1: Logs (count: 1, configID: 1511)

found = ObjStackCList.ByName("mind rune")
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 0,50,50,6,8)
--      1: Mind rune (count: 1, configID: 558)

found = ObjStackList.ByName("rune")
-- Returns these entities:
--  Empty

found = ObjStackList.ByName("*rune")
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 0,50,50,6,8)
--      1: Mind rune (count: 1, configID: 558)

ByDistance¶

function ObjStackList.ByDistance(coordGrid : CoordGrid, range : Integer) -> [ ObjStackEntity ]

Returns any ObjStackEntity within range tiles of the given coordGrid value.

Exact coord matches should use a value of 0 for range.

Parameter	Type	Description
coordGrid	CoordGrid	The coord at which to centre the distance search.
range	Integer	The maximum tile distance from the given coord which an ObjStackEntity must be.

Returns	Description
[ ObjStackEntity ]	An array of ObjStackEntities.

Example

-- At coord 0_50_50_32_32

found = ObjStackList.ByDistance(CoordGrid._0_50_50_10_10, 6)
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 0,50,50,5,12)
--      1: Knife (count: 1, configID: 946)
--  2: (stackSize: 1, coordGrid: 0,50,50,6,8)
--      1: Mind rune (count: 1, configID: 558)
--  3: (stackSize: 1, coordGrid: 0,50,50,8,14)
--      1: Bowl (count: 1, configID: 1923)
--  4: (stackSize: 1, coordGrid: 0,50,50,9,14)
--      1: Empty pot (count: 1, configID: 1931)
--  5: (stackSize: 1, coordGrid: 0,50,50,11,12)
--      1: Jug (count: 1, configID: 1935)

ByConfig¶

function ObjStackList.ByConfig(objType : ObjType) -> [ ObjStackEntity ]

Returns any ObjStackEntity that contains a ObjEntry referencing the given ObjType config.

Parameter	Type	Description
objType	ObjType	The config to look for when testing ObjStackEntities.

Returns	Description
[ ObjStackEntity ]	An array of ObjStackEntities.

Example

-- At coord 0_50_50_32_32

found = ObjStackList.ByConfig(config.Obj.BOWL_EMPTY)
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 0,50,50,8,14)
--      1: Bowl (count: 1, configID: 1923)

ByConfigID¶

function ObjStackList.ByConfigID(objTypeID : Integer) -> [ ObjStackEntity ]

Returns any ObjStackEntity that contains a ObjEntry referencing the given ObjType config ID.

Parameter	Type	Description
objTypeID	Integer	The config ID to look for when testing ObjStackEntities.

Returns	Description
[ ObjStackEntity ]	An array of ObjStackEntities.

Example

-- At coord 0_50_50_32_32

found = ObjStackList.ByConfigID(id.Obj.BOWL_EMPTY)
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 0,50,50,8,14)
--      1: Bowl (count: 1, configID: 1923)

Filter¶

function ObjStackList.Filter(filterSet : Table) -> [ ObjStackEntity ]

Returns any ObjStackEntity that matches all tests in the filterSet table.

Available tests are:

Key	Type	Description
name	String	A name to match against `ObjType.name`. `{ name = "logs" }` See ObjStackList.ByName()
coordGrid	CoordGrid	A coord to test entity distance from. If `range` is not provided, the default value of `range` will be `0`. `{ coordGrid = CoordGrid._0_50_50_32_32 }` See ObjStackList.ByDistance()
range	Integer	Ignored if `coordGrid` key is not provided. `{ range = 4 }` See ObjStackList.ByDistance()
config	ObjType	The config to match against entries of `ObjEntry.config`. `{ config = config.Obj.LOGS }` See ObjStackList.ByConfig()
configID	Integer	The config ID to match against entries of `ObjEntry.configID`. `{ configID = id.Obj.LOGS }` See ObjStackList.ByConfigID()
func	Function	A function which returns a boolean, and which takes an ObjStackEntity as its only parameter. This function is called for every entity, and any call that returns `true` will include that ObjStackEntity in the return array. `function logFinder(objStackEntity) { return objStackEntity:HasObj(config.Obj.LOGS) }` `{ func = logFinder }`

Tests can be combined as shown below:

-- Return all objStacks containing logs within 3 tiles of 0_50_50_4_24
found = ObjStackList.Filter({ config = config.Obj.LOGS, coordGrid = CoordGrid._0_50_50_4_24, range = 3 })

Info

Tests are inclusive.
All must pass in order for the ObjStackEntity to be included in the return array.

Parameter	Type	Description
filterSet	Table	A table of key-value pairs which describe individual tests to perform.

Returns	Description
[ ObjStackEntity ]	An array of ObjStackEntities.

Example

-- At coord 0_50_50_32_32

-- Filter all objStacks for config ID
local foundByFilterConfigID = ObjStackList.Filter({ configID = id.Obj.LOGS })
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,5,24)
--      1: Logs (count: 1, configID: 1511)
--  2: (stackSize: 1, coordGrid: 2,50,50,5,26)
--      1: Logs (count: 1, configID: 1511)
--  3: (stackSize: 1, coordGrid: 2,50,50,8,25)
--      1: Logs (count: 1, configID: 1511)
--  4: (stackSize: 1, coordGrid: 2,50,50,9,24)
--      1: Logs (count: 1, configID: 1511)



-- Filter all objStacks for a specific config
local foundByFilterConfig = ObjStackList.Filter({ config = config.Obj.LOGS })
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,5,24)
--      1: Logs (count: 1, configID: 1511)
...
--  4: (stackSize: 1, coordGrid: 2,50,50,9,24)
--      1: Logs (count: 1, configID: 1511)

-- Filter all objStacks for the exact display name "logs"
local foundByFilterName = ObjStackList.Filter({ name = "logs" })
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,5,24)
--      1: Logs (count: 1, configID: 1511)
...
--  4: (stackSize: 1, coordGrid: 2,50,50,9,24)
--      1: Logs (count: 1, configID: 1511)

function filterLogsObj(objStack)
    return objStack:HasObjID(id.Obj.LOGS)
end

-- Filter all objStacks for those that pass the func 'filterLogsObj'
local foundByFilterFunc = ObjStackList.Filter({ func = filterLogsObj })
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,5,24)
--      1: Logs (count: 1, configID: 1511)
...
--  4: (stackSize: 1, coordGrid: 2,50,50,9,24)
--      1: Logs (count: 1, configID: 1511)

-- Filter all objStacks for those within 10 tiles of 0_50_50_32_32
local foundByFilterCoord = ObjStackList.Filter({ coordGrid = CoordGrid._0_50_50_32_32, range = 10 })
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,29,23)
--      1: Bronze pickaxe (count: 1, configID: 1265)

-- Filter all objStacks for those of config type LOGS within 3 tiles of 0_50_50_4_24
local foundByFilterConfigAndCoord = ObjStackList.Filter({ coordGrid = CoordGrid._0_50_50_4_24, range = 3, config = config.Obj.LOGS })
-- Returns these entities:
--  1: (stackSize: 1, coordGrid: 2,50,50,5,24)
--      1: Logs (count: 1, configID: 1511)
--  2: (stackSize: 1, coordGrid: 2,50,50,5,26)
--      1: Logs (count: 1, configID: 1511)