Flags on StompyMUX Documentation

add

Mon, 01 Jan 0001 00:00:00 +0000

local changed = object:flags():add(mux.world.flags.SAFE)

Sets the supplied Flag. Returns true when it was newly set and false when it was already present. Native-policy rejection raises mux.object.unavailable.

has

Mon, 01 Jan 0001 00:00:00 +0000

local present = object:flags():has(mux.world.flags.SAFE)

Returns whether the supplied Flag is set. Strings, powers, and other values raise mux.flag.invalid.

list

Mon, 01 Jan 0001 00:00:00 +0000

Returns the currently set flags as Flag[] constants in native registry order. An object with no flags returns an empty array.

for _, flag in ipairs(object:flags():list()) do
 mux.log("flags.log", tostring(flag))
end

remove

Mon, 01 Jan 0001 00:00:00 +0000

local changed = object:flags():remove(mux.world.flags.SAFE)

Clears the supplied Flag. Returns true when it was removed and false when it was already absent. Native-policy rejection raises mux.object.unavailable.