This is a documentation for Board Game Arena: play board games online !
Студио фунцтион референце
Пређи на навигацију
Пређи на претрагу
Тхис паге референцес усефул сервер сиде анд цлиент сиде фунцтионс, со тхат нободy неедс то реинвент тхе wхеел (унлесс хе wантс то).
Сервер сиде (ПХП фунцтионс)
АПП_ГамеАцтион цласс (<гаменаме>.ацтион.пхп)
- фунцтион исАрг( $аргНаме )
- Ис тхис аргумент филлед ?
- фунцтион гетАрг( $аргНаме, $аргТyпе, $мандаторy=фалсе, $дефаулт=НУЛЛ, $аргТyпеДетаилс=арраy(), $бЦанФаил=фалсе )
- Гет сцрипт аргумент wитх тхе цоррецт тyпе
- бЦанФаил меанс тхан а валидатион фаилуре ис поссибле (усер инпут)
- Тхе маин аргТyпе валуес аре ас фоллоwс.
define( 'AT_int', 0 ); // an integer define( 'AT_posint', 1 ); // a positive integer define( 'AT_float', 2 ); // a float define( 'AT_email', 3 ); // an email define( 'AT_url', 4 ); // a URL define( 'AT_bool', 5 ); // 1/0/true/false define( 'AT_enum', 6 ); // argTypeDetails list the possible values define( 'AT_alphanum', 7 ); // only 0-9a-zA-Z_ and space
Табле цласс (<гаменаме>.гаме.пхп)
- фунцтион _( $теxт )
- Транспарент фунцтион, усед то марк стрингс то бе транслатед он тхе сервер сиде (еx: еррор мессаге)
- фунцтион цлиенттранслате( $стринг )
- Транспарент фунцтион: усед то марк стринг то бе транслатед он цлиент сиде (еx: нотифицатион мессаге)
- фунцтион гетПлаyерсНумбер()
- Ретурнс тхе нумбер оф плаyерс плаyинг ат тхе табле
- фунцтион цхецкАцтион( $ацтионНаме, $бТхроwЕxцептион=труе )
- Цхецк иф ацтион ис валид регардинг цуррент гаме стате (еxцептион иф фаилс)
- иф "бТхроwЕxцептион" ис сет то "фалсе", тхе фунцтион ретурн фалсе ин цасе оф фаилуре инстеад оф тхроwинг анд еxцептион
- фунцтион гетАцтивеПлаyерИд()
- Гет тхе "ацтиве_плаyер", wхатевер wхат ис тхе цуррент стате тyпе
- Ноте: ит доес НОТ меан тхат тхис плаyер ис ацтиве ригхт ноw, бецаусе стате тyпе цоулд бе "гаме" ор "мултиплаyер"
- фунцтион гетАцтивеПлаyерНаме()
- Гет тхе "ацтиве_плаyер" наме
- фунцтион гетЦуррентПлаyерИд()
- Гет тхе "цуррент_плаyер". Тхе цуррент плаyер ис тхе оне фром wхицх тхе ацтион оригинатед. Ит ис нот алwаyс тхе ацтиве плаyер.
- фунцтион гетЦуррентПлаyерНаме()
- Гет тхе "цуррент_плаyер" наме
- фунцтион гетЦуррентПлаyерЦолор()
- Гет тхе "цуррент_плаyер" цолор
- фунцтион исЦуррентПлаyерЗомбие()
- Цхецк тхе "цуррент_плаyер" зомбие статус
- фунцтион ацтивеНеxтПлаyер()
- Маке тхе неxт плаyер ацтиве
- фунцтион ацтивеПревПлаyер()
- Маке тхе превиоус плаyер ацтиве
- фунцтион гивеЕxтраТиме( $плаyер_ид, $специфиц_тиме=нулл )
- Гиве стандард еxтра тиме то тхис плаyер (стандард еxтра тиме ис а гаме оптион)
- фунцтион инитСтат( $табле_ор_плаyер, $наме, $валуе, $плаyер_ид=нулл )
- Цреате а статистиц ентрy фор тхе специфиед статистицс wитх а дефаулт валуе
- Ин цасе оф а "плаyер" ентрy, иф плаyер_ид ис нот специфиед, алл плаyерс аре сет то тхе саме валуе
- фунцтион сетСтат( $валуе, $наме, $плаyер_ид = нулл )
- Сет статистиц валуе
- фунцтион инцСтат( $делта, $наме, $плаyер_ид = нулл )
- Инцремент (ор децремент) специфиед валуе
- фунцтион ДбQуерy( $сqл )
- Еxецутес сqл qуерy он тхе датабасе
- фунцтион гетЦоллецтионФромДБ( $сqл, $бСинглеВалуе=фалсе )
- Ретурнс ан ассоциативе арраy оф роwс фор тхе сqл qуерy. Фирст цолумн муст бе а примарy ор алтернате кеy. Тхе ресултинг цоллецтион цан бе емптy.
- протецтед фунцтион гетНонЕмптyЦоллецтионФромДБ( $сqл )
- Идем, бут раисе ан еxцептион иф тхе цоллецтион ис емптy
- фунцтион гетУниqуеВалуеФромДБ( $сqл )
- Ретурнс а униqуе валуе фром ДБ ор нулл иф но валуе ис фоунд
- Раисе ан еxцептион иф море тхан 1 роw ис ретурнед
- фунцтион гетОбјецтФромДБ( $сqл )
- Ретурнс оне роw фор тхе сqл qуерy ас ан ассоциативе арраy ор нулл иф тхере ис но ресулт
- Раисе ан еxцептион иф тхе qуерy ретурн море тхан оне роw
- фунцтион гетНонЕмптyОбјецтФромДБ( $сqл )
- Идем, бут раисе ан еxцептион иф тхе qуерy доесн'т ретурн еxацтлy оне роw
Еxцептионс yоу цан тхроw
- тхроw неw БгаУсерЕxцептион ( $еррор_мессаге)
- Басе цласс то нотифy а усер еррор
- тхроw неw БгаСyстемЕxцептион ( $еррор_мессаге)
- Басе цласс то нотифy а сyстем еxцептион. Тхе мессаге wилл бе хидден фром тхе усер, бут схоw ин тхе логс. Усе тхис иф тхе мессаге цонтаинс тецхницал информатион.
- тхроw неw БгаСyстемВисиблеЕxцептион ( $еррор_мессаге)
- Саме ас превиоус, еxцепт тхат тхе мессаге ис висибле бy тхе усер. Yоу цан усе тхис иф тхе мессаге ис ундерстандабле бy тхе усер.
Цлиент сиде (Јавасцрипт фунцтионс)
- тодо
- тодо