function · world_indicators

is_visible

Returns whether one available world-indicator channel is visible.

world_indicators.is_visible(channel_id) -> visible
Stable ID
world_indicators.is-visible
Owner
app.ScriptPackageHost
Authority
read_only
Timing
immediate
Availability
Phase 14 package callbacks
Side effects
none
Determinism
Host-created package identity and per-callback budgets.
Introduced
1.7.0

Usage

Read the current per-session visibility of one channel available to the calling package origin.

Parameters

Returns

True when the channel is currently enabled; false when it is hidden.

Cost

One indexed host-state lookup.

Fields

This symbol has no fields.

Errors

Examples

local visible = world_indicators.is_visible("development.resource-activity")

API history

Related symbols

Project references