aux.RegisterClientHint

^{Source Code | Usage Examples | aux Functions}

Registers an effect that applies a hint on a player(s) which is visible when you hover over a player's info box at the top of the client. Typically used for effects that are scripted to affect monsters but will also apply to any appropriate monster that is placed in the relevant location at a later point (e.g. "Exosister Gibrine").

Signature

aux.RegisterClientHint(Card c, int|nil property_code, int reg_player, int s, int o, int str, [int reset_code = RESET_PHASE|PHASE_END, int ct = 1]) → nil

aux.RegisterClientHint(c,property_code,reg_player,s,o,str,reset_code,ct)

Parameters

• Card c

  The card that is registering the effect that applies the hint.

• int|nil property_code

  Composite EffectFlag to set to the effect in addition to EFFECT_FLAG_PLAYER_TARGET|EFFECT_FLAG_CLIENT_HINT.

• int reg_player

  The player registering the effect.

• int s

  The first player to apply the effect to. Set it to 1 to apply the effect to the registering player, set it to 0 otherwise.

• int o

  The second player to apply the effect to. Set it to 1 to apply the effect to the opponent of the registering player, set it to 0 otherwise.

• int str

  The id of the string to display on the hint.

• int reset_code

  Optional. Defaults to RESET_PHASE|PHASE_END.

  Additional resets to set to the effect.

• int ct

  Optional. Defaults to 1.

  Different reset count to set to the effect.

---

registers-effect