ISButton Class Reference

Inheritance diagram for ISButton:

Public Member Functions
void	initialise ()
void	onMouseMove (number dx, number dy)
void	onMouseMoveOutside (number dx, number dy)
void	setJoypadFocused (boolean focused)
void	onMouseUp (number x, number y)
void	onMouseUpOutside (number x, number y)
void	onMouseDown (number x, number y)
unknown	onMouseDoubleClick (number x, number y)
unknown	forceClick ()
void	setJoypadButton (Texture texture)
void	clearJoypadButton ()
void	prerender ()
void	setImage (Texture image)
void	forceImageSize (number width, number height)
void	setOverlayText (string text)
void	render ()
void	setFont (UIFont font)
string	getTitle ()
void	setTitle (string title)
void	setOnMouseOverFunction (umbrella::ISButton::MouseCallback onmouseover)
void	setOnMouseOutFunction (umbrella::ISButton::MouseCallback onmouseout)
void	setDisplayBackground (boolean background)
void	update ()
void	updateTooltip ()
void	setRepeatWhilePressed (umbrella::ISButton::RepeatWhilePressed func)
void	setBackgroundRGBA (number r, number g, number b, number a)
void	setBackgroundColorMouseOverRGBA (number r, number g, number b, number a)
void	setBorderRGBA (number r, number g, number b, number a)
void	setTextureRGBA (number r, number g, number b, number a)
void	enableAcceptColor ()
void	enableCancelColor ()
void	toggleAcceptCancel (boolean bEnabled)
void	setEnable (boolean bEnabled)
boolean	isEnabled ()
void	setTooltip (string tooltip)
void	setWidthToTitle (number minWidth, boolean isJoypad)
void	setOnClick (umbrella::ISButton::OnClick func, unknown arg1, unknown arg2, unknown arg3, unknown arg4)
void	setSound (string which, string soundName)
void	calculateLayout (number _preferredWidth, number _preferredHeight)
	ISButton (number x, number y, number width, number height, string title, unknown clicktarget, umbrella::ISButton::OnClick onclick, umbrella::ISButton::MouseCallback onmousedown, boolean allowMouseUpProcessing)
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
boolean	pressed
boolean	isJoypad
table	backgroundColorPressed
number	blinkBGAlpha
boolean	blinkBGAlphaIncrease
Texture	image
number	forcedWidthImage
number	forcedHeightImage
string	overlayText
number	blinkImageAlpha
boolean	blinkImageAlphaIncrease
UIFont	font
string	title
umbrella::ISButton::MouseCallback	onmouseover
umbrella::ISButton::MouseCallback	onmouseoutfunction
boolean	displayBackground
number	pressedTime
ISToolTip	tooltipUI
umbrella::ISButton::RepeatWhilePressed	repeatWhilePressedFunc
boolean	enable
umbrella::RGBA	borderColorEnabled
umbrella::RGBA	backgroundColorEnabled
string	tooltip
number	originalWidth
umbrella::ISButton::OnClick	onclick
unknown[]	onClickArgs
umbrella::RGBA	backgroundColorMouseOver
umbrella::RGBA	textureColor
umbrella::RGBA	textColor
unknown	target
umbrella::ISButton::MouseCallback	onmousedown
true	isButton
boolean	allowMouseUpProcessing
number	yoffset
UITransition	fade
number	joypadTextureWH
number	repeatWhilePressedTimer
table< string, string >	sounds
number	originalHeight
Texture	textureBackground
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

ISButton()

ISButton::ISButton	(	number	x,
		number	y,
		number	width,
		number	height,
		string	title,
		unknown	clicktarget,
		umbrella::ISButton::OnClick	onclick,
		umbrella::ISButton::MouseCallback	onmousedown,
		boolean	allowMouseUpProcessing )

Member Function Documentation

calculateLayout()

void ISButton::calculateLayout	(	number	_preferredWidth,
		number	_preferredHeight )

clearJoypadButton()

void ISButton::clearJoypadButton

(

)

enableAcceptColor()

void ISButton::enableAcceptColor

(

)

enableCancelColor()

void ISButton::enableCancelColor

(

)

forceClick()

unknown ISButton::forceClick

(

)

forceImageSize()

void ISButton::forceImageSize	(	number	width,
		number	height )

getTitle()

string ISButton::getTitle

(

)

initialise()

void ISButton::initialise

(

)

isEnabled()

boolean ISButton::isEnabled

(

)

onMouseDoubleClick()

unknown ISButton::onMouseDoubleClick	(	number	x,
		number	y )

onMouseDown()

void ISButton::onMouseDown	(	number	x,
		number	y )

onMouseMove()

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

onMouseMoveOutside()

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

onMouseUp()

void ISButton::onMouseUp	(	number	x,
		number	y )

onMouseUpOutside()

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

prerender()

void ISButton::prerender

(

)

render()

void ISButton::render

(

)

setBackgroundColorMouseOverRGBA()

void ISButton::setBackgroundColorMouseOverRGBA	(	number	r,
		number	g,
		number	b,
		number	a )

setBackgroundRGBA()

void ISButton::setBackgroundRGBA	(	number	r,
		number	g,
		number	b,
		number	a )

setBorderRGBA()

void ISButton::setBorderRGBA	(	number	r,
		number	g,
		number	b,
		number	a )

setDisplayBackground()

void ISButton::setDisplayBackground

(

boolean

background

)

setEnable()

void ISButton::setEnable

(

boolean

bEnabled

)

setFont()

void ISButton::setFont

(

UIFont

font

)

setImage()

void ISButton::setImage

(

Texture

image

)

setJoypadButton()

void ISButton::setJoypadButton

(

Texture

texture

)

setJoypadFocused()

void ISButton::setJoypadFocused

(

boolean

focused

)

setOnClick()

void ISButton::setOnClick	(	umbrella::ISButton::OnClick	func,
		unknown	arg1,
		unknown	arg2,
		unknown	arg3,
		unknown	arg4 )

setOnMouseOutFunction()

void ISButton::setOnMouseOutFunction

(

umbrella::ISButton::MouseCallback

onmouseout

)

setOnMouseOverFunction()

void ISButton::setOnMouseOverFunction

(

umbrella::ISButton::MouseCallback

onmouseover

)

setOverlayText()

void ISButton::setOverlayText

(

string

text

)

setRepeatWhilePressed()

void ISButton::setRepeatWhilePressed

(

umbrella::ISButton::RepeatWhilePressed

func

)

setSound()

void ISButton::setSound	(	string	which,
		string	soundName )

setTextureRGBA()

void ISButton::setTextureRGBA	(	number	r,
		number	g,
		number	b,
		number	a )

setTitle()

void ISButton::setTitle

(

string

title

)

setTooltip()

void ISButton::setTooltip

(

string

tooltip

)

setWidthToTitle()

void ISButton::setWidthToTitle	(	number	minWidth,
		boolean	isJoypad )

toggleAcceptCancel()

void ISButton::toggleAcceptCancel

(

boolean

bEnabled

)

update()

void ISButton::update

(

)

updateTooltip()

void ISButton::updateTooltip

(

)

Member Data Documentation

allowMouseUpProcessing

boolean ISButton::allowMouseUpProcessing

backgroundColorEnabled

umbrella::RGBA ISButton::backgroundColorEnabled

backgroundColorMouseOver

umbrella::RGBA ISButton::backgroundColorMouseOver

backgroundColorPressed

table ISButton::backgroundColorPressed

blinkBGAlpha

number ISButton::blinkBGAlpha

blinkBGAlphaIncrease

boolean ISButton::blinkBGAlphaIncrease

blinkImageAlpha

number ISButton::blinkImageAlpha

blinkImageAlphaIncrease

boolean ISButton::blinkImageAlphaIncrease

borderColorEnabled

umbrella::RGBA ISButton::borderColorEnabled

displayBackground

boolean ISButton::displayBackground

enable

boolean ISButton::enable

fade

UITransition ISButton::fade

font

UIFont ISButton::font

forcedHeightImage

number ISButton::forcedHeightImage

forcedWidthImage

number ISButton::forcedWidthImage

image

Texture ISButton::image

isButton

true ISButton::isButton

isJoypad

boolean ISButton::isJoypad

joypadTextureWH

number ISButton::joypadTextureWH

onclick

umbrella::ISButton::OnClick ISButton::onclick

onClickArgs

unknown [] ISButton::onClickArgs

onmousedown

umbrella::ISButton::MouseCallback ISButton::onmousedown

onmouseoutfunction

umbrella::ISButton::MouseCallback ISButton::onmouseoutfunction

onmouseover

umbrella::ISButton::MouseCallback ISButton::onmouseover

originalHeight

number ISButton::originalHeight

originalWidth

number ISButton::originalWidth

overlayText

string ISButton::overlayText

pressed

boolean ISButton::pressed

pressedTime

number ISButton::pressedTime

repeatWhilePressedFunc

umbrella::ISButton::RepeatWhilePressed ISButton::repeatWhilePressedFunc

repeatWhilePressedTimer

number ISButton::repeatWhilePressedTimer

sounds

table<string, string> ISButton::sounds

target

unknown ISButton::target

textColor

umbrella::RGBA ISButton::textColor

textureBackground

Texture ISButton::textureBackground

textureColor

umbrella::RGBA ISButton::textureColor

title

string ISButton::title

tooltip

string ISButton::tooltip

tooltipUI

ISToolTip ISButton::tooltipUI

yoffset

number ISButton::yoffset

---

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

• client/ISUI/ISButton.yml