C# Class FairyGUI.UIConfig

Inheritance: UnityEngine.MonoBehaviour
Show file Open project: fairygui/FairyGUI-unity Class Usage Examples

Public Properties

Property Type Description
Items List
PreloadPackages List
allowSoftnessOnTopOrLeftSide bool
bringWindowToFrontOnClick bool
buttonSound UnityEngine.AudioClip
buttonSoundVolumeScale float
clickDragSensitivity int
defaultComboBoxVisibleItemCount int
defaultFont string
defaultScrollBarDisplay ScrollBarDisplayType
defaultScrollBounceEffect bool
defaultScrollSpeed float
defaultScrollTouchEffect bool
defaultTouchScrollSpeedRatio float
frameTimeForAsyncUIConstruction float
globalModalWaiting String
horizontalScrollBar string
inputCaretSize int
inputHighlightColor Color
loaderErrorSign string
modalLayerColor Color
popupMenu string
popupMenu_seperator string
renderingTextBrighterOnDesktop bool
tooltipsWin string
touchDragSensitivity int
touchScrollSensitivity int
verticalScrollBar string
windowModalWaiting string

Public Methods

Method Description
ApplyModifiedProperties ( ) : void
ClearResourceRefs ( ) : void
Load ( ) : void

Private Methods

Method Description
Awake ( ) : void

Method Details

ApplyModifiedProperties() public method

public ApplyModifiedProperties ( ) : void
return void

ClearResourceRefs() public static method

public static ClearResourceRefs ( ) : void
return void

Load() public method

public Load ( ) : void
return void

Property Details

Items public property

public List Items
return List

PreloadPackages public property

public List PreloadPackages
return List

allowSoftnessOnTopOrLeftSide public static property

Allow softness on top or left side for scrollpane.
public static bool allowSoftnessOnTopOrLeftSide
return bool

bringWindowToFrontOnClick public static property

When click the window, brings to front automatically.
public static bool bringWindowToFrontOnClick
return bool

buttonSound public static property

Default button click sound.
public static AudioClip,UnityEngine buttonSound
return UnityEngine.AudioClip

buttonSoundVolumeScale public static property

Default button click sound volume.
public static float buttonSoundVolumeScale
return float

clickDragSensitivity public static property

Pixel offsets of mouse pointer to trigger dragging.
public static int clickDragSensitivity
return int

defaultComboBoxVisibleItemCount public static property

The number of visible items in ComboBox.
public static int defaultComboBoxVisibleItemCount
return int

defaultFont public static property

Dynamic Font Support. 4.x: Put the xxx.ttf into /Resources or /Resources/Font, and set defaultFont="xxx". 5.x: set defaultFont to system font name(or names joint with comma). e.g. defaultFont="Microsoft YaHei, SimHei"
public static string defaultFont
return string

defaultScrollBarDisplay public static property

Scrollbar display mode. Recommended 'Auto' for mobile and 'Visible' for web.
public static ScrollBarDisplayType defaultScrollBarDisplay
return ScrollBarDisplayType

defaultScrollBounceEffect public static property

The "rebound" effect in the scolling container.
public static bool defaultScrollBounceEffect
return bool

defaultScrollSpeed public static property

Scrolling step in pixels
public static float defaultScrollSpeed
return float

defaultScrollTouchEffect public static property

Allow dragging anywhere in container to scroll.
public static bool defaultScrollTouchEffect
return bool

defaultTouchScrollSpeedRatio public static property

Speed ratio of scrollpane when its touch dragging.
public static float defaultTouchScrollSpeedRatio
return float

frameTimeForAsyncUIConstruction public static property

public static float frameTimeForAsyncUIConstruction
return float

globalModalWaiting public static property

Resource using in GRoot.ShowModalWait for locking the screen.
public static String globalModalWaiting
return String

horizontalScrollBar public static property

Resource url of horizontal scrollbar
public static string horizontalScrollBar
return string

inputCaretSize public static property

public static int inputCaretSize
return int

inputHighlightColor public static property

public static Color inputHighlightColor
return Color

loaderErrorSign public static property

In case of failure of loading content for GLoader, use this sign to indicate an error.
public static string loaderErrorSign
return string

modalLayerColor public static property

When a modal window is in front, the background becomes dark.
public static Color modalLayerColor
return Color

popupMenu public static property

Resources url of PopupMenu.
public static string popupMenu
return string

popupMenu_seperator public static property

Resource url of menu seperator.
public static string popupMenu_seperator
return string

renderingTextBrighterOnDesktop public static property

When using chinese fonts on desktop, I found that the display effect is not very clear. So I wrote shaders to light up their outline. If you dont use chinese fonts, or dont like the new effect, just set to false here. The switch is meaningless on mobile platforms.
public static bool renderingTextBrighterOnDesktop
return bool

tooltipsWin public static property

Resource url of tooltips.
public static string tooltipsWin
return string

touchDragSensitivity public static property

Pixel offsets of finger to trigger dragging
public static int touchDragSensitivity
return int

touchScrollSensitivity public static property

Pixel offsets of finger to trigger scrolling
public static int touchScrollSensitivity
return int

verticalScrollBar public static property

Resource url of vertical scrollbar
public static string verticalScrollBar
return string

windowModalWaiting public static property

Resource using in Window.ShowModalWait for locking the window.
public static string windowModalWaiting
return string