Skip to main content

Objects

Positions and sizes are in tile space. To get the center of a tile add 0.5

Net.list_objects(area_id)​

Returns a list of object_ids.

Net.get_object_by_id(area_id, object_id)​

Returns Net.Object or nil

Net.get_object_by_name(area_id, name)​

Returns Net.Object or nil

Net.create_object(area_id, object_options)​

Returns an object_id

Net.remove_object(area_id, object_id)​

Removes an object, clients will be updated at the end of the tick.

Net.set_object_name(area_id, object_id, name)​

Renames an object.

Net.set_object_class(area_id, object_id, class)​

Changes the object's class, clients will be updated at the end of the tick.

Net.set_object_type(area_id, object_id, type)​

Deprecated. Use set_object_class instead.

Net.set_object_custom_property(area_id, object_id, name, property_value)​

Modifies an object's custom property, clients will be updated at the end of the tick.

Net.resize_object(area_id, object_id, width, height)​

Resizes the object, clients will be updated at the end of the tick.

Net.set_object_rotation(area_id, object_id, rotation)​

rotation is in degrees, clients will be updated at the end of the tick.

Net.set_object_visibility(area_id, object_id, visibility)​

visibility is a bool, the object will be invisible if set to false. Clients will be updated at the end of the tick.

Net.move_object(area_id, object_id, x, y, layer)​

Moves the object, clients will be updated at the end of the tick.

Net.set_object_data(area_id, object_id, object_data)​

Allows for the type and shape of the object to be adjusted. Clients will be updated at the end of the tick.

Net.ObjectOptions​

---@class Net.ObjectOptions
---@field id? number
---@field name? string
---@field class? string deprecated
---@field type? string
---@field visible? boolean
---@field x? number
---@field y? number
---@field z? number
---@field width? number
---@field height? number
---@field rotation? number
---@field data Net.ObjectData
---@field custom_properties? Net.CustomProperties

Net.Object​

---@class Net.Object
---@field id number
---@field name string
---@field class string deprecated
---@field type string
---@field visible boolean
---@field x number
---@field y number
---@field z number
---@field width number
---@field height number
---@field rotation number
---@field data Net.ObjectData
---@field custom_properties Net.CustomProperties

Net.ObjectData​

---@alias Net.ObjectData Net.BasicObjectData | Net.PolygonObjectData | Net.TileObjectData

Net.BasicObjectData​

---@class Net.BasicObjectData
---@field type "point" | "rect" | "ellipse"

Net.PolygonObjectData​

---@class Net.PolygonObjectData
---@field type "polygon" | "polyline"
---@field points { x: number, y: number }[],

Net.TileObjectData​

---@class Net.TileObjectData
---@field type "tile"
---@field gid number
---@field flipped_horizontally boolean
---@field flipped_vertically boolean

Net.CustomProperties​

---@alias Net.CustomProperties table<string, string>