API Documentation
\
ESLKem
GBXParser
Models

\ESLKem\GBXParser\ModelsMap

The Map class derived from GBX parent and representing the Map/Track type.

@author Aleksas Legačinskas

Summary

Methods
Properties
Constants
__construct()
getVersion()
getSoftwareVersion()
getUid()
getEnvironment()
getAuthor()
getAuthorName()
getAuthorZone()
getName()
getMode()
getMood()
getDecoration()
getDecorationAuthor()
getLightmapCacheUID()
getLightmapVersion()
getTitlePack()
getBronzeTime()
getSilverTime()
getGoldTime()
getAuthorTime()
getDisplayCost()
getMultilap()
getmapType()
getAuthorScore()
getSimpleEditor()
getContainsGhostBlocks()
getCheckpoints()
getLaps()
getThumbnail()
getComments()
getDependencies()
getMod()
getPasswordProtected()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$version
$softwareVersion
$uid
$environment
$author
$authorName
$authorZone
$name
$mode
$mood
$decoration
$decorationAuthor
$lightmapCacheUID
$lightmapVersion
$titlePack
$bronzeTime
$silverTime
$goldTime
$authorTime
$displayCost
$multilap
$mapType
$authorScore
$simpleEditor
$containsGhostBlocks
$checkpoints
$laps
$thumbnail
$comments
$dependencies
$mod
$passwordProtected
N/A

Properties

$version

$version : integer

Type

integer — The version of the GBX format

$softwareVersion

$softwareVersion : string

Type

string — The software version which was used to create the file

$uid

$uid : string

Type

string — The unique id for the map object

$author

$author : string

Type

string — The author login of the map

$authorName

$authorName : string

Type

string — The author (nick)name of the map

$authorZone

$authorZone : string

Type

string — The zone of the author in the form (World|[Continent]|[Country]|[Optional-Regions...])

$name

$name : string

Type

string — The name of the map

$decorationAuthor

$decorationAuthor : string

Type

string — The author, who made the decoration of the map (usually Nadeo)

$lightmapCacheUID

$lightmapCacheUID : integer

Type

integer — The unique id used for identifying lightmaps in the cache

$lightmapVersion

$lightmapVersion : integer

Type

integer — The version of the lightmap

$titlePack

$titlePack : string

Type

string — Optional titlepack used in making the map

$bronzeTime

$bronzeTime : integer

Type

integer — The bronze medal time in miliseconds

$silverTime

$silverTime : integer

Type

integer — The silver medal time in miliseconds

$goldTime

$goldTime : integer

Type

integer — The gold medal time in miliseconds

$authorTime

$authorTime : integer

Type

integer — The author medal time in miliseconds

$displayCost

$displayCost : integer

Type

integer — The display cost (earlier - CCs or coppers) of the map

$multilap

$multilap : boolean

Type

boolean — Is the map multilap

$authorScore

$authorScore : integer

Type

integer — The author score of the map, usually matches $authorTime

$simpleEditor

$simpleEditor : boolean

Type

boolean — Was simple editor used in the making of the map

$containsGhostBlocks

$containsGhostBlocks : boolean

Type

boolean — Are ghost blocks present in the map

$checkpoints

$checkpoints : integer

Type

integer — The number of checkopoints in the map

$laps

$laps : integer

Type

integer — The number of laps to complete to finish the map in non-timeattack modes

$thumbnail

$thumbnail : \Intervention\Image\Image

Type

\Intervention\Image\Image — The Image object representing the thumbnail of the map

$comments

$comments : string

Type

string — The author comments for the map

$dependencies

$dependencies : array

Type

array — The dependency array containing names/links for the external items

$mod

$mod : string

Type

string — The optional mod name used in making of the map

$passwordProtected

$passwordProtected : boolean

Type

boolean — Is the map password-protected

Methods

__construct()

__construct(integer  $version, array  $properties)

Constructor method

Parameters

integer $version

The version of the GBX file
array $properties

Associative array for the map properties. The keys must match object property names

getVersion()

getVersion() : integer

Version getter method

Returns

integer —

The GBX version property

getSoftwareVersion()

getSoftwareVersion() : string

SoftwareVersion getter method

Returns

string —

The software version property

getUid()

getUid() : string

Uid getter method

Returns

string —

The uid property

getAuthor()

getAuthor() : string

Author getter method

Returns

string —

The author property

getAuthorName()

getAuthorName() : string

AuthorName getter method

Returns

string —

The authorName property

getAuthorZone()

getAuthorZone() : string

AuthorZone getter method

Returns

string —

The authorZone property

getName()

getName() : string

Name getter method

Returns

string —

The name property

getDecorationAuthor()

getDecorationAuthor() : string

DecorationAuthor getter method

Returns

string —

The decorationAuthor property

getLightmapCacheUID()

getLightmapCacheUID() : integer

LightmapCacheUID getter method

Returns

integer —

The lightmapCacheUID property

getLightmapVersion()

getLightmapVersion() : integer

LightmapVersion getter method

Returns

integer —

The lightmapVersion property

getTitlePack()

getTitlePack() : string

TitlePack getter method

Returns

string —

The titlePack property

getBronzeTime()

getBronzeTime() : integer

BronzeTime getter method

Returns

integer —

The bronzeTime property

getSilverTime()

getSilverTime() : integer

SilverTime getter method

Returns

integer —

The silverTime property

getGoldTime()

getGoldTime() : integer

GoldTime getter method

Returns

integer —

The goldTime property

getAuthorTime()

getAuthorTime() : integer

AuthorTime getter method

Returns

integer —

The authorTime property

getDisplayCost()

getDisplayCost() : integer

DisplayCost getter method

Returns

integer —

The displayCost property

getMultilap()

getMultilap() : boolean

Multilap getter method

Returns

boolean —

The multilap property

getAuthorScore()

getAuthorScore() : integer

AuthorScore getter method

Returns

integer —

The authorScore property

getSimpleEditor()

getSimpleEditor() : boolean

SimpleEditor getter method

Returns

boolean —

The simpleEditor property

getContainsGhostBlocks()

getContainsGhostBlocks() : boolean

ContainsGhostBlocks getter method

Returns

boolean —

The containsGhostBlocks property

getCheckpoints()

getCheckpoints() : integer

Checkpoints getter method

Returns

integer —

The checkpoints property

getLaps()

getLaps() : integer

Laps getter method

Returns

integer —

The laps property

getThumbnail()

getThumbnail() : \Intervention\Image\Image

Thumbnail getter method

Returns

\Intervention\Image\Image —

The thumbnail property

getComments()

getComments() : string

Comments getter method

Returns

string —

The comments property

getDependencies()

getDependencies() : array

Dependencies getter method

Returns

array —

The dependencies property

getMod()

getMod() : string

Mod getter method

Returns

string —

The mod property

getPasswordProtected()

getPasswordProtected() : boolean

PasswordProtected getter method

Returns

boolean —

The passwordProtected property