Skip to content

EffectCost

subtype of function

A function used to check or perform an activated effect's cost.

Functions that use this type as parameter

Functions that use this type as parameter

Signature

function(Effect e, int tp, Group eg, int ep, Group ev, Effect re, int r, int rp, int chk) → boolean

lua
function(e,tp,eg,ep,ev,re,r,rp,chk)

Parameters

  • Effect e

    The Effect to activate.

  • int tp

    The player activating the effect.

  • Group eg

    The event group of the effect activation.

  • int ep

    The event player of the effect activation.

  • Group ev

    The event value of the effect activation.

  • Effect re

    The reason effect of the effect activation.

  • int r

    The reason of the effect activation.

  • int rp

    The reason player of the effect activation.

  • int chk

    0 when checking the cost, 1 when performing.

Returns

  • boolean

    If chk is 0, returns true if the effect can be activated.


under-construction