How to use @filter to filter out entire Schema fields with usage parent state data in condition?

[kitdavidenko]

Hi guys!
I have state with nesting, I found greate feature @filter, but I can't understand, can I filter position values in BattleCard with using parent state data? For example here, I need check does have BattleState(root state) needed stage? Will be appreciate for any hint or advice.

export class Boost extends Schema {
  @type('string')
  id: string;

  @type('number')
  value: number;

  @type('number')
  type: BoostType;

  @type('number')
  duration: BoostDurationType;

  @type('boolean')
  availableForUsage: boolean;
}

export class BattleCard extends Schema {
  @type('string')
  id: string;
  @type('number')
  attack: number;
  @type('number')
  hp: number;
  @type('number')
  def: number;
  @type('number')
  speed: number;

  @filter(function (
    this: BattleCard, 
    client: Client, 
    value: BattleCard['position'],
    root: Schema, 
  ) {
    //show when position is dead, or game stage is fighting, or is owner
    //return this.position === BattleCardPosition.DEAD || root.state.stage === BattleStage.BATTLE;
  })
  @type('number')
  position: BattleCardPosition;
  @type([Boost])
  boosts: Boost[];

  get fullSpeed() {
    return (
      this.speed +
      this.boosts.reduce((acc, boost) => {
        if (boost.type === BoostType.SPEED) {
          return acc + boost.value;
        }
        return acc;
      }, 0)
    );
  }
}

export class Tower extends Schema {
  @type('number') hp: number;
}

export class Player extends Schema {
  @type([BattleCard]) cards: BattleCard[];
  @type([Boost]) boosts: Boost[];
  @type(Tower) tower: Tower;
  @type('boolean') ready: boolean;
  @type('number') actionsCount: number;
}

export class BattleState extends Schema {
  @type({ map: Player }) players = new MapSchema<Player>();
  @type('number') stage = BattleStage.WAITING_FOR_PLAYERS;
  @type('number') cycle = 1; 
  @type('number') fightStartAt = 0;
}

[endel]

Hi @kitdavidenko, welcome 👋

I wouldn't recommend using @filter() / @filterChildren() anymore - the upcoming version 0.16 has a replacement feature called StateView, which is meant to portions of the state to be visible to specific clients.

If you can, I'd suggest to upgrade to the 0.16-preview to try it out!

• (WIP) Migration guide here: https://deploy-preview-163--colyseus-docs.netlify.app/upgrading/0.16
• State View docs: https://deploy-preview-163--colyseus-docs.netlify.app/state/view

[kitdavidenko]

Thanks a lot! I will try and answer, how it was