ISTickBox Class Reference

Inheritance diagram for ISTickBox:

Public Member Functions
void	initialise ()
void	prerender ()
void	setJoypadFocused (boolean focused)
void	onJoypadDirUp (JoypadData joypadData)
void	onJoypadDirDown (JoypadData joypadData)
void	forceClick ()
void	setSelected (integer index, boolean selected)
boolean	isSelected (integer index)
void	render ()
void	getTextColor (integer index, table color)
boolean	onMouseUp (number x, number y)
void	onMouseUpOutside (number x, number y)
boolean	onMouseDown (number x, number y)
void	onMouseMove (number dx, number dy)
void	onMouseMoveOutside (number dx, number dy)
void	disableOption (string name, boolean disable)
void	clearOptions ()
integer	addOption (string name, unknown data, Texture texture)
integer	getOptionCount ()
unknown	getOptionData (integer index)
void	setFont (UIFont font)
void	setWidthToFit ()
	ISTickBox (number x, number y, number width, number height, string name, unknown changeOptionTarget, umbrella::ISTickBox::OnChange changeOptionMethod, unknown changeOptionArg1, unknown changeOptionArg2)
Public Member Functions inherited from ISPanel
void	initialise ()
void	noBackground ()
void	close ()
void	prerender ()
void	onMouseUp (number x, number y)
void	onMouseUpOutside (number x, number y)
boolean	onMouseDown (number x, number y)
void	onMouseMoveOutside (number dx, number dy)
void	onMouseMove (number dx, number dy)
	ISPanel (number x, number y, number width, number height)
Public Member Functions inherited from ISUIElement
void	initialise ()
void	setController (integer c)
integer	getController ()
void	setAnchorBottom (boolean bAnchor)
void	setAnchorTop (boolean bAnchor)
void	setAnchorLeft (boolean bAnchor)
void	setAnchorRight (boolean bAnchor)
void	setAnchorsTBLR (boolean bAnchorT, boolean bAnchorB, boolean bAnchorL, boolean bAnchorR)
void	setAnchors (boolean bAnchor)
boolean	getKeepOnScreen ()
void	setX (number x)
void	setY (number y)
void	setWidth (number w)
void	setHeight (number h)
number	getWidth ()
number	getHeight ()
number	getRight ()
number	getBottom ()
number	getXScroll ()
void	setWidthAndParentWidth (number wi)
void	setHeightAndParentHeight (number h)
number	getYScroll ()
number	getMouseX ()
number	getMouseY ()
number	getCentreX ()
number	getCentreY ()
number	getX ()
number	getY ()
boolean	isEnabled ()
void	setEnabled (boolean en)
number	getAbsoluteX ()
boolean	isMouseOver ()
boolean	isPointOver (number screenX, number screenY)
void	suspendStencil ()
void	resumeStencil ()
void	setStencilRect (number x, number y, number w, number h)
void	clearStencilRect ()
void	repaintStencilRect (number x, number y, number w, number h)
number	clampStencilRectToParent (number x, number y, number w, number h)
void	ignoreWidthChange ()
number	getMaxDrawHeight ()
void	setMaxDrawHeight (number height)
void	clearMaxDrawHeight ()
void	ignoreHeightChange ()
number	getAbsoluteY ()
void	recalcSize ()
void	onResize ()
void	setCapture (boolean bCapture)
boolean	getIsCaptured ()
void	setFollowGameWorld (boolean bFollow)
boolean	getIsFollowGameWorld ()
boolean	isFollowGameWorld ()
void	setRenderThisPlayerOnly (integer playerNum)
integer	getRenderThisPlayerOnly ()
void	onLoseJoypadFocus (JoypadData joypadData)
void	onGainJoypadFocus (JoypadData joypadData)
void	setJoypadFocused (boolean focused, JoypadData joypadData)
void	setVisible (boolean bVisible)
UIElement	getJavaObject ()
boolean	getIsVisible ()
boolean	isVisible ()
boolean	isReallyVisible ()
void	onJoypadDown (integer button, JoypadData joypadData)
void	onJoypadButtonReleased (integer button, JoypadData joypadData)
void	onJoypadDirUp (JoypadData joypadData)
void	onJoypadDirDown (JoypadData joypadData)
void	onJoypadDirLeft (JoypadData joypadData)
void	onJoypadDirRight (JoypadData joypadData)
void	onJoypadButtonReleased_Descendant (ISUIElement descendant, integer button, JoypadData joypadData)
void	onJoypadDown_Descendant (ISUIElement descendant, integer button, JoypadData joypadData)
void	onJoypadDirUp_Descendant (ISUIElement descendant, JoypadData joypadData)
void	onJoypadDirDown_Descendant (ISUIElement descendant, JoypadData joypadData)
void	onJoypadDirLeft_Descendant (ISUIElement descendant, JoypadData joypadData)
void	onJoypadDirRight_Descendant (ISUIElement descendant, JoypadData joypadData)
void	onJoypadBeforeDeactivate (JoypadData joypadData)
void	onJoypadBeforeDeactivate_Descendant (ISUIElement descendant, JoypadData joypadData)
boolean	hasConflictWithJoypadNavigateStart ()
number	getJoypadNavigateStartDelay ()
void	onJoypadNavigateStart (JoypadData joypadData)
void	onJoypadNavigateEnd (JoypadData joypadData)
void	onJoypadNavigateUp (JoypadData joypadData)
void	onJoypadNavigateDown (JoypadData joypadData)
void	onJoypadNavigateLeft (JoypadData joypadData)
void	onJoypadNavigateRight (JoypadData joypadData)
void	onJoypadNavigateParent (JoypadData joypadData)
void	onJoypadNavigateStart_Descendant (ISUIElement descendant, JoypadData joypadData)
void	renderJoypadFocus (number x, number y, number w, number h)
void	renderJoypadNavigateOverlay (integer playerNum)
void	renderJoypadNavigateHighlight (JoypadData joypadData, ISUIElement child)
void	renderJoypadNavigateTexture (JoypadData joypadData, ISUIElement child, Texture texture)
void	instantiate ()
void	createChildren ()
void	drawTextureAllPoint (Texture texture, number tlx, number tly, number trx, number try, number brx, number bry, number blx, number bly, number r, number g, number b, number a)
void	StartOutline (Texture tex, number outlineThickness, number r, number g, number b, number a)
void	EndOutline ()
void	drawTextureScaled (Texture texture, number x, number y, number w, number h, number a, number r, number g, number b)
void	drawTextureScaledUniform (Texture texture, number x, number y, nil scale, number a, number r, number g, number b)
void	drawTextureScaledAspect (Texture texture, number x, number y, number w, number h, number a, number r, number g, number b)
void	drawTextureScaledAspect2 (Texture texture, number x, number y, number w, number h, number a, number r, number g, number b)
void	drawTextureScaledAspect3 (Texture texture, number x, number y, number w, number h, number a, number r, number g, number b)
void	drawTexture (Texture texture, number x, number y, number a, number r, number g, number b)
void	drawTextureTiled (Texture texture, number x, number y, number w, number h, number r, number g, number b, number a)
void	drawTextureTiledX (Texture texture, number x, number y, number w, number h, number r, number g, number b, number a)
void	drawTextureTiledY (Texture texture, number x, number y, number w, number h, number r, number g, number b, number a)
void	drawTextureTiledYOffset (Texture texture, number x, number y, number w, number h, number r, number g, number b, number a)
void	DrawTextureAngle (Texture tex, number centerX, number centerY, number angle)
void	drawTextureScaledStatic (Texture texture, number x, number y, number w, number h, number a, number r, number g, number b)
void	drawTextureStatic (Texture texture, number x, number y, number a, number r, number g, number b)
void	drawItemIcon (InventoryItem item, number x, number y, number a, number w, number h)
void	drawScriptItemIcon (Item scriptItem, number x, number y, number a, number w, number h)
void	drawRect (number x, number y, number w, number h, number a, number r, number g, number b)
void	drawRectStatic (number x, number y, number w, number h, number a, number r, number g, number b)
void	drawRectBorderStatic (number x, number y, number w, number h, number a, number r, number g, number b)
void	drawRectBorder (number x, number y, number w, number h, number a, number r, number g, number b)
void	drawLine2 (number x, number y, number x2, number y2, number a, number r, number g, number b)
void	drawTextZoomed (string str, number x, number y, number zoom, number r, number g, number b, number a, UIFont font)
void	drawTextUntrimmed (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	drawTextCentre (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	drawText (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	drawTextRight (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	setAlwaysOnTop (boolean b)
void	drawTextStatic (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	drawTextCentreStatic (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	drawTextRightStatic (string str, number x, number y, number r, number g, number b, number a, UIFont font)
void	addToUIManager ()
void	removeFromUIManager ()
void	backMost ()
void	addScrollBars (boolean addHorizontal)
boolean	isVScrollBarVisible ()
ISUIElement	getParent ()
table< integer, ISUIElement >	getChildren ()
void	addChild (ISUIElement otherElement)
void	removeChild (ISUIElement otherElement)
void	clearChildren ()
boolean	onMouseWheel (number del)
void	onMouseUp (number x, number y)
void	setOnMouseDoubleClick (unknown target, umbrella::ISUIElement::MouseDoubleClick onmousedblclick)
void	onRightMouseUpOutside (number x, number y)
void	onRightMouseDownOutside (number x, number y)
void	onMouseUpOutside (number x, number y)
void	onMouseDownOutside (number x, number y)
void	onFocus (number x, number y)
void	bringToTop ()
void	onRightMouseUp (number x, number y)
void	onRightMouseDown (number x, number y)
void	onMouseMove (number dx, number dy)
void	onMouseMoveOutside (number dx, number dy)
boolean	containsPoint (number x, number y)
boolean	containsPointLocal (number x, number y)
void	shrinkY (number y)
void	shrinkX (number x)
void	update ()
void	prerender ()
void	render ()
void	setScrollWidth (number w)
void	setScrollHeight (number h)
number	getScrollWidth ()
number	getScrollHeight ()
void	setScrollChildren (boolean b)
boolean	getScrollChildren ()
void	setScrollWithParent (boolean b)
boolean	getScrollWithParent ()
void	setYScroll (number y)
void	updateScrollbars ()
void	setXScroll (number x)
number	getScrollAreaWidth ()
number	getScrollAreaHeight ()
ISCollapsableWindow	wrapInCollapsableWindow (string title, boolean resizable, ISCollapsableWindow subClass)
boolean	isRemoved ()
void	setRemoved (boolean bremove)
void	setUIName (string name)
string	getUIName (string name)
string	toString ()
void	drawProgressBar (number x, number y, number w, number h, number f, umbrella::RGBA fg)
void	stayOnSplitScreen (integer playerNum)
void	setWantKeyEvents (boolean want)
void	setWantExtraMouseEvents (boolean want)
void	setForceCursorVisible (boolean force)
void	shrinkWrap (number padRight, number padBottom, umbrella::ISUIElement::ShrinkWrapPredicate predicate)
void	centerOnScreen (integer playerNum)
	ISUIElement (number x, number y, number width, number height)
Public Member Functions inherited from ISBaseObject
void	initialise ()
ISBaseObject	derive (string type)
void	addEventListener (string _event, function _callback, unknown _target)
void	removeEventListener (string _event, function _callback)
void	triggerEvent (string _event, unknown ...)
void	clearEventListeners ()
	ISBaseObject ()

Public Attributes
integer	joypadIndex
table< integer, boolean >	selected
umbrella::RGBA	_textColor
ISToolTip	tooltipUI
integer	clickedOption
integer	mouseOverOption
table< string, boolean >	disabledOptions
string[]	options
table< integer, string >	optionsIndex
table< integer, Texture >	textures
table< integer, unknown >	optionData
integer	optionCount
UIFont	font
number	fontHgt
Texture	tickTexture
umbrella::RGBA	choicesColor
string	name
number	leftMargin
number	boxSize
number	textGap
number	itemGap
number	itemHgt
boolean	isTickBox
string	tooltip
umbrella::ISTickBox::OnChange	changeOptionMethod
unknown	changeOptionTarget
table	changeOptionArgs
boolean	enable
Public Attributes inherited from ISPanel
boolean	background
boolean	moving
number	downX
number	downY
boolean	mouseOver
umbrella::RGBA	backgroundColor
umbrella::RGBA	borderColor
boolean	moveWithMouse
Public Attributes inherited from ISUIElement
table< integer, ISUIElement >	children
integer	ID
integer	controller
boolean	anchorBottom
boolean	anchorTop
boolean	anchorLeft
boolean	anchorRight
number	x
number	y
number	width
number	height
boolean	enabled
number	minimumWidth
number	minimumHeight
boolean	joypadFocused
UIElement	javaObject
boolean	removed
ISScrollBar	vscroll
ISScrollBar	hscroll
umbrella::ISUIElement::MouseDoubleClick	onMouseDoubleClick
unknown	target
number	scrollwidth
boolean	wantKeyEvents
boolean	wantExtraMouseEvents
boolean	forceCursorVisible
string	dock
string	internal
ISUIElement	parent
Public Attributes inherited from ISBaseObject
string	Type
table< string, table< function, unknown > >	__eventListeners

Constructor & Destructor Documentation

ISTickBox()

ISTickBox::ISTickBox	(	number	x,
		number	y,
		number	width,
		number	height,
		string	name,
		unknown	changeOptionTarget,
		umbrella::ISTickBox::OnChange	changeOptionMethod,
		unknown	changeOptionArg1,
		unknown	changeOptionArg2 )

Member Function Documentation

addOption()

integer ISTickBox::addOption	(	string	name,
		unknown	data,
		Texture	texture )

clearOptions()

void ISTickBox::clearOptions

(

)

disableOption()

void ISTickBox::disableOption	(	string	name,
		boolean	disable )

forceClick()

void ISTickBox::forceClick

(

)

getOptionCount()

integer ISTickBox::getOptionCount

(

)

getOptionData()

unknown ISTickBox::getOptionData

(

integer

index

)

getTextColor()

void ISTickBox::getTextColor	(	integer	index,
		table	color )

initialise()

void ISTickBox::initialise

(

)

isSelected()

boolean ISTickBox::isSelected

(

integer

index

)

onJoypadDirDown()

void ISTickBox::onJoypadDirDown

(

JoypadData

joypadData

)

onJoypadDirUp()

void ISTickBox::onJoypadDirUp

(

JoypadData

joypadData

)

onMouseDown()

boolean ISTickBox::onMouseDown	(	number	x,
		number	y )

onMouseMove()

void ISTickBox::onMouseMove	(	number	dx,
		number	dy )

onMouseMoveOutside()

void ISTickBox::onMouseMoveOutside	(	number	dx,
		number	dy )

onMouseUp()

boolean ISTickBox::onMouseUp	(	number	x,
		number	y )

onMouseUpOutside()

void ISTickBox::onMouseUpOutside	(	number	x,
		number	y )

prerender()

void ISTickBox::prerender

(

)

render()

void ISTickBox::render

(

)

setFont()

void ISTickBox::setFont

(

UIFont

font

)

setJoypadFocused()

void ISTickBox::setJoypadFocused

(

boolean

focused

)

setSelected()

void ISTickBox::setSelected	(	integer	index,
		boolean	selected )

setWidthToFit()

void ISTickBox::setWidthToFit

(

)

Member Data Documentation

_textColor

umbrella::RGBA ISTickBox::_textColor

boxSize

number ISTickBox::boxSize

changeOptionArgs

table ISTickBox::changeOptionArgs

changeOptionMethod

umbrella::ISTickBox::OnChange ISTickBox::changeOptionMethod

changeOptionTarget

unknown ISTickBox::changeOptionTarget

choicesColor

umbrella::RGBA ISTickBox::choicesColor

clickedOption

integer ISTickBox::clickedOption

disabledOptions

table<string, boolean> ISTickBox::disabledOptions

enable

boolean ISTickBox::enable

font

UIFont ISTickBox::font

fontHgt

number ISTickBox::fontHgt

isTickBox

boolean ISTickBox::isTickBox

itemGap

number ISTickBox::itemGap

itemHgt

number ISTickBox::itemHgt

joypadIndex

integer ISTickBox::joypadIndex

leftMargin

number ISTickBox::leftMargin

mouseOverOption

integer ISTickBox::mouseOverOption

name

string ISTickBox::name

optionCount

integer ISTickBox::optionCount

optionData

table<integer, unknown> ISTickBox::optionData

options

string [] ISTickBox::options

optionsIndex

table<integer, string> ISTickBox::optionsIndex

selected

table<integer, boolean> ISTickBox::selected

textGap

number ISTickBox::textGap

textures

table<integer, Texture> ISTickBox::textures

tickTexture

Texture ISTickBox::tickTexture

tooltip

string ISTickBox::tooltip

tooltipUI

ISToolTip ISTickBox::tooltipUI

---

The documentation for this class was generated from the following file:

• client/ISUI/ISTickBox.yml