ManiaLib 1.0b1 API Reference

Class Navigation

Description
Description | Vars (details) | Methods (details) Constants (details)

Navigation menu

Looks like the navigation menu on the left in the game menus

Located in /gui-toolkit/cards/Navigation.class.php (line 19) 

GuiComponent
   |
   --GuiElement
      |
      --Quad
         |
         --Navigation
Class Constant Summary
Description | Constants (details) Vars (details) | | Methods (details)
BUTTONS_BOTTOM = false
BUTTONS_TOP = true
Variable Summary
Description | Vars (details) | Methods (details) Constants (details)
NavigationButton $lastItem
Quad $logo
NavigationButton $quitButton
Label $subTitle
Label $title
Quad $titleBg
Method Summary
Description | Constants (details) Vars (details) | Methods (details)
Navigation __construct ()
void addGap ([float $gap = 3])
void addItem ([ $topItem = self::BUTTONS_TOP])
void hideQuitButton ()
NavigationButton lastItem ()
Variables
Description | Vars (details) Constants (details) | Methods (details)
NavigationButton $lastItem (line 47)
  • access: public
Quad $logo (line 39)
  • access: public
NavigationButton $quitButton (line 43)
  • access: public
Label $subTitle (line 31)
  • access: public
Label $title (line 27)
  • access: public
Quad $titleBg (line 35)
  • access: public
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 61)
Navigation __construct ()
Redefinition of:
GuiElement::__construct()
Manialink element default constructor. It's common to specify the size of the element in the constructor.
addGap (line 115)

Adds a vertical gap before the next item

void addGap ([float $gap = 3])
  • float $gap
addItem (line 90)

Adds a navigation button to the menu

void addItem ([ $topItem = self::BUTTONS_TOP])
  • $topItem
hideQuitButton (line 124)

Hides the quit/back button

void hideQuitButton ()
lastItem (line 106)

Return a reference of the last added item

  • return: Reference on a NavigationButton object
  • deprecated: use self::$lastItem instead (better performance)
NavigationButton lastItem ()

Inherited Methods

Inherited From GuiElement

GuiElement::__construct()
GuiElement::addLink()
GuiElement::addPlayerId()
GuiElement::getAction()
GuiElement::getActionKey()
GuiElement::getAddPlayerId()
GuiElement::getBgcolor()
GuiElement::getHalign()
GuiElement::getImage()
GuiElement::getImageFocus()
GuiElement::getImageFocusid()
GuiElement::getImageid()
GuiElement::getManialink()
GuiElement::getManiazone()
GuiElement::getStyle()
GuiElement::getSubStyle()
GuiElement::getUrl()
GuiElement::getValign()
GuiElement::hasLink()
GuiElement::save()
GuiElement::setAction()
GuiElement::setActionKey()
GuiElement::setAlign()
GuiElement::setBgcolor()
GuiElement::setHalign()
GuiElement::setImage()
GuiElement::setImageFocus()
GuiElement::setImageFocusid()
GuiElement::setImageid()
GuiElement::setManialink()
GuiElement::setManiazone()
GuiElement::setStyle()
GuiElement::setSubStyle()
GuiElement::setUrl()
GuiElement::setValign()

Inherited From GuiComponent

GuiComponent::getPosX()
GuiComponent::getPosY()
GuiComponent::getPosZ()
GuiComponent::getScale()
GuiComponent::getSizeX()
GuiComponent::getSizeY()
GuiComponent::setPosition()
GuiComponent::setPositionX()
GuiComponent::setPositionY()
GuiComponent::setPositionZ()
GuiComponent::setScale()
GuiComponent::setSize()
GuiComponent::setSizeX()
GuiComponent::setSizeY()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)
BUTTONS_BOTTOM = false (line 22)
BUTTONS_TOP = true (line 21)

Inherited Constants

Inherited from Quad

Quad::BgRaceScore2
 Quad::Bgs1
 Quad::Bgs1InRace
 Quad::BgsChallengeMedals
 Quad::BgsPlayerCard
 Quad::Icons64x64_1
 Quad::Icons128x32_1
 Quad::Icons128x128_1
 Quad::MedalsBig

Inherited from GuiElement

GuiElement::USE_ABSOLUTE_URL