Skip to content

Cost.PayLP

Source Code | Usage Examples | Cost Functions

Creates a baseline cost function used for effects that pay LP as cost, such as Pay X LP; ... (e.g. "Instant Fusion").

aliases: aux.PayLPCost

Signature

Cost.PayLP(number lp_value, [bool pay_until = false]) → EffectCost

lua
Cost.PayLP(lp_value,pay_until)

Parameters

  • number lp_value

    The amount of LP that must be paid. If set to less than 1, then that fraction of LP will be paid instead (e.g. 1/2 to pay half, "Solemn Judgment").

  • bool pay_until

    Optional. Defaults to false.

    If set to true, the cost will become Pay LP so that you only have "lp_value" left; ... (e.g. "The Winged Dragon of Ra").

Returns

  • EffectCost

    The cost function generated based on the given parameters.