ISMPButton Class Reference

Inheritance diagram for ISMPButton:

Public Member Functions
void	initialise ()
void	onMouseMove (number dx, number dy)
void	onMouseMoveOutside (number dx, number dy)
void	setJoypadFocused (nil 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 (nil texture)
void	clearJoypadButton ()
void	prerender ()
void	setImage (nil image)
void	forceImageSize (number width, number height)
void	setOverlayText (nil text)
void	render ()
void	setFont (nil font)
string	getTitle ()
void	setTitle (string title)
void	setOnMouseOverFunction (nil onmouseover)
void	setOnMouseOutFunction (nil onmouseout)
void	setDisplayBackground (nil background)
void	update ()
void	updateTooltip ()
void	setRepeatWhilePressed (nil 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 (nil bEnabled)
void	setEnable (nil bEnabled)
boolean	isEnabled ()
void	setTooltip (nil tooltip)
void	setWidthToTitle (nil minWidth, boolean isJoypad)
void	setOnClick (nil func, nil arg1, nil arg2, nil arg3, nil arg4)
void	setSound (nil which, string soundName)
void	calculateLayout (nil _preferredWidth, nil _preferredHeight)
	ISMPButton (number x, number y, number width, number height, string title, MultiplayerUI clicktarget, nil onclick, nil onmousedown, nil 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
fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self:ISUIElement) fun(self: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)
boolean	isMouseOverChild ()
boolean	isPointOverChild (nil screenX, nil screenY)
void	suspendStencil ()
void	resumeStencil ()
void	setStencilRect (number x, number y, number w, number h)
unknown	setStencilCircle (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 ()
unknown	isCapture ()
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	renderJoypadNavigateCurrent (number x, number y, number w, number h)
void	renderJoypadNavigateSelf ()
void	renderJoypadNavigateHighlight (JoypadData joypadData, ISUIElement child)
void	renderJoypadNavigateTexture (JoypadData joypadData, ISUIElement child, Texture texture)
boolean	isDescendant (nil ui)
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	drawPolygon (Texture tex, number x1, number y1, number x2, number y2, number x3, number y3, number x4, number y4, number r, number g, number b, number a)
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
number	forcedWidthImage
number	forcedHeightImage
number	blinkImageAlpha
boolean	blinkImageAlphaIncrease
string	title
boolean	displayBackground
ISToolTip	tooltipUI
boolean	enable
table	borderColorEnabled
table	backgroundColorEnabled
number	originalWidth
table	onClickArgs
table	backgroundColorMouseOver
table	textureColor
table	textColor
MultiplayerUI	target
boolean	ISMPButton
number	yoffset
number	joypadTextureWH
number	repeatWhilePressedTimer
table	sounds
number	originalHeight
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
table	joypadNavigatePrevRect
table	joypadNavigateTransition
UIElement	javaObject
boolean	removed
ISScrollBar	vscroll
ISScrollBar	hscroll
umbrella::ISUIElement::MouseDoubleClick	onMouseDoubleClick
unknown	target
number	scrollwidth
boolean	wantKeyEvents
boolean	wantExtraMouseEvents
boolean	forceCursorVisible
string	dock
table	joypadNavigate
string	internal
ISUIElement	parent
boolean	overrideBPrompt
Public Attributes inherited from ISBaseObject
string	Type
table< string, table< function, unknown > >	__eventListeners

Constructor & Destructor Documentation

ISMPButton()

ISMPButton::ISMPButton	(	number	x,
		number	y,
		number	width,
		number	height,
		string	title,
		MultiplayerUI	clicktarget,
		nil	onclick,
		nil	onmousedown,
		nil	allowMouseUpProcessing )

Member Function Documentation

calculateLayout()

void ISMPButton::calculateLayout	(	nil	_preferredWidth,
		nil	_preferredHeight )

clearJoypadButton()

void ISMPButton::clearJoypadButton

(

)

enableAcceptColor()

void ISMPButton::enableAcceptColor

(

)

enableCancelColor()

void ISMPButton::enableCancelColor

(

)

forceClick()

unknown ISMPButton::forceClick

(

)

forceImageSize()

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

getTitle()

string ISMPButton::getTitle

(

)

initialise()

void ISMPButton::initialise

(

)

isEnabled()

boolean ISMPButton::isEnabled

(

)

onMouseDoubleClick()

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

onMouseDown()

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

onMouseMove()

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

onMouseMoveOutside()

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

onMouseUp()

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

onMouseUpOutside()

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

prerender()

void ISMPButton::prerender

(

)

render()

void ISMPButton::render

(

)

setBackgroundColorMouseOverRGBA()

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

setBackgroundRGBA()

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

setBorderRGBA()

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

setDisplayBackground()

void ISMPButton::setDisplayBackground

(

nil

background

)

setEnable()

void ISMPButton::setEnable

(

nil

bEnabled

)

setFont()

void ISMPButton::setFont

(

nil

font

)

setImage()

void ISMPButton::setImage

(

nil

image

)

setJoypadButton()

void ISMPButton::setJoypadButton

(

nil

texture

)

setJoypadFocused()

void ISMPButton::setJoypadFocused

(

nil

focused

)

setOnClick()

void ISMPButton::setOnClick	(	nil	func,
		nil	arg1,
		nil	arg2,
		nil	arg3,
		nil	arg4 )

setOnMouseOutFunction()

void ISMPButton::setOnMouseOutFunction

(

nil

onmouseout

)

setOnMouseOverFunction()

void ISMPButton::setOnMouseOverFunction

(

nil

onmouseover

)

setOverlayText()

void ISMPButton::setOverlayText

(

nil

text

)

setRepeatWhilePressed()

void ISMPButton::setRepeatWhilePressed

(

nil

func

)

setSound()

void ISMPButton::setSound	(	nil	which,
		string	soundName )

setTextureRGBA()

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

setTitle()

void ISMPButton::setTitle

(

string

title

)

setTooltip()

void ISMPButton::setTooltip

(

nil

tooltip

)

setWidthToTitle()

void ISMPButton::setWidthToTitle	(	nil	minWidth,
		boolean	isJoypad )

toggleAcceptCancel()

void ISMPButton::toggleAcceptCancel

(

nil

bEnabled

)

update()

void ISMPButton::update

(

)

updateTooltip()

void ISMPButton::updateTooltip

(

)

Member Data Documentation

backgroundColorEnabled

table ISMPButton::backgroundColorEnabled

backgroundColorMouseOver

table ISMPButton::backgroundColorMouseOver

backgroundColorPressed

table ISMPButton::backgroundColorPressed

blinkBGAlpha

number ISMPButton::blinkBGAlpha

blinkBGAlphaIncrease

boolean ISMPButton::blinkBGAlphaIncrease

blinkImageAlpha

number ISMPButton::blinkImageAlpha

blinkImageAlphaIncrease

boolean ISMPButton::blinkImageAlphaIncrease

borderColorEnabled

table ISMPButton::borderColorEnabled

displayBackground

boolean ISMPButton::displayBackground

enable

boolean ISMPButton::enable

forcedHeightImage

number ISMPButton::forcedHeightImage

forcedWidthImage

number ISMPButton::forcedWidthImage

isJoypad

boolean ISMPButton::isJoypad

ISMPButton

boolean ISMPButton::ISMPButton

joypadTextureWH

number ISMPButton::joypadTextureWH

onClickArgs

table ISMPButton::onClickArgs

originalHeight

number ISMPButton::originalHeight

originalWidth

number ISMPButton::originalWidth

pressed

boolean ISMPButton::pressed

repeatWhilePressedTimer

number ISMPButton::repeatWhilePressedTimer

sounds

table ISMPButton::sounds

target

MultiplayerUI ISMPButton::target

textColor

table ISMPButton::textColor

textureColor

table ISMPButton::textureColor

title

string ISMPButton::title

tooltipUI

ISToolTip ISMPButton::tooltipUI

yoffset

number ISMPButton::yoffset

---

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

• client/ISUI/ISMPButton.yml