View source for DotP 2013 Functions

''<nowiki>[Special thanks to RiiakShiNal, thefiremind, and nabeshin]</nowiki>''

==Object==
<tt>GetOwner() : Player</tt>

Returns an object's owner as a Player() reference.

----

<tt>AddScore( score:int ) : void</tt>

<tt>MarkForFilter() : void</tt>

<tt>PaidForWithColour( colour:COLOUR ) : Boolean</tt>

Returns true/false if the object was paid for with mana of the specified color.

----

<tt>IsEnchanted() : Boolean</tt>

Returns true/false if the object is enchanted.

----

<tt>ReleaseDataChest()</tt>

<tt>RetainDataChest()</tt>

<tt>GetDataChest() : DataChest</tt>

<tt>PlayFreeFromAnywhere( player:Player )</tt>

The object is cast without paying its mana cost.

----

<tt>CanBePlayed( player:Player ) : Boolean</tt>

Returns true/false if the object can be cast by the supplied player reference.

----

<tt>WasCast() : Boolean</tt>

Returns true/false if the object was cast as a spell.

----

<tt>IsToken() : Boolean</tt>

Returns true/false if the object is a token.

----

<tt>UseCopiableValues( dc:DataChest ) : void</tt>

<tt>StoreCopiableValues( dc:DataChest ) : void</tt>

<tt>GetPlaneswalkerAttacked() : Planeswalker</tt>

Returns a reference to the Planeswalker the object attacked, except Planeswalkers aren't supported.

----

<tt>GetPlayerAttacked() : Player</tt>

Returns a reference to the player the object attacked.

----

<tt>AttachmentFilter_Get()</tt>

<tt>CalcPotentialScore()</tt>

<tt>CalcScore()</tt>

<tt>GetNumericalChoiceResult() : int</tt>

<tt>GetMultipleChoiceResult() : int</tt>

<tt>NumAttacksThisTurn() : int</tt>

<tt>Kicked() : Boolean</tt>

Returns true/false if the object's kicker cost was paid.

----

<tt>GetBlockVictim() : Player</tt>

<tt>WasBlocked() : Boolean</tt>

Returns true/false if the object was blocked this turn.

----

<tt>IsBlocked() : Boolean</tt>

Returns true/false if the object is being blocked.

----

<tt>IsAttacking() : Boolean</tt>

Returns true/false if the object is attacking.

----

<tt>IsBlocking() : Boolean</tt>

Returns true/false if the object is attacking.

----

<tt>DecreaseColouredCost( color:COLOUR, amount:int ) : void</tt>

Decreases the casting cost of the object by an amount of colored mana.

----

<tt>IncreaseColouredCost( color:COLOUR, amount:int ) : void</tt>

Increases the casting cost of the object by an amount of colored mana.

----

<tt>DecreaseCost( amount:int ) : void</tt>

Decreases the casting cost of the object by an amount of colorless mana.

----

<tt>IncreaseCost( amount:int ) : void</tt>

Increases the casting cost of the object by an amount of colorless mana.

----

<tt>CounterSpell() : void</tt>

Counters the object if it's a spell.

----

<tt>GetManaX() : int</tt>

Returns the amount paid for the object's {X} mana cost.

----

<tt>GetBestOrWorstCounterType() : String</tt>

<tt>CountCounters( counterType:String ) : int</tt>

Returns the number of counters of the specified type on the object.

----

<tt>RemoveCounters( counterType:String, amount:int ) : void</tt>

Removes a number of counters of the specified type on the object.

----

<tt>AddCounters( counterType:String, amount:int ) : void</tt>

Adds a number of counters of the specified type on the object.

----

<tt>ComesIntoPlayTapped() : void</tt>

The object comes into play tapped.

----

<tt>Tapped() : Boolean</tt>

Returns true/false if the object is tapped.

----

<tt>Untap() : void</tt>

Untaps the object.

----


<tt>Tap() : void</tt>

Taps the object.

----

<tt>Hold() : void</tt>

Causes the object to not untap at its controller's next untap step.

----

<tt>TapAndHold() : void</tt>

Taps the object and causes it not to untap at its controller's next untap step.

----

<tt>GetDamage()</tt>

<tt>ClearDamage()</tt>

<tt>PreventNextDamage</tt>

<tt>PreventDamage</tt>

<tt>Protection() : void</tt>

Used with a filter to give the object protection.

----

<tt>SetPermanentController( controller:Player ) : void</tt>

<tt>SetController( controller:Player ) : void</tt>

<tt>GuidedReveal( fromZone:ZONE, toZone:ZONE ) : void</tt>

<tt>Reveal() : void</tt>

Reveals the object from a hidden zone.

----

<tt>PutInPlaneDeck( index:int ) : void</tt>

Puts the object into the Planechase deck.

----

<tt>PutIntoPlayAttachedTo( controller:Player, parent:Object ) : void</tt>

<tt>PutIntoPlayTappedAndAttacking( controller:Player ) : void</tt>

<tt>PutIntoPlayTapped( controller:Player ) : void</tt>

<tt>PutIntoPlay( controller:Player ) : void</tt>

<tt>PutOnBottomOfLibrary() : void</tt>

<tt>PutOnTopOfLibrary() : void</tt>

<tt>PutInLibrary( index:int ) : void</tt>

<tt>PutInHand() : void</tt>

<tt>ReturnToOwnersHand() : void</tt>

<tt>RemoveFromGame() : void</tt>

<tt>PutInGraveyard() : void</tt>

<tt>QueueZoneChange( toZone:ZONE, controller:Player, index:int [Optional] )</tt>

<tt>HasRegeneration() : Boolean</tt>

<tt>GiveRegeneration() : void</tt>

<tt>Sacrifice( controller:Player ) : void</tt>

<tt>DestroyWithoutRegenerate() : void</tt>

<tt>Destroy() : void</tt>

<tt>Discard() : void</tt>

<tt>GetNthAuxTargetCard( index:int ) : Object</tt>

<tt>GetAuxTargetCard() : Object</tt>

<tt>GetNumberOfTargets() : int</tt>

<tt>ClearTarget() : void</tt>

<tt>SetSFXTargetPlayer( target:Player ) : void</tt>

<tt>SetTargetPlayer( target:Player ) : void</tt>

<tt>GetTargetPlayer() : Player</tt>

<tt>GetNthTargetCard( n:int ) : Object</tt>

<tt>SetSFXTargetCard( target:Object ) : void</tt>

<tt>SetTargetCard( target:Object ) : void</tt>

<tt>GetTargetCard() : Object</tt>

<tt>GetNumberOfChildren() : int</tt>

<tt>GetParentalNature()</tt>

<tt>CanAttachTo( object ) : Boolean</tt>

<tt>RemoveFromParent() : void</tt>

<tt>GetParentPlayer() : Player</tt>

<tt>GetParent() : Object</tt>

<tt>NailOnto( object ) : void</tt>

<tt>Enchant( object ) : void</tt>

<tt>Fortificate</tt>

<tt>AttachToPlayer( player ) : void</tt>

<tt>Attach( object ) : void</tt>

<tt>DealDamageFullParams( amount:int, source:Object, isCombatDamage:boolean, isUnpreventable:boolean) : void</tt>

<tt>DealCDamage( amount:int, source:Object ) : void</tt>

<tt>DealDamage( amount:int, source:Object ) : void</tt>

<tt>TestFilter( filter, subject )</tt>

<tt>LoadTargetDefinition( id:int )</tt>

<tt>GetFilter()</tt>

<tt>GetCardName()</tt>

<tt>GetSpec()</tt>

<tt>GetRef()</tt>

<tt>GetCurrentCharacteristics()</tt>

<tt>GetConvertedManaCost()</tt>

<tt>GetCurrentToughness() : int</tt>

<tt>GetCurrentPower() : int</tt>

<tt>GetColour() : int COLOUR</tt>

<tt>SetResolutionZone( ZONE_ )</tt>

<tt>GetResolutionZone() : int ZONE</tt>

<tt>GetErstwhileErstwhileZone() : int ZONE</tt>

<tt>GetErstwhileZone() : int ZONE</tt>

<tt>GetZone() : int ZONE</tt>

<tt>GetSubType() : int CREATURE_TYPE</tt>

<tt>GetSupertype() : int SUPERTYPE</tt>

<tt>GetCardType() : int CARD_TYPE</tt>

<tt>GetPlayer() : Player</tt>

<tt>GetController() : Player</tt>

<tt>TestAny</tt>

<tt>TestAll</tt>

<tt>Test</tt>


==Player==

Bool_Get

Bool_Set( characteristic:PLAYER_CHARACTERISTIC, value:boolean)

Int_Get( index:int )

Int_Set( index:int, value:int )

Int_Increment( index:int )

Int_Decrement( index:int )

SetAttackController( controller:Player )

SetBlockController( controller:Player )

RevealHand()

SetCustomQueryInstructionPtr

SetCustomQueryInstructionValue(value){Used for setting values in displayed text coupled with %d for example}

TestFilter( filter:ObectFilter, player:Player)

MarkForFilter()

AddBadge( badge:PLAYER_BADGE )

DisplayMessage( message:CARD_QUERY )

Sacrifice( victim:Object )

Planeswalk()

TapLand( mana:String )

CanAfford( cost:String )

GetTotalMana()

OutOfTheGame()

PlayerDataChest()

PsuedoPlaySpell( spell:Object )

PlaySpellForFreeAtAnyTime( spell:Object )

CopySpell( spell:Object )

CopySpellAndCastIt( spell:Object )

CopySpellWithNewTargets( spell:Object )

GetUniqueID

SimpleTargetingOn

OpponentHasLandOfColour( colour:COLOUR ) : Boolean

HasLandOfColour( colour:COLOUR ) : Boolean

GetPredominantColour() : COLOUR

GetNextPlayerInTeam() : Player

GetNextPlayer() : Player

GetOpponent

LoseGame() : void

WinGame() : void

GetCurrentCharacteristics()

SorceryTime

GetGlobalIndex

IsHuman() : Boolean

IsAI() : Boolean

MyTurn() : Boolean

PreventNextDamage

PreventDamage

Protection() : void

MoveLocalZone( fromZone:ZONE, toZone:ZONE )

Hand_Count() : int

Hand_GetRandom() : Object

Graveyard_Count() : int

Graveyard_GetNth( index:int ) : Object

PlaneDeck_Count() : int

PlaneDeck_GetBottom() : Object

PlaneDeck_GetNth( index:int ) : Object

PlaneDeck_GetTop() : Object

Library_Count() : int

Library_GetBottom() : Object

Library_GetNth( index:int ) : Object

Library_GetTop() : Object

DiscardRandomCard() : void

DiscardNCardsF

DiscardNCardsDC

DiscardNCards( numCards:int, message:CARD_QUERY )

DrawCard() : void

ShuffleLibrary() : void

MarkSearchedLibrary() : void

GetTeam()

DealDamageFullParams( amount:int, source:Object, isCombatDamage:boolean, isUnpreventable:boolean ) : void

DealCDamage( amount:int, source:Object ) : void

DealDamage( amount:int, source:Object ) : void

LoseLife( amount:int ) : void

GainLife( amount:int ) : void

SetLifeTotal( total:int ) : void

GetLifeTotal() : int

ChooseColour(String [Referencing permanent text], Num)

AskNumericalChoiceQuestion( question:CARD_QUERY ) : void

AddNumericalChoiceAnswer( answer:int ) : void

BeginNewNumericalChoice() : void

AskMultipleChoiceQuestion( question:CARD_QUERY ) : void

AddMultipleChoiceAnswer( answer:CARD_QUERY ) : void

BeginNewMultipleChoice() : void

SetTargetPrompt( index:int, prompt:CARD_QUERY )

GetTargetCount

SetTargetCount( count:int )

ChooseTargetsFromDCWithFlags(Validation, Chest, DataChest Target, Combination of QUERY_ flags)

ChooseTargetFromDCWithFlags(Validation, String [Ref perm text], Chest, DataChest Target, Combination of QUERY_ flags)

ChooseTargetsFromDC

ChooseTargetFromDC(Validation, String [Ref perm text], DataChest Target, DataChest Target)

ChooseTargetsWithFlags(Validation, DataChest Target, Combination of QUERY_ flags)

ChooseTargetWithFlags(Validation, String [Ref perm text], DataChest Target, Combination of QUERY_ flags)

ChooseTargets(Num, DataChest Target)

ChooseTarget(Num, String [Ref perm text], DataChest Target)



==Team==

GetUniqueID() : int

IsSharedLifeTotal() : boolean

GetNthPlayer( index:int ) : Player

GetNumberOfPlayers() : int

TakeExtraTurn() : void



==MTG==

GetStep()

Interrogate_FirstCombatPhaseThisTurn

Interrogate_CardDiedThisTurn(Object)

Interrogate_CombatDamageDealtToPlayerThisPhase(Object, Player, NumStopAt)

Interrogate_DamageDealtToAnyPlayerThisTurn(Object, NumStopAt)

Interrogate_DamageDealtToCreatureThisTurn(Source Object, Damaged Object)

Interrogate_CardsOfTypeOntoBattlefieldThisTurn(Player, CARD_TYPE_ constants, NumStopAt)

Interrogate_NontokenCreaturesDiedThisTurn(Player)

Interrogate_CreaturesDiedThisTurn

Interrogate_SpellsOfColourCastThisTurn(Player, COLOUR_ constants, NumStopAt)

Interrogate_SpellsOfTypeCastThisTurn(Player, CARD_TYPE_ constants, NumStopAt)

Interrogate_SpellsCastThisTurn(Player, NumStopAt)

Interrogate_LifeLostThisTurn(Player)

Interrogate_CardsDrawnThisTurn(Player)

Interrogate_SearchedLibraryThisTurn(Player, Player, NumStopAt)

Interrogate_AttacksThisTurn(Player, NumStopAt)

GetStackObjectController

GetStackObjectCard

CounterStackObject

ClearFilterMarkedPlayers()

ClearFilterMarkedObjectsInZone(Zone)

RandomNumberBetween(NumMin, NumMax)

GetTargetSorter()

SetPlanarDiceNothingOverload(PLANECHASE_DICE_ROLL_ constants)

MessageAllPlayers(String [Referencing permanent text])

ReportStatsEvent(String)

CreateDelayedTrigger(Num, Chest)

FireTrigger(TRIGGER_ constant, Object)

SetProtectedMove

EffectController()

DuelDataChest

ObjectDataChest_NoJIT()

ObjectDataChest()

EffectDataChest()

GetActionRepCount()

GetCurrentTeam

DropIntoDebugger

GetStackCount

FromAIPerspective

GetCurrentCharacteristics()

GetGameType

GetNthTeam(Index)

GetNumberOfTeams()

GetPlayerByGlobalIndex

GetNthStartingPlayer(Index)

GetNumberOfStartingPlayers()

GetNthPlayer(Index)

GetNumberOfPlayers()

GetCurrentObject

PutTokensIntoPlayTappedAndAttackingFromSpec(Object:GetSpec(), Amount, Player [Controller], Player [Attacked], Chest)

PutTokensIntoPlayFromSpec(Object:GetSpec(), Amount, Player)

PutTokensIntoPlayTappedAndAttacking(String, Count, Player [Controller], Player [Attacked])

PutTokensIntoPlayTapped(String, Amount, Player)

PutTokensIntoPlay(String, Amount, Player)

ObtainTokenFromSpec

ObtainToken(String [Token], Player [Controller])

ChargeCounters()

MinusOneMinusOneCounters()

PlusZeroPlusOneCounters

PlusOnePlusZeroCounters

PlusOnePlusOneCounters()

GetCountersType(String)

ReverseTurnOrder()

TakeAdditionalPhase(PHASE_ constants)

GetTurnNumber()

GetPhase()

Bool_Get

Bool_Set



==Filter==

Clear()

SetMarkedObjectsOnly()

SetMinEnchantmentCount(Number)

SetParentPlayer

SetParent(Object)

IsEnchanted(true/false)

ChromaCount(Colour)

SetMonoColoured(true/false)

GetNthEvaluatedObject(Index)

EvaluateObjects()

SetEquivalenceDepth(Amount)

SetBlockVictim

SetConvertedCostMax(Amount)

SetConvertedCostMin

SetConvertedCostValue(Amount)

SetToughnessMax

SetToughnessMin

SetToughnessValue

SetPowerMax

SetPowerMin(Amount)

SetPowerValue

SetUnique()

SetFillFilter

SetStackObjectType(STACK_ constant)

SetReversePortion

SetPortion(NumCards)

SetHint(HINT_ constant, Player)

AddCharacteristic(Characteristic)

AddExtra(FILTER_EXTRA_ constant)

AnyAtAll

CountStopAt(Value)

Count()

AIMay()

May()

AllowDuplicates

NotTargetted()

AddColour(Colour)

AddCardName(String)

SetSecondPlayerInstance(Player)

SetSecondCardInstance(Object)

SetPlayerInstance(Player)

SetCardInstance(Object)

SetCardRef(Object)

SetSupertypes

SetFilterType(Combination of FILTER_TYPE_ constants)

SetSubTypes(Object():GetSubType())

SetSecondCardTypes

SetCardTypes

AddSubType(_TYPE_ constant)

AddSecondCardType(CARD_TYPE constant)

AddCardType(CARD_TYPE constant)

AddSupertype(SUPERTYPE_ constant)

SetOwner(Player)

SetPlayer(Player)

SetControllersTeam(Team)

SetController(Player)

SetHasCounterType(String)

IgnoreIfChangingZone()

SetZone(ZONE_ constant)



==Datachest==

CopyFrom

Count

GetType

Clear()

Free_Compartment(Index)

Get_Chest(Index)

Make_Chest(Index)

AttachTargetDefinition(Id)

Get_NthTargets

Get_Targets(Index)

Make_Targets(Index)

Get_Damage

Set_Damage

Get_Colour

Set_Colour

Get_Supertype

Set_Supertype

Get_SubType

Set_SubType

Get_CardType

Set_CardType

Get_ProtectedCardPtr(Index)

Set_ProtectedCardPtr(Index, Object)

LKIShield_CardPtr(Index)

Protect_CardPtr(Index)

Get_NthCardPtr(Index)

Get_CardPtr(Index)

Set_CardPtr(Index, Object)

Get_TeamPtr

Set_TeamPtr

Get_NthPlayerPtr

Get_PlayerPtr(Index)

Set_PlayerPtr(Index, Player)

Float_Dec

Float_Inc

Float_Div

Float_Mul

Float_Sub

Float_Add

Float_Set

Float_Clear

Float_Get

Get_Float

Set_Float

Int_Dec(Index)

Int_Inc(Index)

Int_Div

Int_Mul

Int_Sub(Index, Integer)

Int_Add

Int_Set(Index, Integer)

Int_Clear(Index)

Int_Get(Index)

Get_Int(Index)

Set_Int(Index, Num)



==Damage==

GetAmount()

SetAmount(Amount)

GetSource(Object)

SetSource

GetReceivingObject()

SetReceivingObject(Object)

GetReceivingPlayer()

SetReceivingPlayer

IsCombat

SetCombat

IsUnpreventable()

SetUnpreventable

GetColour()

SetColour



==Characteristics==

Characteristic_Get(Characteristic)

Characteristic_Set(Characteristic, On/Off [1=On, 0=Off])

Power_Get(Boolean [Optional])

Power_Set(Amount)

Power_Add(Amount)

Toughness_Get()

Toughness_Set(Amount)

Toughness_Add(Amount)

CanBlock_Set

CantBlock_Set

CanOnlyBlock_Set(EVASION_INDEX_ constants)

CanBlock_Clear

CantBlock_Clear

CanOnlyBlock_Clear

CantBeBlockedBy_Set

CanOnlyBeBlockedBy_Set(EVASION_INDEX_ constants)

CantBeBlockedBy_Clear

CanOnlyBeBlockedBy_Clear

MustAttackPlayer

Badge_Set

Badge_Clear

FX_Set

FX_Clear

SubType_GetWritable(Object)

Supertype_GetWritable

CardType_GetWritable(Object)

GrantAbility(ResourceId)

LoseAllAbilities

Colour_Get()

Colour_Set(Colour)

Colour_Add

Int_Increment(PLAYER_INTCHARACTERISTIC_ constants)

[[Category:DotP_Editing]]