Starsector API
Loading...
Searching...
No Matches
com.fs.starfarer.api.ui.ButtonAPI Interface Reference
Inheritance diagram for com.fs.starfarer.api.ui.ButtonAPI:
[legend]
Collaboration diagram for com.fs.starfarer.api.ui.ButtonAPI:
[legend]

Classes

enum  UICheckboxSize
 

Public Member Functions

void setShortcut (int key, boolean putLast)
 
void setEnabled (boolean enabled)
 
boolean isEnabled ()
 
void setButtonPressedSound (String buttonPressedSound)
 
void setMouseOverSound (String mouseOverSound)
 
void setButtonDisabledPressedSound (String buttonDisabledPressedSound)
 
boolean isChecked ()
 
void setChecked (boolean checked)
 
void highlight ()
 
void unhighlight ()
 
boolean isHighlighted ()
 
void setHighlightBrightness (float highlightBrightness)
 
float getHighlightBrightness ()
 
void setQuickMode (boolean quickMode)
 
void setClickable (boolean clickable)
 
float getGlowBrightness ()
 
void setGlowBrightness (float glowBrightness)
 
void setText (String text)
 
String getText ()
 
void setSkipPlayingPressedSoundOnce (boolean skipPlayingPressedSoundOnce)
 
void setHighlightBounceDown (boolean b)
 
void setShowTooltipWhileInactive (boolean showTooltipWhileInactive)
 
void setRightClicksOkWhenDisabled (boolean rightClicksOkWhenDisabled)
 
void setFlashBrightness (float flashBrightness)
 
void flash (boolean withSound, float in, float out)
 
void flash (boolean withSound)
 
void flash ()
 
void setPerformActionWhenDisabled (boolean performActionWhenDisabled)
 
boolean isPerformActionWhenDisabled ()
 
boolean isSkipPlayingPressedSoundOnce ()
 
Object getCustomData ()
 
void setCustomData (Object customData)
 
- Public Member Functions inherited from com.fs.starfarer.api.ui.UIComponentAPI
PositionAPI getPosition ()
 
void render (float alphaMult)
 
void processInput (List< InputEventAPI > events)
 
void advance (float amount)
 

Detailed Description

Definition at line 3 of file ButtonAPI.java.

Member Function Documentation

◆ flash() [1/3]

void com.fs.starfarer.api.ui.ButtonAPI.flash ( )

◆ flash() [2/3]

void com.fs.starfarer.api.ui.ButtonAPI.flash ( boolean  withSound)

◆ flash() [3/3]

void com.fs.starfarer.api.ui.ButtonAPI.flash ( boolean  withSound,
float  in,
float  out 
)

◆ getCustomData()

Object com.fs.starfarer.api.ui.ButtonAPI.getCustomData ( )

◆ getGlowBrightness()

float com.fs.starfarer.api.ui.ButtonAPI.getGlowBrightness ( )

◆ getHighlightBrightness()

float com.fs.starfarer.api.ui.ButtonAPI.getHighlightBrightness ( )

◆ getText()

String com.fs.starfarer.api.ui.ButtonAPI.getText ( )

Only works for certain types of basic buttons.

◆ highlight()

void com.fs.starfarer.api.ui.ButtonAPI.highlight ( )

◆ isChecked()

boolean com.fs.starfarer.api.ui.ButtonAPI.isChecked ( )

◆ isEnabled()

boolean com.fs.starfarer.api.ui.ButtonAPI.isEnabled ( )

◆ isHighlighted()

boolean com.fs.starfarer.api.ui.ButtonAPI.isHighlighted ( )

◆ isPerformActionWhenDisabled()

boolean com.fs.starfarer.api.ui.ButtonAPI.isPerformActionWhenDisabled ( )

◆ isSkipPlayingPressedSoundOnce()

boolean com.fs.starfarer.api.ui.ButtonAPI.isSkipPlayingPressedSoundOnce ( )

◆ setButtonDisabledPressedSound()

void com.fs.starfarer.api.ui.ButtonAPI.setButtonDisabledPressedSound ( String  buttonDisabledPressedSound)

◆ setButtonPressedSound()

void com.fs.starfarer.api.ui.ButtonAPI.setButtonPressedSound ( String  buttonPressedSound)

◆ setChecked()

void com.fs.starfarer.api.ui.ButtonAPI.setChecked ( boolean  checked)

◆ setClickable()

void com.fs.starfarer.api.ui.ButtonAPI.setClickable ( boolean  clickable)

◆ setCustomData()

void com.fs.starfarer.api.ui.ButtonAPI.setCustomData ( Object  customData)

◆ setEnabled()

void com.fs.starfarer.api.ui.ButtonAPI.setEnabled ( boolean  enabled)

◆ setFlashBrightness()

void com.fs.starfarer.api.ui.ButtonAPI.setFlashBrightness ( float  flashBrightness)

◆ setGlowBrightness()

void com.fs.starfarer.api.ui.ButtonAPI.setGlowBrightness ( float  glowBrightness)

◆ setHighlightBounceDown()

void com.fs.starfarer.api.ui.ButtonAPI.setHighlightBounceDown ( boolean  b)

◆ setHighlightBrightness()

void com.fs.starfarer.api.ui.ButtonAPI.setHighlightBrightness ( float  highlightBrightness)

◆ setMouseOverSound()

void com.fs.starfarer.api.ui.ButtonAPI.setMouseOverSound ( String  mouseOverSound)

◆ setPerformActionWhenDisabled()

void com.fs.starfarer.api.ui.ButtonAPI.setPerformActionWhenDisabled ( boolean  performActionWhenDisabled)

◆ setQuickMode()

void com.fs.starfarer.api.ui.ButtonAPI.setQuickMode ( boolean  quickMode)

◆ setRightClicksOkWhenDisabled()

void com.fs.starfarer.api.ui.ButtonAPI.setRightClicksOkWhenDisabled ( boolean  rightClicksOkWhenDisabled)

◆ setShortcut()

void com.fs.starfarer.api.ui.ButtonAPI.setShortcut ( int  key,
boolean  putLast 
)

◆ setShowTooltipWhileInactive()

void com.fs.starfarer.api.ui.ButtonAPI.setShowTooltipWhileInactive ( boolean  showTooltipWhileInactive)

◆ setSkipPlayingPressedSoundOnce()

void com.fs.starfarer.api.ui.ButtonAPI.setSkipPlayingPressedSoundOnce ( boolean  skipPlayingPressedSoundOnce)

◆ setText()

void com.fs.starfarer.api.ui.ButtonAPI.setText ( String  text)

Only works for certain types of basic buttons.

Parameters
text

◆ unhighlight()

void com.fs.starfarer.api.ui.ButtonAPI.unhighlight ( )

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