wave8-enableable-component-query-mismatch

Enableable Component Query Mismatch

Intent

Select the correct EntityQuery filter method (WithAll, WithDisabled, WithNone, IgnoreComponentEnabledState) for IEnableableComponent to avoid silently processing the wrong entity set.

Use When

• Writing any query that targets an IEnableableComponent type
• Diagnosing systems that silently miss entities or process entities they should skip

Avoid When

• The component is a plain struct IComponentData without IEnableableComponent — enabled-state filtering does not apply

Senior Pattern

public struct ActiveTag : IComponentData, IEnableableComponent { }

// Case 1 — Process ONLY entities where ActiveTag is ENABLED (default behavior):
foreach (var health in SystemAPI.Query<RefRW<Health>>().WithAll<ActiveTag>())
{
    health.ValueRW.Current -= damage;
    // Only processes entities where ActiveTag enabled bit is true
}

// Case 2 — Process ONLY entities where ActiveTag is DISABLED (e.g., sleeping/inactive):
foreach (var health in SystemAPI.Query<RefRW<Health>>().WithDisabled<ActiveTag>())
{
    health.ValueRW.Current += regenRate;
    // Only processes entities where ActiveTag enabled bit is false
}

// Case 3 — Process ALL entities regardless of enabled state:
var allQuery = SystemAPI.QueryBuilder()
    .WithAll<Health>()
    .WithOptions(EntityQueryOptions.IgnoreComponentEnabledState)
    .Build();
// Use sparingly — bypasses chunk-level enabled optimization

// Case 4 — Process ONLY entities that do NOT HAVE ActiveTag at all (structural absence):
foreach (var health in SystemAPI.Query<RefRW<Health>>().WithNone<ActiveTag>())
{
    // Entities that never had ActiveTag added — NOT for "disabled" filtering
}

// Case 5 — Read enabled state per-entity in IJobEntity:
[BurstCompile]
public partial struct ConditionalUpdateJob : IJobEntity
{
    [BurstCompile]
    public void Execute(EnabledRefRO<ActiveTag> isActive, ref Health health)
    {
        if (isActive.ValueRO)
            health.Current -= 1;
        // Only correct when IgnoreComponentEnabledState is set on the job's query
    }
}