Skip to content

Commit

Permalink
Add files via upload
Browse files Browse the repository at this point in the history
  • Loading branch information
pyrQ authored Nov 20, 2024
1 parent f07d3a4 commit 363be99
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions api/functions/Auxiliary/SelfRevealCost.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---!function
name: SelfRevealCost
namespace: aux
description: A baseline [cost function](/api/types/EffectCost) used for effects that reveal the activating card itself as cost, such as `You can reveal this card in your hand; ...` (e.g. "Sakitama").
summary: Cost function for effects that reveal the card itself as cost.
status:
index: stable
parameters:
- name: e
type: [ Effect ]
description: The effect being activated.
- name: tp
type: [ int ]
description: The player activating the effect.
- name: eg
type: [ Group ]
description: A group of cards associated to the event that prompted the effect activation. The specifics of this group vary depending on the [event code](/api/enums/Event).
- name: ep
type: [ int ]
description: The player associated to the event that prompted the effect activation.
- name: ev
type: [ Group ]
description: A value associated to the event that prompted the effect activation. The specifics of this value vary depending on the event code.
- name: re
type: [ Effect ]
description: The effect that caused the event that prompted the effect activation.
- name: r
type: [ int ]
description: Composite [Reason](/api/enums/Reason) value of the event that prompted the effect activation.
- name: rp
type: [ int ]
description: The player that caused the event that prompted the effect activation.
- name: chk
type: [ int ]
description: Must be `0` when checking if the cost can be paid, and `1` when performing the cost.
returns:
- type: [ bool ]
description: If `chk` is `0`, returns `true` if the cost can be paid.
guaranteed: false

0 comments on commit 363be99

Please sign in to comment.