Gccg-script Function Reference

List of All Functions

- A - InitializeInputSystem
ProductLookup
abs
InitializeLocationTables
push
AcceptableResult
InitializeLocationTables
Put.Active
AcceptResult
InitializeLocationTables
Put.DeckBottom
Action
InitializeLocationTables
Put.DeckTop
Action
InitializePanelSystem
Put.Hand
ActiveSetMenu
InitializeScoreSystem
Put.OutOfPlay
AddCard
InitializeWatcher
Put.Table
AddCard
InitialScore
PutActive
AddCards
InitialScore
PutCardInGroup
AddCards
InitialScore
PutDeck
AddGameResult
InitialScore
PutDeckBottom
AddHistory
InitServer
PutDeckHook
AddInputHook
InitServerHook
PutHand
AddMarker
InitServerHook
PutTable
AddMarker
InitServerHook
PutTableHook
AddMinuteTimer
InitTables
PutTableHook
AddRoomPlayer
inline_images
PutTableHook
AddRoomTable
inplay
put_cardbox
AddSideboardFwCards
Input
put_cardbox_recenter
AddTickets
InputHook
put_deck_bottom
AddTimer
InputHook
put_deck_top
AddToDeck
InputKeyBackspace
put_hand
add_marker
InputKeyDelete
put_inplay
add_text
InputKeyEnd
- Q -
add_to_collection
InputKeyHome
Quit
AdjustScore
InputKeyLeft
quit
age
InputKeyRight
- R -
age
InputNewline
Raise
Alert
InputSplit
raise
AlertOff
InputSplit
Raise
AllDecksLoaded
intersect
random
apply
InverseSelectByAttr
RandomCardSet
ApplyImportDeck
invert
randomize
ApplyImportDeckBack
IsAway
RandomNearPoint
array
isdict
rarities
ASCIIFormatParser
isfunction
read_file
ASCIIFormatSuffix
IsLoop
RecalculateScores
AssignPlayer
IsObject
Receive
Attach
isreal
ReceiveClose
attach
IsRestricted
ReceiveData
attach
IsServer
ReceiveData
Attach
IsStayTapped
ReceiveOpen
Attachments
IsTableBanned
RecognizeCard
Attr
IsUserDisplay
RecognizeDeckFormat
attributes
isvar
redraw
attrs
IsVeryNear
RefineFilter
AvailableForSale
IsVolatile
refresh
AvailableForTrade
is_object
Refresh
AvatarFloorPos
is_user
RefreshBook
AvatarPos
- J - RefreshBookForDeck
AvatarRecalcTable
join
RefreshChatRoom
- B - JoinTable
RefreshCurrentDeck
beep
JoinTable
RegisterDeck
Bid
joker_match
RegisterGameResult
BidHook
JudgeChatCommandTime
RegisterPlayer
BookChangeForsale
- K - RegisterPlayer
BookFullRefresh
KeyAltKey1
RegisterServer
BookGoBack
KeyAltKey2
RegisterSubmenu
BookSetPrice
KeyAltKey3
RemoveAvatar
book_cards
KeyAltKey4
RemoveObsoletePrices
book_entry
KeyAltKey5
remove_obsolete_prices
book_last_page
KeyAltKey6
repeat
book_page
KeyBackspace
replace
book_pageof
KeyControlKey0
ReplaceTable
book_set_deck
KeyControlKey1
ReplaceTableHook
book_set_entry
KeyControlKey2
replace_cardbox_recenter
book_set_index
KeyControlKey3
Reply
book_set_page
KeyControlKey4
Reply
book_set_slot
KeyControlKey5
ReRegisterPlayer
book_set_slot
KeyControlKeyB
RestoreDeck
book_titles
KeyControlKeyC
RestoreMenuContext
Buy
KeyControlKeyH
ResultAccepted
Buy
KeyControlKeyM
return
BuyCard
KeyControlKeyP
Reveal
- C - KeyControlKeyPageDown
reverse
cache_parameters
KeyControlKeyPageUp
right
call
KeyControlKeyR
Roll
canonical_name
KeyControlKeyReturn
Roll
card
KeyDelete
RootObject
cardbox
KeyDown
root_object
CardMenu
KeyEnd
rot
cards
KeyEnter
Rotate
CardSelectBoxMenu
KeyEscape
Rotate
CardsOfSetWithRarity
KeyEscapeHook
round
card_attr
KeyF10
RuleAgentMindTotal
card_back
KeyF11
RuleBothHeroAndMinionUnique
card_data
KeyF12
RuleCanonicalCardLimitSingle
Category
KeyF1
RuleCardLimitAny
CategoryMatch
KeyHome
RuleCardLimitGeneral
center_of
KeyLeft
RuleCardLimitSingle
change_card
KeyModifierDown
RuleCardSet
ChatCommandAway
KeyModifierUp
RuleCardSetReprint
ChatCommandBuy
KeyPageDown
RuleCheckExpression
ChatCommandCopydeck
KeyPageUp
RuleCheckWizards
ChatCommandDefault
KeyReturn
RuleCountBiggestPopulation
ChatCommandGive
KeyRight
RuleCountColors
ChatCommandGo
keys
RuleCountCreatures
ChatCommandJoin
KeyShiftAltKeyB
RuleDeckMaximum
ChatCommandNewdeck
KeyShiftAltKeyD
RuleDeckMinimum
ChatCommandRd
KeyShiftAltKeyF
RuleDeckSizes
ChatCommandRenamedeck
KeyShiftAltKeyH
RuleHazardResourceBalance
ChatCommandSave
KeyShiftAltKeyR
RuleLimitByExpression
ChatCommandSealed
KeyShiftAltKeyS
RuleLimitEachByExpression
ChatCommandSu
KeyShiftControlKey0
RuleNonUniqueStageCards
ChatKeyControlKeyD
KeyShiftControlKeyB
RuleOptions
ChatKeyControlKeyE
KeyShiftControlKeyB
RulePass
ChatKeyControlKeyI
KeyShiftControlKeyC
rules
ChatKeyControlKeyS
KeyShiftControlKeyC
RuleSpecific
ChatKeyControlKeyW
KeyShiftControlKeyC
RuleStagepoints
ChatKeyControlKeyX
KeyShiftControlKeyD
RuleViolation
ChatMapMenu
KeyShiftControlKeyF
- S -
CheckFilterVersion
KeyShiftControlKeyF
save
CheckForCard
KeyShiftControlKeyG
SaveAll
CheckFunctionsOrQuit
KeyShiftControlKeyG
SaveAll
CheckInitialVariables
KeyShiftControlKeyL
SaveBookState
CheckInitialVariablesOrQuit
KeyShiftControlKeyP
SaveFilename
CheckLegalitySubmenu
KeyShiftControlKeyR
SavegameHook
CheckPrice
KeyShiftControlKeyR
SaveMenuContext
CheckSealedCharacter
KeyShiftControlKeyS
SavePath
check_card
KeyShiftControlKeyT
Say
ChooseDeckMenu
KeyShiftControlKeyU
Say
ClearCardBook
KeyShiftControlKeyW
Say
ClearEmptyGroups
KeyShiftControlKeyW
scale_image
ClearGame
KeyShiftControlKeyW
Score
ClearScores
KeyShiftControlKeyX
Score
ClearSearchbox
KeyShiftControlKeyY
ScoreAdjustment
Command
KeyTab
ScoreToText
Command
KeyUp
ScoreToText
CommandAddproduct
- L - ScoreToText
CommandBan
L
screen2table
CommandBans
languages
scripts
CommandBid
last
ScrollHistory
CommandBind
lc
Sealed
CommandBindk
LeaveChatMode
SealedEnd
CommandDebug
LeavePlayMode
SealedEndHook
CommandDelgame
LeaveTable
SealedEndHook
CommandDelproduct
LeaveTable
SealedOff
CommandDisplay
LeaveWatchMode
SealedOn
CommandEval
left
SealedStart
CommandFaq
LegalityCheck
SealedStartHook
CommandFaqclear
LegalityCheckDeck
SealedStartHook
CommandFind
LegalityCheckRule
SearchDeck
CommandGiveticket
LegalityCheckRules
SearchDeck
CommandGrant
LegalityCheckRuleset
SearchStartingCards
CommandHave
length
SectionSubmenu
CommandHelp
LineSplitFirstSpace
select
CommandKick
listbox_clear
SelectByAttr
CommandKicktable
listbox_entry
SelectCard
CommandLoadgame
listbox_scroll
SelectDeck
CommandLoadimages
listbox_set_deck
SelectDeckPart
CommandLog
listbox_set_entry
SelectMenuChooseADeck
CommandMe
listbox_sort_rows
Send
CommandNewuser
listjoin
Send
CommandPayall
load
Send
CommandProducts
LoadAllRules
SendAll
CommandQuit
LoadAllScripts
SendAll
CommandReboot
LoadAvatar
SendAllNP
CommandRefresh
LoadBookState
SendFullGameStatus
CommandRegister
LoadgameHook
SendFullGameStatusHook
CommandReload
LoadMenu
SendMeta
CommandReload
load_deck
SendOther
CommandRemoveuser
load_image
SendOther
CommandReproduce
LocationList
seq
CommandRestrict
Log
Set
CommandRo
Log
SetActive
CommandRtfm
Log
SetAvatar
CommandRtfm
Lower
SetAwayOff
CommandSave
lower
SetAwayOn
CommandSavegame
Lower
SetBookIndex
CommandSelect
LowerAttachments
SetBookPage
CommandSet
- M - SetCardbook
CommandSort
MainLoop
SetDeck
CommandTables
MakeLegalityCheck
SetForsale
CommandUnban
MakeLegalityCheck
SetHand
CommandUnbind
mana
SetHandSize
CommandUnrestrict
ManualTarget
SetJoinGame
CommandUnset
MapCon2Plr
SetMe
CommandUsers
max
SetMode
CommandWant
Menu
SetMoney
CommandWho
MenuByContext
SetMyName
CommandWhois
MenuClick
SetOfCard
CommandYell
MergeDeck
SetOption
CompanySize
MergeDeckSubmenu
SetPassword
Con2Plr
Message
SetPrice
Con
message
SetPrice
ConnectServer
MessageHook
SetProducts
ConstructMenu
min
sets
CoordinateMapping
min_price
SetScore
CoordToPlr
Mode
SetStayTapped
CoordToSvr
Mode
SetUpPlayer
copy
mouse
SetUpPlayer
count
MouseControlLeftClick
SetUpPlayer
CountCanonicalNamePairs
MouseControlLeftDragBegin
SetUpPlayer
CountCards
MouseControlLeftDragEnd
set_attr
CounterSubmenu
MouseControlMiddleClick
set_bgcolor
CountNamePairs
MouseControlMiddleClickMap
set_cardsize
count_cards
MouseLeftClick
set_data
CreateActive
MouseLeftClickActiveSet
set_error_trigger
CreateAvatar
MouseLeftClickActiveSet
set_fgcolor
CreateDeck
MouseLeftClickActiveSet
set_forsale
CreateDeck
MouseLeftClickCard
set_lang
CreateDeckHook
MouseLeftClickCardSelectBox
set_name
CreateDeckHook
MouseLeftClickCurrentDeck
set_of
CreateFilter
MouseLeftClickDeck
set_price
CreateHand
MouseLeftClickDeckSearchBox
set_textalign
CreateIndex
MouseLeftClickDiscardPile
set_textcolor
CreatePanel
MouseLeftClickDiscardPileSearchBoxHook
set_textfont
CreatePlayerIcon
MouseLeftClickHand
set_textmargin
CreatePlayerObjects
MouseLeftClickMap
set_textsize
CreateScreen
MouseLeftClickMyCollection
set_textvalign
CreateTypeLegalTable
MouseLeftClickOpenBooster
set_title
create_book
MouseLeftClickOpponentHand
ShowGameSpecificHelp
create_cardbox
MouseLeftClickPool
ShowGameSpecificHelp
create_deck
MouseLeftClickPoolSearchBoxHook
ShowHelp
create_hand
MouseLeftClickPrizes
ShowPanel
create_image
MouseLeftClickSideboard
ShowPlaymat
create_listbox
MouseLeftClickSideboard
ShowScreen
create_menu
MouseLeftClickSideboardSearchBoxHook
shuffle
create_msgbox
MouseLeftClickSiteCard
ShuffleDeck
CurrentDeckAddHavens
MouseLeftClickSites
SideboardSearchBoxMenuHook
CurrentDeckAddSites
MouseLeftClickSites
SingleCardMenu
CurrentDeckMenu
MouseLeftClickSitesSearchBoxHook
SingleCardMenuHook
CurrentDeckRemoveSites
MouseLeftClickSitesSearchBoxHook
SingleCardMenuHook
CurrentDeckRemoveUnownedSites
MouseLeftClickTable
SitesOfRegion
CurrentFilter
MouseLeftClickTwilightPool
SlashCommand
CurrentSorting
MouseLeftDragBegin
SlashComments
current_time
MouseLeftDragEnd
sleep
- D - MouseMiddleClick
sort
DataPath
MouseMiddleClickCard
SortSites
date
MouseMiddleClickCard
sort_by
deck
MouseMiddleClickCurrentDeck
sort_fn
DeckCheck
MouseMiddleClickDeckSearchBox
sort_fn
DeckMenu
MouseMiddleClickHand
Special
DeckName
MouseMiddleClickMap
Special
DeckName
MouseMiddleClickMyCollection
SpecialEventAdjustScore
decks
MouseMiddleClickOpenBooster
SpecialHook
DeckSearchBoxMenu
MouseMiddleClickPoolSearchBoxHook
split
DeclareResult
MouseMiddleClickSites
SplitToWords
Default
MouseMiddleClickTable
StacksByGroup
DefaultInitialPrice
MouseMiddleClickTwilightPool
stacktrace
del
MouseMiddleDragBegin
StartChatMode
DelActive
MouseMiddleDragEnd
StartGame
DelCard
MouseMoveObject
StartGame
DelCardInGroup
MouseWheel
StartGame
DelCards
MouseWheelChatMsg
StartGame
DelCursor
MouseWheelCurrentDeck
StartGame
DelDeck
MouseWheelMenu
StartGame
DelDeckHook
MouseWheelMyCollection
StartPlayMode
DelDeckTop
MoveAvatar
StartWatchMode
DeleteDeck
MoveObject
str2filter_atom
DelHand
MoveObject
str2filter_exp
DelMarker
MovePanel
str2filter_join
DelMarker
move_object
str2filter_rel
DelMenu
Msg
str2filter_split
DelRoomPlayer
msgbox_scroll
str2filter_sum
DelRoomTable
MsgCards
str2filter_term
delsaved
MsgChat
str2filter_typeconvert
DelTable
MsgOrdinal
str2filter_typetoint
DelTableHook
MsgTransfer
str2filter_typetostring
del_all_texts
MsgVerbObject
str2sorting
del_cardbox
MsgVerbObjectObject
String2Filter
del_cardbox_all_recenter
MyCollectionMenu
String2Sorting
del_cardbox_recenter
MyDeck
strreplace
del_deck
MyFrodo
strreplace
del_deck_top
MyPath
SubjectName
del_entry
- N - Submenu
del_hand
name
subobjects
del_marker
net_client_ip
substr
del_object
net_client_name
sum
del_prices
net_close
- T -
del_text
net_connect
table2screen
DestroyUserDisplay
net_create_server
Table
Detach
net_get
TableCoord
detach
net_isopen
TableMenu
Detach
net_send
TableNumber
diff_time
net_server_close
TableObject
DiscardPileMenu
net_server_get
tail
DisconnectPlayer
net_server_isopen
Take.Active
DisconnectServer
net_server_send
Take.Deck
DisplaySubmenu
net_server_send_all
Take.DeckTop
dist
NewDeck
Take.Hand
dump
NewDeck
Take.OutOfPlay
- E - NewDeck
Take.SearchDeck
EditAdd
NewDeck
Take.Table
EditAddSideboard
NewUser
tap
EditAddSideboard
NextFreeAttachPos
tapped
EditCardname
NextSiteNumber
tapped_left
EditCardNumber
NextTarget
tap_left
EditCountCards
None
TargetCard
EditCreateDeck
Null
TargetingOptions
EditDel
Null
TargetName
EditNearestPartname
Null
text
EditPartname
Number
text_height
EditRemoveSideboard
- O - text_width
EditRemoveSideboard
ObjectAt
Tickets
EndGame
ObjectName
TicketsList
EndGame
objects
TicketsOf
EndGame
object_data
time
EndGameHook
object_name
Timer15Seconds
EndGameHook
object_type
Timer5Seconds
EndOfTurnHook
ObjH
Timer
EnsurePriceUpdate
ObjW
TimerMinute
execute
OpenBoosterMenu
title
ExportASCIIDeck
OpponentActiveSetMenu
tofilename
ExportCards
OpponentDeckMenu
tofnc
ExportDeckMenu
OpponentDiscardPileMenu
ToggleJoinGame
ExportGccgDeck
OpponentHandMenu
TogglePanel
ExportToFile
OpponentPrizesMenu
toint
- F - OriToPlr
TokenSubmenu
filter_mana
OriToSvr
toreal
find
OtherDeckFormats
tostr
FindCardGroupIndices
Owner
Touch
FindCards
Owner
toval
FindOtherCard
- P - tr
FindSpace
PanelVisible
tr
first
ParentObject
Transfer
FixedSet
Play.Card.Stage1
TransferMoney
Flash
Play.Card.Stage2
TribalLegal
flatten
Play
trigger
Flip
PlayCard
trim
forall
PlayCommandDraw
TrimSpaces
format
PlayCommandInplay
TryTransferHook
FreeTablePos
PlayCommandLegal
TryTransferHook
fuzzy
PlayCommandLose
TryTransferTo
fuzzy_images
PlayCommandOk
TwilightPool
- G - PlayCommandUndecided
TwilightTokens
GameSetup
PlayCommandWin
TypeLegal
game_data
PlayerName
typeof
game_option
PlayerNumber
TypeRestricted
GccgFormatParser
PlayerOrder
- U -
GccgFormatSuffix
PlayEvent
uc
GeneratePassword
PlayFromSelectionHook
ucfirst
GetByPrimaryCategory
PlayInstant
unique
GetGroups
PlayInterrupt
UnsetStayTapped
get_attr
PlayKeyControlKeyA
untap
get_card_data
PlayKeyControlKeyA
UntapHook
get_lang
PlayKeyControlKeyD
UntapHook
get_texts
PlayKeyControlKeyD
untapped
Give
PlayKeyControlKeyDelete
UpdateCard
GiveCard
PlayKeyControlKeyDelete
UpdatePanel
GiveCardSubmenu
PlayKeyControlKeyE
UpdateProductsPanel
GiveMoney
PlayKeyControlKeyF
UploadDeck
Group
PlayKeyControlKeyHome
User
GroupNumbers
PlayKeyControlKeyI
UserWithoutMode
- H - PlayKeyControlKeyL
user_has_cards
h
PlayKeyControlKeyMinus
- V -
hand
PlayKeyControlKeyP
ValidCardNumber
HandleMetaServer
PlayKeyControlKeyPlus
ValidMode
HandlePriceInput
PlayKeyControlKeyS
ValidUsername
HandMenu
PlayKeyControlKeyT
valueof
HandPos
PlayKeyControlKeyU
values
HashComments
PlayKeyControlKeyU
vardump
has_entry
PlayKeyDelete
Verb
has_text
PlayKeyEnd
VersionCompare
HaveList
PlayKeyEnter
- W -
have_list
PlayKeyHome
w
having_rarity
PlayKeyInsert
WaitMetaEvents
head
PlayMapMenu
WantList
HidePanel
PlayPoolMenu
want_list
HidePlaymat
PlaySideboardMenu
WatchActiveSetMenu
- I - PlaySideboardMenu
WatchCardMenu
Image
PlaySite
WatchCommandInplay
images
PlaySiteFromSelection
WatchCommandNewdeck
image_height
PlaySitesMenu
WatchCommandRd
image_pixel
PlaySitesMenu
WatchDeckMenu
image_width
PlaySorcery
WatchDeckSearchBoxMenu
ImportAdd
PlayTrainer
WatchDiscardPileMenu
ImportASCIIDeck
PlayTwilightPoolMenu
WatcherSay
ImportDeck
Plr2Con
WatchHandMenu
ImportDeckFormat
PoolSearchBoxMenuHook
WatchKeyControlKeyD
ImportDeckMenu
pop
WatchKeyControlKeyE
ImportDeckMenuEntry
Positions
WatchKeyControlKeyI
ImportErrorAdd
PressKey
WatchKeyControlKeyS
ImportGccgDeck
PriceDelta
WatchKeyControlKeyW
ImportReaderLineByLine
price_list
WatchKeyControlKeyX
index
print
WatchOpponentDeckMenu
InitDistributions
println
WatchOpponentDiscardPileMenu
InitDistributions
PrizeForDraw
WatchOpponentHandMenu
InitDistributions
PrizeForLoss
WeStartedGame
InitDistributions
PrizeForWin
wr
Initialize
PrizesMenu
write_file
Initialize
Produce
- _ -
InitializeConnection
ProduceBE_Booster
_EndGame
InitializeGame
ProduceBE_Starter
_InitializeGame
InitializeGame
ProduceBooster
_StartGame
InitializeGame
ProduceLE_Starter
(1138 functions)
InitializeGame
ProduceTW_Starter
 

Common client and server functions

def abs(x)
Category: Common client and server functions
File: common.include
Return absolute value of x.

def age(set)
Category: Common client and server functions
File: common.include
Workaround for binaries not having age().

def book_set_slot(set)
Category: Common client and server functions
File: common.include
Workaround for binaries not having booksetslot().

def CountCards(list of card numbers)
Category: Common client and server functions
File: common.include
Return list of pairs (card number,nmb.of card).

def DataPath(section)
Category: Common client and server functions
File: common.include
Return directory containing Gccg data for section.

def del(e, L)
Category: Common client and server functions
File: common.include
Remove one instance of element e from the list L and return remaining list.

def dist((x1, y1), (x2, y2))
Category: Common client and server functions
File: common.include
Compute the square of the distance between (x1,y1) and (x2,y2).

def GeneratePassword()
Category: Common client and server functions
File: common.include
Return randomly generated string.

def isreal(d)
Category: Common client and server functions
File: common.include
Return 1 if string d represents a real number.

def LegalityCheckDeck(deck)
Category: Common client and server functions
File: common.include
Return the list of rulesets to which deck mathces.

def LegalityCheckRule((rule name, parameters), deck part, list of cards)
Category: Common client and server functions
File: common.include
Evaluate one rule for the given deck part.