Package com.fs.starfarer.api.ui

Interface ButtonAPI

All Superinterfaces:

UIComponentAPI

public interface ButtonAPI
extends UIComponentAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ButtonAPI.UICheckboxSize

Method Summary

Modifier and Type	Method	Description
void	flash()
void	flash(boolean withSound)
void	flash(boolean withSound, float in, float out)
Object	getCustomData()
float	getGlowBrightness()
float	getHighlightBrightness()
String	getText()	Only works for certain types of basic buttons.
void	highlight()
boolean	isChecked()
boolean	isEnabled()
boolean	isHighlighted()
boolean	isPerformActionWhenDisabled()
boolean	isSkipPlayingPressedSoundOnce()
void	setButtonDisabledPressedSound(String buttonDisabledPressedSound)
void	setButtonPressedSound(String buttonPressedSound)
void	setChecked(boolean checked)
void	setClickable(boolean clickable)
void	setCustomData(Object customData)
void	setEnabled(boolean enabled)
void	setFlashBrightness(float flashBrightness)
void	setGlowBrightness(float glowBrightness)
void	setHighlightBounceDown(boolean b)
void	setHighlightBrightness(float highlightBrightness)
void	setMouseOverSound(String mouseOverSound)
void	setPerformActionWhenDisabled(boolean performActionWhenDisabled)
void	setQuickMode(boolean quickMode)
void	setRightClicksOkWhenDisabled(boolean rightClicksOkWhenDisabled)
void	setShortcut(int key, boolean putLast)
void	setShowTooltipWhileInactive(boolean showTooltipWhileInactive)
void	setSkipPlayingPressedSoundOnce(boolean skipPlayingPressedSoundOnce)
void	setText(String text)	Only works for certain types of basic buttons.
void	unhighlight()

Methods inherited from interface com.fs.starfarer.api.ui.UIComponentAPI

advance, getOpacity, getPosition, processInput, render, setOpacity

Method Details

setShortcut

void setShortcut(int key,
 boolean putLast)

setEnabled

void setEnabled(boolean enabled)

isEnabled

boolean isEnabled()

setButtonPressedSound

void setButtonPressedSound(String buttonPressedSound)

setMouseOverSound

void setMouseOverSound(String mouseOverSound)

setButtonDisabledPressedSound

void setButtonDisabledPressedSound(String buttonDisabledPressedSound)

isChecked

boolean isChecked()

setChecked

void setChecked(boolean checked)

highlight

void highlight()

unhighlight

void unhighlight()

isHighlighted

boolean isHighlighted()

setHighlightBrightness

void setHighlightBrightness(float highlightBrightness)

getHighlightBrightness

float getHighlightBrightness()

setQuickMode

void setQuickMode(boolean quickMode)

setClickable

void setClickable(boolean clickable)

getGlowBrightness

float getGlowBrightness()

setGlowBrightness

void setGlowBrightness(float glowBrightness)

setText

void setText(String text)

Only works for certain types of basic buttons.

Parameters:

text -

getText

String getText()

Only works for certain types of basic buttons.

setSkipPlayingPressedSoundOnce

void setSkipPlayingPressedSoundOnce(boolean skipPlayingPressedSoundOnce)

setHighlightBounceDown

void setHighlightBounceDown(boolean b)

setShowTooltipWhileInactive

void setShowTooltipWhileInactive(boolean showTooltipWhileInactive)

setRightClicksOkWhenDisabled

void setRightClicksOkWhenDisabled(boolean rightClicksOkWhenDisabled)

setFlashBrightness

void setFlashBrightness(float flashBrightness)

flash

void flash(boolean withSound,
 float in,
 float out)

flash

void flash(boolean withSound)

flash

void flash()

setPerformActionWhenDisabled

void setPerformActionWhenDisabled(boolean performActionWhenDisabled)

isPerformActionWhenDisabled

boolean isPerformActionWhenDisabled()

isSkipPlayingPressedSoundOnce

boolean isSkipPlayingPressedSoundOnce()

getCustomData

Object getCustomData()

setCustomData

void setCustomData(Object customData)