TorqueScript Reference
Public Member Functions | List of all members
GuiButtonCtrl Class Reference

#include <guiButtonCtrl_ScriptBinding.h>

Inherits GuiControl.

Public Member Functions

String getFillColorHLEaseFunction ()
 
Integer getFillColorHLEaseTime ()
 
String getFillColorSLEaseFunction ()
 
Integer getFillColorSLEaseTime ()
 
void setFillColorHLEase (EaseFunction, [EaseTime])
 
void setFillColorSLEase (EaseFunction, [EaseTime])
 
- Public Member Functions inherited from GuiControl
void addGuiControl (int controlId)
 
Integer findHitControl (int x, int y)
 
String getCenter ()
 
String getExtent (...)
 
String getGlobalCenter ()
 
String getGlobalPosition ()
 
String getMinExtent ()
 
Integer getParent ()
 
String getPosition ()
 
String getText ()
 
Boolean getTextExtend ()
 
Boolean getTextWrap ()
 
String getValue ()
 
Boolean isActive ()
 
Boolean isAwake ()
 
Boolean isVisible ()
 
void makeFirstResponder (isFirst)
 
void performClick ()
 
Boolean pointInControl (int x, int y)
 
void reorderChild (child1, child2)
 
void resize (int x, int y, int w, int h)
 
void setActive (isActive)
 
void setCanSave (bool canSave)
 
void setCenter (int x, int y)
 
void setExtent (int width, int height)
 
void setFirstResponder ()
 
void setPosition (int x, int y)
 
void setPositionGlobal (int x, int y)
 
void setProfile (GuiControlProfile p)
 
void setText (text)
 
void setTextExtend (setting)
 
void setTextID (id)
 
void setTextWrap (setting)
 
void setValue (value)
 
void setVisible (isVisible)
 

Member Function Documentation

◆ getFillColorHLEaseFunction()

String getFillColorHLEaseFunction ( )

Gets the name of the current easing function used to change the fill color to the highlight color.

Returns
Name of the current easing function.

◆ getFillColorHLEaseTime()

Integer getFillColorHLEaseTime ( )

Gets the amount of time in milliseconds that it takes to change fill color to the highlight color.

Returns
Time in milliseconds.

◆ getFillColorSLEaseFunction()

String getFillColorSLEaseFunction ( )

Gets the name of the current easing function used to change the fill color to the select color.

Returns
Name of the current easing function.

◆ getFillColorSLEaseTime()

Integer getFillColorSLEaseTime ( )

Gets the amount of time in milliseconds that it takes to change fill color to the selected color.

Returns
Time in milliseconds.

◆ setFillColorHLEase()

void setFillColorHLEase ( EaseFunction  )

Sets the easing that should be used to change the fill color to the highlight color. Time in milliseconds can optionally be provided.

Parameters
EaseFunctionName of the selected easing function to use. Defaults to Linear (none).
EaseTimeOptional length of time in milliseconds that it takes to change.
Returns
No return value.

◆ setFillColorSLEase()

void setFillColorSLEase ( EaseFunction  )

Sets the easing that should be used to change the fill color to the selected color. Time in milliseconds can optionally be provided.

Parameters
EaseFunctionName of the selected easing function to use. Defaults to Linear (none).
EaseTimeOptional length of time in milliseconds that it takes to change.
Returns
No return value.