Menu.cs

API

Class Description

author: Elm

description - Menu Class
This class is used to present a user with an interface
they can interact with, without installing client sided files.
This class utilizes the centerprint to achieve this.
All menus should be created in /Menus/menu_menuName.cs

classes: menuSystem & menuObject

Method 1

menuSystem::newMenuObject(%this,%name,%bodyTxt)

Notes: creates a new menu.

Method 2

menuSystem::getMenu(%this,%name)

Notes: attempts to get an existing menu from the menuSystem group

Method 3

menuObject::getSelected(%this,%client)

Notes: gets the current selection in the menu

Method 4

menuObject::getMenuItemByText(%this,%text)

Notes: returns the actual menu item object by it's text value

Method 5

menuObject::onMenuSelect(%this,%client)

Notes: called when a user selects a menu item

Method 6

menuObject::onMenuSelectCallBack(%this,%client,%selected)

Notes: empty callback

Method 7

menuObject::scrollDown(%this,%client)

Notes: scrolls down the interface list

Method 8

menuObject::scrollUp(%this,%client)

Notes: scrolls up the interface list

Method 9

menuObject::setTempBody(%this,%body)

Notes: all menuObjects have static body text defined in the /Menus/menu_menuName.cs file This method allows you to change that text

Method 10

menuObject::setDefaultBody(%this)

Notes: sets the body text of the menu interface back to whatever it was initially set to when created in the /Menus/menu_menuName.cs file

Method 11

menuObject::showInputMenu(%this,%client)

Notes: if the object is an input menu, it will be displayed

Method 12

menuObject::hideInputMenu(%this,%client)

Notes: hides a currently displayed input menu

Method 13

menuObject::onInputValueRecieved(%this,%client,%value)

Notes: callback for when a user gives the server input, from the input menu

Method 14

menuObject::showMenu(%this,%client,%indexHighlight)

Notes: attempts to show a menu

Method 15

menuObject::hideMenu(%this,%client)

Notes: attempts to hide a menu, if visible

Method 16

menuObject::addMenuItem(%this,%text,%evalText)

Notes: adds an item into the menu that is selectable and scrollable

Method 17

menuObject::isMenu(%this,%name)

Notes: simple menu check

Method 18

menuObject::getMenu(%this,%name)

Notes: attempts to return a menu object, by name

Method 19

serverCmdMessageSent(%client,%message)

Notes: Packaged overwrite - input menu support

Method 20

menuObject::onInputValueRecieved(%this,%client,%value)

Notes: Packaged Example on displaying menus based on certain things being clicked by a user

Method 21

servercmdsupershiftbrick(%client,%x,%y,%z)

Notes: menu support for scrolling

Method 22

servercmdshiftbrick(%client,%x,%y,%z)

Notes: menu support for scrolling

Method 23

serverCmdPlantBrick(%client,%a,%b,%c,%d)

Notes: menu support for selecting an item, in a menu

Method 24

serverCmdCancelBrick(%this,%a,%b,%c,%d,%e)

Notes: support for closing a menu, if visible