Presence and Content Rules

Presence rules read the maps produced by CellPresence and projected into PlaylistState. For actual exterior cells, object maps cover the current exterior 3×3 scan by default, or only the current cell when ScanAdjacentExteriorCells is disabled. Interior and quasi-exterior object maps cover the current cell.

objectExact

Checks record IDs in objectsByRecord. true entries require a matching record; false entries forbid one. A matching forbidden entry always wins, so the result is deterministic when several listed records are present.

local ShrineObjects = {
    ['furn_de_ex_bench_01'] = true,
    ['ex_ashl_tent_01'] = false,
}

isValidCallback = function()
    return Playback.rules.objectExact(ShrineObjects)
end

objectExact replaces staticExact and has the broader name because it reads all object records, not just statics.

staticExact (deprecated)

Compatibility wrapper for objectExact. Existing playlists can keep using it, but new playlists should use objectExact.

staticContentFile

Returns true when a static object in the selected presence scope came from any content file present as a key in contentFiles. Content-file names are normalized to lowercase by the collector, so use lowercase keys.

local ExpansionStatics = {
    ['tamriel rebuilt.esm'] = true,
    ['project cyrodiil mainland.esm'] = true,
}

isValidCallback = function()
    return Playback.rules.staticContentFile(ExpansionStatics)
end

Unlike objectsByContentFile, this rule considers only the files that contributed statics.

typeCount

Checks the number of objects of one OpenMW type. type is required; min and max are optional inclusive bounds.

local ThreeContainers = {
    type = 'Container',
    min = 3,
    max = 10,
}

isValidCallback = function()
    return Playback.rules.typeCount(ThreeContainers)
end

The type names come from OpenMW's object types, such as Static, Container, NPC, and Creature.

cellHasTag

Returns true when the current cell has any supplied FlexTag. Requires FlexTag; otherwise it logs a diagnostic and returns false.

local AshlandTags = { 'ashlands', 'blight' }

isValidCallback = function()
    return Playback.rules.cellHasTag(AshlandTags)
end

cellContainsTagged

Returns true when any record ID in the selected presence scope has any supplied FlexTag.

local DwemerTags = { 'WeaponDwemer', 'ArmorDwemer' }

isValidCallback = function()
    return Playback.rules.cellContainsTagged(DwemerTags)
end

This checks object record IDs, not the cell name and not the content file.

contentTag

Returns true when any content file contributing an object in the current scan has any supplied FlexTag. Requires FlexTag.

local ExpansionTags = { 'tamriel-rebuilt', 'project-cyrodiil' }

isValidCallback = function()
    return Playback.rules.contentTag(ExpansionTags)
end

This checks every content file in objectsByContentFile, not only static contributors.

staticMatch (removed)

This rule has been removed and throws an error when called. Migrate to FlexTag rules, objectExact, or staticContentFile depending on what the playlist needs to identify.