HL.LayerRuleSpec

class HL.LayerRuleSpec

Table accepted by hl.layer_rule().

Shape

{
    name = string?,
    enabled = boolean?,
    match = table<string, string | boolean>?,

    no_anim = boolean?,
    blur = boolean?,
    blur_popups = boolean?,
    ignore_alpha = number?,
    dim_around = boolean?,
    xray = boolean?,
    animation = string?,
    order = integer?,
    above_lock = integer?,
    no_screen_share = boolean?,
}

Fields

namestring, optional

Rule name. Named rules are reused by later calls with the same name.

enabledboolean, optional

Whether the rule is enabled. Defaults to true.

matchtable, optional

Match table. Keys are rule match property names; values may be strings or booleans.

no_animboolean, optional

Disable animation for matched layers.

blurboolean, optional

Enable blur for matched layers.

blur_popupsboolean, optional

Enable popup blur for matched layers.

ignore_alphanumber, optional

Alpha ignore threshold. Parsed as a float from 0 to 1.

dim_aroundboolean, optional

Dim around the layer.

xrayboolean, optional

Enable xray behavior.

animationstring, optional

Animation name.

orderinteger, optional

Layer rule ordering value.

above_lockinteger, optional

Above-lock behavior. Parsed as an integer from 0 to 2.

no_screen_shareboolean, optional

Prevent screen sharing.

Additional fields

Unknown static fields are looked up in the dynamic layer effect registry.

Used by

hl.layer_rule()

Register a layer rule.