aux.SelfToHandCost

^{Source Code | Usage Examples | aux Functions}

A baseline cost function used for effects that return the activating card itself to the hand as cost, such as You can return this card (you control/from.../etc) to the/your hand; ... (e.g. "Sauravis, the Ancient and Ascended").

Signature

aux.SelfToHandCost(Effect e, int tp, Group eg, int ep, Group ev, Effect re, int r, int rp, int chk) → bool

aux.SelfToHandCost(e,tp,eg,ep,ev,re,r,rp,chk)

Parameters

• Effect e

  The effect being activated.

• int tp

  The player activating the effect.

• Group eg

  A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the event code.

• int ep

  The player associated to the event that prompted the effect activation.

• Group ev

  A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.

• Effect re

  The effect that caused the event that prompted the effect activation.

• int r

  Composite Reason value of the event that prompted the effect activation.

• int rp

  The player that caused the event that prompted the effect activation.

• int chk

  Must be 0 when checking if the cost can be paid, and 1 when performing the cost.

Returns

• bool

  If chk is 0, returns true if the cost can be paid.