\game

Summary

Methods
Properties
Constants
__get()
__isset()
__dependencies()
__shortcuts()
__destruct()
__construct()
chartooltip()
get_game_settings()
get_char_unique_ids()
get_importers()
get_import_apikey()
get_importAuth()
get_apikeyfield_requiered_and_empty()
get_games()
get_versions()
get_authors()
game_name()
get_game()
type_exists()
icon_exists()
default_icons()
glang()
callFunc()
new_object()
get_available_langs()
get_class_color()
get()
get_primary_class()
get_primary_classes()
get_type_for_name()
get_name_for_type()
get_dep_classes()
get_roster_classes()
get_recruitment_classes()
get_assoc_classes()
get_admin_classdata()
get_id()
get_name()
decorate()
decorate_character()
gameVersion()
AddProfileFields()
load_default_roles()
load_default_classroles()
installGame()
resetEvents()
addEvent()
resetItempools()
addItempool()
addLink()
removeLink()
resetMultiDKPPools()
addMultiDKPPool()
updateDefaultMultiDKPPool()
resetRanks()
addRank()
resetRaidgroups()
addRaidgroup()
cronjob()
cronjobOptions()
admin_settings()
handle_export_charnames()
$dependencies
$shortcuts
$singleton
$class_hash
$import_apikey
$obj
$overwriteMode
No constants found
No protected methods found
$apiLevel
N/A
gameinfo()
init_gameclass()
decorate_classes()
decorate_races()
decorate_ranks()
decorate_talents()
decorate_events()
decorate_def_events()
decorate_roles()
decorate_def_roles()
decorate_generic()
load_class_color()
filter()
build_assoc_array()
autoUpdateClassProfileFields()
uninstallGame()
$_shorts
$_shorts_loaded
$_class_index
$data
$games
$class_colors
$objects
$game
$lang_name
$installer
$deficon_path
$blnClassUpdateChecked
N/A

Properties

$dependencies

$dependencies : 

Type

$shortcuts

$shortcuts : 

Type

$singleton

$singleton : 

Type

$class_hash

$class_hash : 

Type

$import_apikey

$import_apikey : 

Type

$obj

$obj : 

Type

$overwriteMode

$overwriteMode : 

Type

$apiLevel

$apiLevel : 

Type

$_shorts

$_shorts : 

Type

$_shorts_loaded

$_shorts_loaded : 

Type

$_class_index

$_class_index : 

Type

$data

$data : 

Type

$games

$games : 

Type

$class_colors

$class_colors : 

Type

$objects

$objects : 

Type

$game

$game : 

Type

$lang_name

$lang_name : 

Type

$installer

$installer : 

Type

$deficon_path

$deficon_path : 

Type

$blnClassUpdateChecked

$blnClassUpdateChecked : 

Type

Methods

__get()

__get(  $name) 

Parameters

$name

__isset()

__isset(  $name) 

Parameters

$name

__dependencies()

__dependencies() 

__shortcuts()

__shortcuts() 

__destruct()

__destruct() 

__construct()

__construct(  $installer = false,   $lang_name = '') 

Parameters

$installer
$lang_name

chartooltip()

chartooltip(integer  $intCharID) : string

Returns global Character Tooltip

Parameters

integer $intCharID

Returns

string

get_game_settings()

get_game_settings(  $value = false) 

Parameters

$value

get_char_unique_ids()

get_char_unique_ids() 

get unique ID settings of Game. If set, chars will be identified by charname AND the given Profilesettings

get_importers()

get_importers(integer  $filter, boolean  $file = false) : array

get available importers (p.e. wow armory)

Parameters

integer $filter
boolean $file

Returns

array

get_import_apikey()

get_import_apikey(  $key = false) 

Parameters

$key

get_importAuth()

get_importAuth(\str  $myperm, \str  $import) : boolean

Check the auth for importers

Parameters

\str $myperm
\str $import

Returns

boolean

get_apikeyfield_requiered_and_empty()

get_apikeyfield_requiered_and_empty() 

get_games()

get_games() : array

returns all available games

Returns

array

get_versions()

get_versions() 

returns an array containing versions of all games

get_authors()

get_authors() 

returns an array containing versions of all games

game_name()

game_name(  $tgame) : string

Parameters

$tgame

Returns

string —

full game-name

get_game()

get_game() : string

returns current game

Returns

string

type_exists()

type_exists(string  $type) : boolean

checks if the game has the given $type

Parameters

string $type

Returns

boolean

icon_exists()

icon_exists(string  $type) : boolean

checks if the game provides an icon for a given $type

Parameters

string $type

Returns

boolean

default_icons()

default_icons(string  $icon) : boolean

checks if there are default icons

Parameters

string $icon

Returns

boolean

glang()

glang(string  $var,   $return_key = false, string  $lang = false,   $exists = false) : string

Returns language var

Parameters

string $var
$return_key
string $lang
$exists

Returns

string

callFunc()

callFunc(  $function_name,   $params = array()) : mixed

calls a special function of the <game>.class.php

Parameters

$function_name
$params

Returns

mixed

new_object()

new_object(string  $classname,   $index, array  $params = NULL, boolean  $force_new = false, boolean  $overwrite_index = false) : false

creates an object, which is located in the games-folder

Parameters

string $classname
$index
array $params

arguments the class may want

boolean $force_new

force a new object if true, else return index

boolean $overwrite_index

Returns

false —

or index in obj-array

get_available_langs()

get_available_langs() : array

Returns available languages for current game

Returns

array

get_class_color()

get_class_color(integer  $class_id,   $style_id = false) : \hexcolorcode

Returns class_color_code

Parameters

integer $class_id
$style_id

Returns

\hexcolorcode

get()

get(string  $type,   $filter = array(), string  $lang = false) : array

Returns whole array (such as filters, realmlist)

Parameters

string $type
$filter
string $lang

Returns

array

get_primary_class()

get_primary_class(  $returnName = false) : string

Returns name or type for the primary class (necessary in e.g. calendar, role assignment)

Parameters

$returnName

Returns

string

get_primary_classes()

get_primary_classes(  $filter = array(),   $lang = false) : string

Returns selectable data (respecting e.g. faction selection of admin) for the primary class

Parameters

$filter
$lang

Returns

string

get_type_for_name()

get_type_for_name(string  $strName) : string

Returns the type for the name, e.g. "classes" for name "class"

Parameters

string $strName

Returns

string

get_name_for_type()

get_name_for_type(  $strType) : string

Returns the name for the type, e.g. "class" for name "classes"

Parameters

$strType

Returns

string

get_dep_classes()

get_dep_classes(  $parent,   $child,   $selection,   $filter = array(), string  $lang = false) : array

Returns an array with all possible dependent classes

Parameters

$parent
$child
$selection
$filter
string $lang

Returns

array

get_roster_classes()

get_roster_classes(  $filter = array(), string  $lang = false) : array

Returns the class-dependencies as an associative array for the roster

Parameters

$filter
string $lang

Returns

array

get_recruitment_classes()

get_recruitment_classes(  $filter = array(), string  $lang = false) : array

Returns the class-dependencies as an associative array for the recruitment module

Parameters

$filter
string $lang

Returns

array

get_assoc_classes()

get_assoc_classes(  $todisplay,   $filter = array(), string  $lang = false,   $blnWithAdminData = true) : array

Returns the class-dependencies as an associative array

Parameters

$todisplay
$filter
string $lang
$blnWithAdminData

Returns

array

get_admin_classdata()

get_admin_classdata(  $type_key = false) : array

Returns a data-array containing all admin-selected class stuff

Parameters

$type_key

Returns

array

get_id()

get_id(string  $type, string  $name, boolean  $searched = false) : integer

Returns ID of the Name of $type, while $type = classes, races, etc.

Parameters

string $type
string $name
boolean $searched

Returns

integer

get_name()

get_name(string  $type, integer  $id, string  $lang = false) : string

Returns Name of the ID of $type, while $type = classes, races, etc., in optional $lang

Parameters

string $type
integer $id
string $lang

Returns

string

decorate()

decorate(string  $type,   $id,   $profile = array(),   $size = 16,   $pathonly = false,   $allow_empty = true) : \html

Redirects to decoration functions, or falls back to simple name

Parameters

string $type
$id
$profile
$size
$pathonly
$allow_empty

Returns

\html

string

decorate_character()

decorate_character(integer  $char_id,   $size = 20) : \html

Creates all Icons of classes/subclasses to decorate a character

Parameters

integer $char_id
$size

Returns

\html

string

gameVersion()

gameVersion() 

Returns Version of current Game

AddProfileFields()

AddProfileFields() 

Add the profile fields for selected game

load_default_roles()

load_default_roles() 

initializes default-roles

load_default_classroles()

load_default_classroles() 

installGame()

installGame(string  $strGamename, string  $strGamelang, \number  $intOverwriteData = 1) 

Installs a game

Parameters

string $strGamename
string $strGamelang
\number $intOverwriteData

{0:write no data; 1: overwrite all data; 2: append data}

resetEvents()

resetEvents() 

Delets all events

addEvent()

addEvent(\unknown  $strName, \unknown  $intValue, \unknown  $strIcon) : boolean|mixed

Adds an Event

Parameters

\unknown $strName
\unknown $intValue
\unknown $strIcon

Returns

boolean|mixed

resetItempools()

resetItempools() 

Deletes all itempools execept the one with ID 1

addItempool()

addItempool(\unknown  $strName, \unknown  $strDescription) : boolean|mixed

Adds an Itempool

Parameters

\unknown $strName
\unknown $strDescription

Returns

boolean|mixed

addLink()

addLink(\unknown  $strName, \unknown  $strURL) : boolean|mixed

Adds a link

Parameters

\unknown $strName
\unknown $strURL

Returns

boolean|mixed

removeLink()

removeLink(\unknown  $strName) 

Removes a Link by given name

Parameters

\unknown $strName

resetMultiDKPPools()

resetMultiDKPPools() 

Deletes all MultiDKP Pools. Default one will be created on game install.

addMultiDKPPool()

addMultiDKPPool(\unknown  $strName, \unknown  $strDescription, \unknown  $arrEventIDs, \unknown  $arrItempoolIDs) : boolean|mixed

Adds a MultiDKP Pool

Parameters

\unknown $strName
\unknown $strDescription
\unknown $arrEventIDs
\unknown $arrItempoolIDs

Returns

boolean|mixed

updateDefaultMultiDKPPool()

updateDefaultMultiDKPPool(\unknown  $strName, \unknown  $strDescription, \unknown  $arrEventIDs) : boolean|mixed

Updates the default MultiDKP Pool

Parameters

\unknown $strName
\unknown $strDescription
\unknown $arrEventIDs

Returns

boolean|mixed

resetRanks()

resetRanks() 

Truncates all Ranks

addRank()

addRank(\unknown  $intID, \unknown  $strName, string  $blnDefault = false, string  $strIcon = '') : boolean|mixed

Adds a Rank

Parameters

\unknown $intID
\unknown $strName
string $blnDefault
string $strIcon

Returns

boolean|mixed

resetRaidgroups()

resetRaidgroups() 

Delete all Raidgroups except the Default Raidgroup with ID 1

addRaidgroup()

addRaidgroup(\unknown  $name, \unknown  $color, string  $desc = '', \number  $standard, \number  $sortid, \number  $system) : boolean|mixed

Adds a Raidgroup

Parameters

\unknown $name
\unknown $color
string $desc
\number $standard
\number $sortid
\number $system

Returns

boolean|mixed

cronjob()

cronjob(  $params) : string

Will be executed from the Game Cronjob

Parameters

$params

Returns

string

cronjobOptions()

cronjobOptions() : string

Options for the Game Cronjob

Returns

string

admin_settings()

admin_settings() : array

additional fields for admin-settings

Returns

array

handle_export_charnames()

handle_export_charnames(  $strCharname,   $intCharID) 

Parameters

$strCharname
$intCharID

gameinfo()

gameinfo() : object

Returns the gameobject

Returns

object

init_gameclass()

init_gameclass() : string

Init the game class

Returns

string

decorate_classes()

decorate_classes(integer  $class_id,   $profile = array(),   $size = 16, boolean  $pathonly = false) : \html

Returns per game ImageTag for classes

Parameters

integer $class_id
$profile
$size
boolean $pathonly

Returns

\html

string

decorate_races()

decorate_races(integer  $race_id,   $profile = array(),   $size = 16, boolean  $pathonly = false) : \html

Returns per game ImageTag for races

Parameters

integer $race_id
$profile
$size
boolean $pathonly

Returns

\html

string

decorate_ranks()

decorate_ranks(integer  $rank_id,   $profile = array(), integer  $size = 16, boolean  $pathonly = false) : \html

Returns per game ImageTag for ranks

Parameters

integer $rank_id
$profile
integer $size
boolean $pathonly

Returns

\html

string

decorate_talents()

decorate_talents(  $talent_id,   $profile = array(),   $size = 16, boolean  $pathonly = false) : \html

Returns per game ImageTag for talents

Parameters

$talent_id
$profile
$size
boolean $pathonly

Returns

\html

string

decorate_events()

decorate_events(  $event_id,   $profile = array(), boolean  $size = 20, boolean  $pathonly = false) : \html

Returns per game ImageTag for events

Parameters

$event_id
$profile
boolean $size
boolean $pathonly

Returns

\html

string

decorate_def_events()

decorate_def_events(  $event_id,   $profile = array(), boolean  $size = 20, boolean  $pathonly = false) : \html

Returns default ImageTag for events

Parameters

$event_id
$profile
boolean $size
boolean $pathonly

Returns

\html

string

decorate_roles()

decorate_roles(integer  $role_id,   $profile = array(), integer  $size = 20, boolean  $pathonly = false) : \html

Returns per game ImageTag for roles

Parameters

integer $role_id
$profile
integer $size
boolean $pathonly

Returns

\html

string

decorate_def_roles()

decorate_def_roles(integer  $role_id,   $profile = array(), integer  $size = 20, boolean  $pathonly = false) : \html

Returns default ImageTag for roles

Parameters

integer $role_id
$profile
integer $size
boolean $pathonly

Returns

\html

string

decorate_generic()

decorate_generic(  $type,   $id,   $profile = array(),   $size = 16, boolean  $pathonly = false) : \html

Returns image for generic type

Parameters

$type
$id
$profile
$size
boolean $pathonly

Returns

\html

string

load_class_color()

load_class_color(  $style_id = false) : array

Loads class_colors from database

Parameters

$style_id

Returns

array

filter()

filter(  $filters, string  $data) : array

Filter data

Parameters

$filters
string $data

Returns

array

build_assoc_array()

build_assoc_array(  $type,   $dep_order,   $child_ids,   $todisplay,   $filter = array(),   $lang = false,   $parent_id = false,   $admin_data = array()) 

Parameters

$type
$dep_order
$child_ids
$todisplay
$filter
$lang
$parent_id
$admin_data

autoUpdateClassProfileFields()

autoUpdateClassProfileFields() 

uninstallGame()

uninstallGame() 

Uninstalls recent game