NGUI: Next-Gen UI kit

https://www.tasharen.com/ngui/docs/
Admin
NGUI is a comprehensive UI kit designed for Unity, providing tools for creating animated, localized,...
Tokens:384,161
Snippets:4,699
Trust Score:8.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_tweener.html

Updates the tween state immediately upon starting.

```APIDOC
## Start

### Description
Update as soon as it's started so that there is no delay.

### Method Signature
`protected virtual void UITweener.Start()`
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_label-members.html

Protected method called when the UIRect starts.

```APIDOC
## Start UIRect

### Description
Protected method called when the UIRect starts.
```

--------------------------------

### selectionStart

Source: https://www.tasharen.com/ngui/docs/class_u_i_input.html

Gets or sets the starting index of the text selection.

```APIDOC
## selectionStart

### Description
Index of the character where selection begins.

### Property
int

### Access
[get, set]
```

--------------------------------

### UIWidget.OnStart

Source: https://www.tasharen.com/ngui/docs/class_u_i_widget.html

Provides virtual Start() functionality for widgets.

```APIDOC
## OnStart

### Description
Virtual Start() functionality for widgets.

### Method
void

### Parameters
None
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_table.html

Initializes the positioning of the grid's contents when the script starts.

```APIDOC
## Start

### Description
Position the grid's contents when the script starts.

### Method
POST

### Endpoint
/UITable/Start
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_tween_color.html

Protected method called when the tween is started.

```APIDOC
## Start

### Description
This virtual protected method is called as soon as the tween is started to ensure there is no initial delay.

### Method
```csharp
void Start ()
```
```

--------------------------------

### Begin (Static)

Source: https://www.tasharen.com/ngui/docs/class_tween_f_o_v.html

Starts a new TweenFOV operation.

```APIDOC
## Begin (Static)

### Description
Starts the tweening operation for the camera's field of view.

### Method
static TweenFOV

### Signature
Begin(GameObject go, float duration, float to)
Begin<T>(GameObject go, float duration)
```

--------------------------------

### SelectWidget (by start, position, and direction)

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_editor_tools.html

Select the next widget in line, starting from a given object and position.

```APIDOC
## SelectWidget

### Description
Select the next widget in line, starting from a given object and position.

### Method
static bool

### Parameters
#### Query Parameters
- **_start_** (GameObject) - Required - The starting GameObject to search from.
- **_pos_** (Vector2) - Required - The screen coordinates to select the widget from.
- **_inFront_** (bool) - Required - Whether to select a widget in front of the current selection.
```

--------------------------------

### Begin

Source: https://www.tasharen.com/ngui/docs/class_u_i_tweener-members.html

Starts a new tween on a specified GameObject.

```APIDOC
## Begin< T >

### Description
Static method to start a new tween of a specific type on a given GameObject.

### Method
`Begin< T >(GameObject go, float duration)`

### Parameters
- **go** (GameObject) - The GameObject to attach the tween to.
- **duration** (float) - The duration of the tween in seconds.
```

--------------------------------

### Begin<T>

Source: https://www.tasharen.com/ngui/docs/class_tween_alpha.html

Starts a generic tweening operation.

```APIDOC
## Begin<T>

### Description
Starts the tweening operation for a generic type.

### Method
static T

### Parameters
- **go** (GameObject) - The GameObject to tween.
- **duration** (float) - The duration of the tween.

### Returns
The created tween instance of type T.
```

--------------------------------

### Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_color.html

Starts a new color tween operation.

```APIDOC
## Begin

### Description
Starts the color tweening operation.

### Method
```csharp
static TweenColor Begin (GameObject go, float duration, Color color)
```

### Parameters
#### Path Parameters
- **go** (GameObject) - Required - The GameObject to tween.
- **duration** (float) - Required - The duration of the tween.
- **color** (Color) - Required - The target color.
```

--------------------------------

### Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_alpha.html

Starts a new alpha tween operation.

```APIDOC
## Begin

### Description
Starts the tweening operation for alpha.

### Method
static TweenAlpha

### Parameters
- **go** (GameObject) - The GameObject to tween.
- **duration** (float) - The duration of the tween.
- **alpha** (float) - The target alpha value.

### Returns
The created TweenAlpha instance.
```

--------------------------------

### Begin (Static)

Source: https://www.tasharen.com/ngui/docs/class_tween_width.html

Starts a new TweenWidth operation on a UIWidget.

```APIDOC
## Begin (Static)

### Description
Starts the tweening operation for a UIWidget's width.

### Method
static TweenWidth Begin(UIWidget widget, float duration, int width)

### Parameters
- **widget** (UIWidget) - The UIWidget to tween.
- **duration** (float) - The duration of the tween in seconds.
- **width** (int) - The target width to tween to.
```

--------------------------------

### Begin (Static)

Source: https://www.tasharen.com/ngui/docs/class_tween_height.html

Starts a new TweenHeight operation on a UIWidget.

```APIDOC
## Begin (UIWidget widget, float duration, int height)

### Description
Starts the tweening operation to animate the widget's height.

### Method
static TweenHeight Begin (UIWidget widget, float duration, int height)

### Parameters
* **widget** (UIWidget) - The UIWidget to tween.
* **duration** (float) - The duration of the tween in seconds.
* **height** (int) - The target height for the widget.
```

```APIDOC
## Begin< T > (GameObject go, float duration)

### Description
Starts a generic tweening operation on a GameObject.

### Method
static T Begin< T > (GameObject go, float duration)

### Parameters
* **go** (GameObject) - The GameObject to tween.
* **duration** (float) - The duration of the tween in seconds.

### Returns
* **T** - The created UITweener instance.
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_tweener-members.html

Protected virtual method called when the tween is initialized.

```APIDOC
## Start

### Description
Protected virtual method called when the tween is initialized or enabled. Used for setup.

### Method
`Start()`
```

--------------------------------

### Guides Control

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_menu.html

Functions to check and toggle the visibility of guides in the NGUI editor.

```APIDOC
## NGUIMenu.TurnGuidesOff

### Description
Turns off guides in the NGUI editor.

### Method
static void

## NGUIMenu.TurnGuidesOffCheck

### Description
Checks if guides are currently turned off.

### Method
static bool

## NGUIMenu.TurnGuidesOn

### Description
Turns on guides in the NGUI editor.

### Method
static void

## NGUIMenu.TurnGuidesOnCheck

### Description
Checks if guides are currently turned on.

### Method
static bool
```

--------------------------------

### instance

Source: https://www.tasharen.com/ngui/docs/class_u_i_atlas_maker-members.html

Gets the static instance of UIAtlasMaker.

```APIDOC
## instance

### Description
Gets the static instance of UIAtlasMaker.

### Method
static
```

--------------------------------

### OnStart

Source: https://www.tasharen.com/ngui/docs/class_u_i_label-members.html

Protected virtual method called when the UILabel starts.

```APIDOC
## OnStart UILabel

### Description
Protected virtual method called when the UILabel starts.
```

--------------------------------

### TweenFOV.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_f_o_v-members.html

Starts a new TweenFOV animation.

```APIDOC
## Begin(GameObject go, float duration, float to)

### Description
Starts a new TweenFOV animation from the current FOV to the specified 'to' value over the given duration.

### Method
static TweenFOV

### Parameters
#### Path Parameters
- **go** (GameObject) - The GameObject to animate.
- **duration** (float) - The duration of the tween.
- **to** (float) - The target FOV value.
```

--------------------------------

### TweenScale.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_scale.html

Starts a scaling tween operation on a GameObject.

```APIDOC
## TweenScale.Begin

### Description
Starts the tweening operation for scaling a GameObject.

### Method
static TweenScale

### Parameters
- **_go_** (GameObject) - The GameObject to tween.
- **_duration_** (float) - The duration of the tween.
- **_scale_** (Vector3) - The target scale to tween to.
```

--------------------------------

### TweenOrthoSize.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_ortho_size-members.html

Starts a new TweenOrthoSize animation on a GameObject.

```APIDOC
## TweenOrthoSize.Begin

### Description
Starts a new TweenOrthoSize animation on a GameObject, tweening the orthographic camera size from its current value to a specified value over a given duration.

### Method
static TweenOrthoSize.Begin(GameObject go, float duration, float to)

### Parameters
- **go** (GameObject) - The GameObject to animate.
- **duration** (float) - The duration of the tween in seconds.
- **to** (float) - The target orthographic size.
```

--------------------------------

### TweenVolume.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_volume.html

Starts a volume tweening operation on a specified GameObject.

```APIDOC
## TweenVolume.Begin

### Description
Starts the tweening operation for volume on a given GameObject.

### Method
static TweenVolume

### Parameters
#### Path Parameters
- **_go_** (GameObject) - The GameObject to tween the volume on.
- **_duration_** (float) - The duration of the tweening operation.
- **_targetVolume_** (float) - The target volume value to tween to.
```

--------------------------------

### Begin (GameObject, float, float)

Source: https://www.tasharen.com/ngui/docs/class_tween_volume.html

Starts the tweening operation for audio source volume.

```APIDOC
## Begin

### Description
Start the tweening operation for audio source volume.

### Method
static TweenVolume

### Parameters
- **go** (GameObject) - The GameObject with the AudioSource component to tween.
- **duration** (float) - The duration of the tween in seconds.
- **targetVolume** (float) - The target volume to tween to.
```

--------------------------------

### OnStart

Source: https://www.tasharen.com/ngui/docs/class_u_i_label.html

Protected virtual method called at the start to determine initial values.

```APIDOC
## UILabel.OnStart

### Description
Determine start-up values.

### Method
`OnStart()

```

--------------------------------

### ObjectToGUID

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_editor_tools.html

Gets the unique identifier (GUID) for a given object.

```APIDOC
## ObjectToGUID

### Description
Get the specified object's GUID.

### Signature
`static string ObjectToGUID(Object obj)`
```

--------------------------------

### TweenOrthoSize.from

Source: https://www.tasharen.com/ngui/docs/class_tween_ortho_size-members.html

Gets or sets the starting orthographic size for the tween.

```APIDOC
## TweenOrthoSize.from

### Description
Gets or sets the initial orthographic size of the camera before the tween begins. This property is typically set automatically when the tween is created but can be manually adjusted.

### Property
from (float) - The starting orthographic size.
```

--------------------------------

### TweenScale.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_scale.html

Starts a new scale tweening operation on a GameObject.

```APIDOC
## TweenScale.Begin

### Description
Starts the tweening operation to animate the local scale of a GameObject.

### Method
static TweenScale

### Parameters
- **go** (GameObject) - The GameObject to tween.
- **duration** (float) - The duration of the tween in seconds.
- **scale** (Vector3) - The target local scale.

### Returns
- TweenScale - The newly created TweenScale object.
```

--------------------------------

### NGUI Functions Starting with G

Source: https://www.tasharen.com/ngui/docs/functions_func_g.html

This section details various functions within the NGUI library that are used for getting or retrieving information, settings, or specific components. These functions are categorized by their return types or the context in which they are used.

```APIDOC
## Get()

### Description
Retrieves a Localization, PropertyReference, or UIEventListener, or UIKeyNavigation.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None explicitly documented.

### Response
- Localization | PropertyReference | UIEventListener | UIKeyNavigation: The retrieved object.

## Get< T >()

### Description
Retrieves NGUISettings of a specific type T.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- T (Type): The type of setting to retrieve.

### Response
- NGUISettings: The retrieved settings object.

## GetActive()

### Description
Retrieves the active NGUITools instance.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- NGUITools: The active NGUITools instance.

## GetActiveToggle()

### Description
Retrieves the currently active UIToggle.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UIToggle: The active UIToggle.

## GetApproximateCharacterIndex()

### Description
Calculates the approximate character index within a UILabel based on position.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The approximate character index.

## GetAtlasSprite()

### Description
Retrieves a sprite from a UIAtlas.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- UISprite: The sprite from the atlas.

## GetAxisFunc()

### Description
Retrieves the axis function from a UICamera.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Func<System.String,System.Single>: The axis function.

## GetBool()

### Description
Retrieves a boolean setting from NGUISettings.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Boolean: The boolean setting value.

## GetCamera()

### Description
Retrieves the UIRectEditor camera.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- Camera: The UIRectEditor camera.

## GetCenter()

### Description
Retrieves the center point for UIKeyNavigation.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector2: The center point.

## GetCharacterIndex()

### Description
Gets the character index at a specific position within a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The character index.

## GetCharacterIndexAtPosition()

### Description
Gets the character index at a specific position within a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The character index.

## GetCharUnderMouse()

### Description
Gets the character under the mouse cursor in a UIInput.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Char: The character under the mouse.

## GetChild()

### Description
Retrieves a child element from a UIGrid.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- Transform: The child transform.

## GetChildList()

### Description
Retrieves the list of children from a UIGrid or UITable.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- BetterList<Transform>: A list of child transforms.

## GetClassID()

### Description
Retrieves the class ID for NGUIEditorTools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Int32: The class ID.

## GetClassID< T >()

### Description
Retrieves the class ID of a generic type T for NGUIEditorTools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- T (Type): The type for which to get the class ID.

### Response
- System.Int32: The class ID.

## GetColor()

### Description
Retrieves a color setting from NGUISettings.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- UnityEngine.Color: The color setting value.

## GetDescription()

### Description
Retrieves the description of an InvStat.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The description.

## GetDown()

### Description
Retrieves the UIKeyNavigation element below the current one.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UIKeyNavigation: The UIKeyNavigation element below.

## GetEndOfLineThatFits()

### Description
Calculates the end of the line that fits within the bounds of NGUIText.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The index of the end of the line that fits.

## GetEnum< T >()

### Description
Retrieves an enumeration value of type T from NGUISettings.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- T (Type): The type of enumeration to retrieve.

### Response
- T: The retrieved enumeration value.

## GetEnumerator()

### Description
Returns an enumerator for a BetterList<T>.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Collections.IEnumerator: The enumerator.

## GetExactCharacterIndex()

### Description
Calculates the exact character index within a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The exact character index.

## GetFaces()

### Description
Retrieves the faces of a FreeType object.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Collections.Generic.List<UnityEngine.Vector3>: A list of faces.

## GetFloat()

### Description
Retrieves a float setting from NGUISettings.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Single: The float setting value.

## GetFuncName()

### Description
Retrieves the function name from NGUITools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The function name.

## GetGlyph()

### Description
Retrieves a glyph from a BMFont or NGUIText.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- BMGlyph: The retrieved glyph.

## GetGlyphWidth()

### Description
Calculates the width of a glyph in NGUIText.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The glyph width.

## GetHandles()

### Description
Retrieves the handles from a UIWidgetInspector.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector3[]: An array of handles.

## GetHashCode()

### Description
Calculates the hash code for an EventDelegate or PropertyReference.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Int32: The hash code.

## GetHelpURL()

### Description
Retrieves the help URL from NGUIHelp.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The help URL.

## GetHierarchy()

### Description
Retrieves the hierarchy information from NGUITools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The hierarchy information.

## GetIndex()

### Description
Retrieves the index of an item in a UIGrid.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The index of the item.

## GetInt()

### Description
Retrieves an integer setting from NGUISettings.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Int32: The integer setting value.

## GetItem()

### Description
Retrieves an item from an InvEquipment or UIItemStorage.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.Object: The retrieved item.

## GetKerning()

### Description
Retrieves kerning information from a BMGlyph.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Single: The kerning value.

## GetKeyStateFunc()

### Description
Retrieves the key state function from UICamera.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Func<System.String,System.Boolean>: The key state function.

## getLastErrorIndex()

### Description
Retrieves the last error index from NGUIJson.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Int32: The last error index.

## getLastErrorSnippet()

### Description
Retrieves the last error snippet from NGUIJson.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The last error snippet.

## getLastIndexOfNumber()

### Description
Retrieves the last index of a number from NGUIJson.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Int32: The last index of the number.

## GetLeft()

### Description
Retrieves the UIKeyNavigation element to the left.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UIKeyNavigation: The UIKeyNavigation element to the left.

## GetLeftText()

### Description
Retrieves the left text from a UIInput.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The left text.

## GetListOfSprites()

### Description
Retrieves a list of sprites from a UIAtlas.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Collections.Generic.List<UISpriteData>: A list of sprites.

## GetLocalPos()

### Description
Retrieves the local position of a UIRect.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector2: The local position.

## GetMethods()

### Description
Retrieves the methods from an EventDelegateEditor.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Reflection.MethodInfo[]: An array of method information.

## GetMouse()

### Description
Retrieves the mouse input from UICamera.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UICamera.MouseScheme: The mouse input scheme.

## GetName()

### Description
Retrieves the name of an InvStat.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The name.

## GetNames()

### Description
Retrieves names from an EventDelegateEditor or PropertyReferenceDrawer.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String[]: An array of names.

## GetPivot()

### Description
Retrieves the pivot point of a NGUIMath object.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector2: The pivot point.

## GetPivotOffset()

### Description
Retrieves the pivot offset from NGUIMath.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector2: The pivot offset.

## GetPivotUnderMouse()

### Description
Retrieves the UIWidgetInspector pivot under the mouse.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UIWidgetInspector.Pivot: The pivot under the mouse.

## GetPixelSizeAdjustment()

### Description
Retrieves the pixel size adjustment from UIRoot.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Single: The pixel size adjustment.

## GetProperties()

### Description
Retrieves properties from a PropertyReferenceDrawer.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Reflection.PropertyInfo[]: An array of property information.

## GetPropertyHeight()

### Description
Retrieves the height of a property from an EventDelegateDrawer or PropertyReferenceDrawer.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Single: The property height.

## GetPropertyType()

### Description
Retrieves the type of a property from a PropertyReference.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Type: The property type.

## GetRect()

### Description
Retrieves the rect from a UIRectEditor.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Rect: The rect.

## GetRightText()

### Description
Retrieves the right text from a UIInput.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The right text.

## GetRoot()

### Description
Retrieves the root object from NGUITools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.GameObject: The root GameObject.

## GetSaveableTexturePath()

### Description
Retrieves the saveable texture path from NGUIEditorTools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The saveable texture path.

## GetScreenDistance()

### Description
Retrieves the screen distance from a UIWidgetInspector.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.Single: The screen distance.

## GetSelection()

### Description
Retrieves the current selection from UIInput.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UIInput: The selected UIInput.

## GetSelectionFolder()

### Description
Retrieves the selection folder from NGUIEditorTools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The selection folder path.

## GetSides()

### Description
Retrieves the sides of a UI element (NGUITools, UILabel, UIPanel, UIRect.AnchorPoint, UIRect, UIWidget).

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector3[]: An array representing the sides.

## GetSprite()

### Description
Retrieves a sprite from a UIAtlas.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- UISpriteData: The sprite data.

## GetString()

### Description
Retrieves a string setting from NGUISettings.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.String: The string setting value.

## GetSymbol()

### Description
Retrieves a symbol from NGUIText.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The symbol.

## GetTouch()

### Description
Retrieves the touch input from UICamera.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UICamera.TouchScheme: The touch input scheme.

## GetTypeName()

### Description
Retrieves the type name from NGUITools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- System.String: The type name.

## GetTypeName< T >()

### Description
Retrieves the type name of a generic type T from NGUITools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- T (Type): The type for which to get the name.

### Response
- System.String: The type name.

## GetUp()

### Description
Retrieves the UIKeyNavigation element above.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UIKeyNavigation: The UIKeyNavigation element above.

## GetUrlAtCharacterIndex()

### Description
Retrieves the URL at a specific character index in a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.String: The URL.

## GetUrlAtPosition()

### Description
Retrieves the URL at a specific position in a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.String: The URL.

## GetViewSize()

### Description
Retrieves the view size of a UIPanel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector2: The view size.

## GetWordAtCharacterIndex()

### Description
Retrieves the word at a specific character index in a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.String: The word.

## GetWordAtPosition()

### Description
Retrieves the word at a specific position in a UILabel.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- System.String: The word.

## GetWorldCorners()

### Description
Retrieves the world corners of a NGUITools object.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
None.

### Response
- UnityEngine.Vector3[]: An array of world corner positions.

## GUIDToObject()

### Description
Converts a GUID to an object using NGUIEditorTools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- None explicitly documented.

### Response
- UnityEngine.Object: The converted object.

## GUIDToObject< T >()

### Description
Converts a GUID to an object of type T using NGUIEditorTools.

### Method
GET (implied)

### Endpoint
N/A (SDK/Library Function)

### Parameters
- T (Type): The type of object to convert to.

### Response
- T: The converted object.
```

--------------------------------

### ShowEditorStyles.Init

Source: https://www.tasharen.com/ngui/docs/class_show_editor_styles.html

Initializes the ShowEditorStyles system. This is a static method that can be called without an instance of the class.

```APIDOC
## Init

### Description
Initializes the ShowEditorStyles system.

### Method
static void

### Parameters
None
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_scroll_view.html

Sets the initial drag value and registers listener delegates.

```APIDOC
## Start UIScrollView.Start()

### Description
Set the initial drag value and register the listener delegates.

### Method
virtual void

### Endpoint
N/A (Member Function)
```

--------------------------------

### Init

Source: https://www.tasharen.com/ngui/docs/class_u_i_table.html

Finds and initializes necessary components for the UITable.

```APIDOC
## Init

### Description
Find the necessary components.

### Method
POST

### Endpoint
/UITable/Init
```

--------------------------------

### GUID Conversion Methods

Source: https://www.tasharen.com/ngui/docs/class_g_u_i_d-members.html

Static methods for converting between objects and GUIDs.

```APIDOC
## FromObject(Object obj)

### Description
Converts an object to its GUID representation.

### Method
static

### Parameters
#### Path Parameters
- **obj** (Object) - The object to convert.

### Response
#### Success Response (GUID)
- Returns the GUID representation of the object.

## ToObject(string guid)

### Description
Converts a GUID string to its object representation.

### Method
static

### Parameters
#### Path Parameters
- **guid** (string) - The GUID string to convert.

### Response
#### Success Response (Object)
- Returns the object representation of the GUID.
```

--------------------------------

### SpringPosition.Begin

Source: https://www.tasharen.com/ngui/docs/class_spring_position-members.html

Initializes a new SpringPosition instance.

```APIDOC
## Begin(GameObject go, Vector3 pos, float strength)

### Description
Initializes a new SpringPosition instance with the specified game object, position, and strength.

### Method
static Begin

### Parameters
- **go** (GameObject) - The game object to apply the spring position to.
- **pos** (Vector3) - The target position for the spring.
- **strength** (float) - The strength of the spring.

### Return Value
SpringPosition
```

--------------------------------

### TweenTransform.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_transform-members.html

Static method to start a transform tween animation. Overloads allow specifying only the target transform or both start and end transforms.

```APIDOC
## TweenTransform.Begin

### Description
Starts a transform tween animation. There are overloads to specify the target transform, or both the starting and ending transforms.

### Method
static TweenTransform Begin(GameObject go, float duration, Transform to)

### Parameters
- **go** (GameObject) - The GameObject to animate.
- **duration** (float) - The duration of the tween.
- **to** (Transform) - The target transform.

### Method
static TweenTransform Begin(GameObject go, float duration, Transform from, Transform to)

### Parameters
- **go** (GameObject) - The GameObject to animate.
- **duration** (float) - The duration of the tween.
- **from** (Transform) - The starting transform.
- **to** (Transform) - The target transform.
```

--------------------------------

### delay

Source: https://www.tasharen.com/ngui/docs/class_u_i_tweener-members.html

The delay before the tween starts.

```APIDOC
## delay

### Description
Property that gets or sets the delay in seconds before the tween starts.

### Type
`float`
```

--------------------------------

### NGUIHelp.Show (no arguments)

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_help.html

Displays generic help information.

```APIDOC
## NGUIHelp.Show ()

### Description
Show generic help.

### Method
static void
```

--------------------------------

### UIRect.OnStart

Source: https://www.tasharen.com/ngui/docs/class_u_i_rect.html

An abstract protected method for start functionality, ensuring it happens after anchor rect references are set. It must be implemented by derived classes.

```APIDOC
## OnStart

### Description
Abstract start functionality, ensured to happen after the anchor rect references have been set.

### Method
protected pure virtual
```

--------------------------------

### TweenTransform.from

Source: https://www.tasharen.com/ngui/docs/class_tween_transform-members.html

The starting transform for the tween.

```APIDOC
## TweenTransform.from

### Description
The starting transform for the tween.

### Property
Transform from
```

--------------------------------

### TweenRotation.from

Source: https://www.tasharen.com/ngui/docs/class_tween_rotation-members.html

The starting rotation of the tween.

```APIDOC
## from

### Description
This property represents the initial rotation value from which the tween will animate. It is typically set automatically when the tween begins, but can also be set manually.
```

--------------------------------

### TweenHeight.from

Source: https://www.tasharen.com/ngui/docs/class_tween_height-members.html

The starting height of the tween.

```APIDOC
## TweenHeight.from

### Description
The starting height of the tween.

### Type
TweenHeight
```

--------------------------------

### TweenColor.from

Source: https://www.tasharen.com/ngui/docs/class_tween_color-members.html

The starting color of the tween.

```APIDOC
## from

### Description
Gets or sets the starting color of the tween.

### Type
Color
```

--------------------------------

### Root

Source: https://www.tasharen.com/ngui/docs/class_u_i_basic_sprite.html

Gets the root object, if any.

```APIDOC
## root

### Description
Get the root object, if any.

### Type
UIRoot

### Access
Read-only
```

--------------------------------

### TweenFOV.from

Source: https://www.tasharen.com/ngui/docs/class_tween_f_o_v-members.html

The starting Field of View value.

```APIDOC
## from

### Description
Gets or sets the starting Field of View value for the tween.

### Type
float
```

--------------------------------

### Begin<T> (Static Generic)

Source: https://www.tasharen.com/ngui/docs/class_tween_width.html

Starts a generic tweening operation on a GameObject.

```APIDOC
## Begin<T> (Static Generic)

### Description
Starts a generic tweening operation on a GameObject. This is a base method for various tween types.

### Method
static T Begin<T>(GameObject go, float duration)

### Parameters
- **go** (GameObject) - The GameObject to apply the tween to.
- **duration** (float) - The duration of the tween in seconds.

### Returns
- **T** - The instantiated tween object.
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_scroll_view.html

Initializes the scroll view by setting the drag value and registering listener delegates.

```APIDOC
## Start

### Description
Set the initial drag value and register the listener delegates.

### Signature
`virtual void Start()`
```

--------------------------------

### GUIDToObject

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_editor_tools.html

Converts a GUID to an object reference.

```APIDOC
## GUIDToObject (Object overload)

### Description
Convert the specified GUID to an object reference.

### Signature
`static Object GUIDToObject(string guid)`
```

```APIDOC
## GUIDToObject (Generic overload)

### Description
Convert the specified GUID to an object reference of specified type.

### Signature
`static T GUIDToObject<T>(string guid)`
```

--------------------------------

### Init

Source: https://www.tasharen.com/ngui/docs/class_u_i_input.html

Initializes the input component. Labels used for input shouldn't support rich text.

```APIDOC
## Init

### Description
Initializes the input component. Labels used for input shouldn't support rich text.

### Method
void

### Parameters
None
```

--------------------------------

### UIRoot root

Source: https://www.tasharen.com/ngui/docs/class_u_i_rect.html

Gets the root UIRoot, if any.

```APIDOC
## UIRoot root

### Description
Gets the root UIRoot, if any.

### Get
`root`
```

--------------------------------

### UIRect parent

Source: https://www.tasharen.com/ngui/docs/class_u_i_rect.html

Gets the parent UIRect, if any.

```APIDOC
## UIRect parent

### Description
Gets the parent UIRect, if any.

### Get
`parent`
```

--------------------------------

### Init

Source: https://www.tasharen.com/ngui/docs/functions_func_i.html

Initializes various NGUI components. Belongs to ShowEditorStyles, UIGrid, UIInput, UITable, UITexturePacker.

```APIDOC
## Init()

### Description
Initializes the component or system. This function is available on multiple classes including ShowEditorStyles, UIGrid, UIInput, UITable, and UITexturePacker.

### Method
(Not specified, likely an instance or static method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None specified.

### Response
(Not specified, typically initializes internal states.)

### Example
```APIDOC
UIGrid grid = new UIGrid();
grid.Init();
```
```

--------------------------------

### Parent

Source: https://www.tasharen.com/ngui/docs/class_u_i_basic_sprite.html

Gets the rectangle's parent, if any.

```APIDOC
## parent

### Description
Get the rectangle's parent, if any.

### Type
UIRect

### Access
Read-only
```

--------------------------------

### Begin (GameObject, duration, rot)

Source: https://www.tasharen.com/ngui/docs/class_tween_rotation.html

Starts a new rotation tween operation.

```APIDOC
## Begin

### Description
Start the tweening operation for rotation.

### Method
static TweenRotation

### Parameters
- **go** (GameObject) - The GameObject to tween.
- **duration** (float) - The duration of the tween.
- **rot** (Quaternion) - The target rotation.

### Returns
TweenRotation - The created tween object.
```

--------------------------------

### texture

Source: https://www.tasharen.com/ngui/docs/class_u_i_atlas.html

Gets the texture used by the atlas.

```APIDOC
## texture

### Description
Texture used by the atlas.

### Signature
Texture texture { get; }
```

--------------------------------

### Init Method

Source: https://www.tasharen.com/ngui/docs/class_u_i_texture_packer.html

Initializes or re-initializes the UITexturePacker with specified dimensions and rotation settings.

```APIDOC
## void UITexturePacker.Init

### Description
Initializes or re-initializes the texture packer.

### Parameters
- **_width_** (int) - The width of the texture bin.
- **_height_** (int) - The height of the texture bin.
- **_rotations_** (bool) - Whether to allow texture rotations.
```

--------------------------------

### OnInit

Source: https://www.tasharen.com/ngui/docs/class_u_i_label.html

Protected virtual method called during initialization to register the font texture change listener.

```APIDOC
## UILabel.OnInit

### Description
Register the font texture change listener.

### Method
`OnInit()

```

--------------------------------

### Toggle

Source: https://www.tasharen.com/ngui/docs/class_tween_volume.html

Starts the tweening process, reversing its direction.

```APIDOC
## Toggle

### Description
Manually start the tweening process, reversing its direction.

### Method
void

### Parameters
None
```

--------------------------------

### TweenWidth.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_width.html

Starts a tweening operation for the width of a UIWidget.

```APIDOC
## TweenWidth.Begin

### Description
Starts the tweening operation for a UIWidget's width.

### Method
static TweenWidth

### Parameters
- **_widget_** (UIWidget) - The UI widget whose width will be tweened.
- **_duration_** (float) - The duration of the tweening operation.
- **_width_** (int) - The target width to tween to.
```

--------------------------------

### UIRect.Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_rect.html

A protected method to set anchor rect references on start. Derived classes should typically override OnInit or OnStart.

```APIDOC
## Start

### Description
Set anchor rect references on start.

### Method
protected
```

--------------------------------

### Init

Source: https://www.tasharen.com/ngui/docs/class_u_i_grid.html

Initializes the grid. This is a protected virtual method called once during the grid's lifecycle.

```APIDOC
## Init

### Description
Initialize the grid. Executed only once.

### Signature
virtual void Init()
```

--------------------------------

### Play

Source: https://www.tasharen.com/ngui/docs/class_tween_rotation.html

Starts or resumes the tween's playback.

```APIDOC
## Play

### Description
Play the tween. If the tween is paused or has been reset, this will resume playback.

### Method
void

### Parameters
None

### Returns
None
```

--------------------------------

### Start

Source: https://www.tasharen.com/ngui/docs/class_u_i_grid.html

Caches necessary components and resets the initial position of all children. This is a protected virtual method.

```APIDOC
## Start

### Description
Cache everything and reset the initial position of all children.

### Signature
virtual void Start()
```

--------------------------------

### InvGameItem Constructors

Source: https://www.tasharen.com/ngui/docs/class_inv_game_item-members.html

Provides information on how to instantiate an InvGameItem object.

```APIDOC
## InvGameItem Constructors

### Description
Constructors for creating `InvGameItem` instances.

### Method Signatures
- `InvGameItem(int id)`
- `InvGameItem(int id, InvBaseItem bi)`
```

--------------------------------

### NGUIHelp.Show (object obj)

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_help.html

Displays help information for a specific topic related to an object.

```APIDOC
## NGUIHelp.Show (object obj)

### Description
Show help for the specific topic.

### Method
static void

### Parameters
#### Path Parameters
- **obj** (object) - Required - The object for which to show help.
```

--------------------------------

### TweenHeight.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_height-members.html

Starts a height tween animation on a UIWidget.

```APIDOC
## TweenHeight.Begin

### Description
Starts a height tween animation on a UIWidget.

### Method
static TweenHeight

### Parameters
#### Path Parameters
- **widget** (UIWidget) - The UIWidget to animate.
- **duration** (float) - The duration of the animation.
- **height** (int) - The target height for the animation.
```

--------------------------------

### TweenPosition.Begin (GameObject, float, Vector3)

Source: https://www.tasharen.com/ngui/docs/class_tween_position.html

Starts a position tweening operation for a given GameObject.

```APIDOC
## TweenPosition.Begin (GameObject, float, Vector3)

### Description
Starts the tweening operation for a GameObject's position.

### Method Signature
`static TweenPosition TweenPosition.Begin(GameObject _go, float _duration, Vector3 _pos)`

### Parameters
- `_go` (GameObject) - The GameObject to tween.
- `_duration` (float) - The duration of the tween.
- `_pos` (Vector3) - The target position.
```

--------------------------------

### TweenColor.Begin

Source: https://www.tasharen.com/ngui/docs/class_tween_color-members.html

Starts a new color tween animation.

```APIDOC
## Begin(GameObject go, float duration, Color color)

### Description
Starts a new color tween animation on the specified GameObject.

### Method
static TweenColor

### Parameters
- **go** (GameObject) - The GameObject to animate.
- **duration** (float) - The duration of the tween in seconds.
- **color** (Color) - The target color to tween to.
```

--------------------------------

### NGUIText.Prepare

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_text.html

Prepares the NGUIText system for rendering the specified text.

```APIDOC
## NGUIText.Prepare

### Description
Prepare to use the specified text.

### Method
static void

### Parameters
- **_text_** (string) - The text to prepare for.
```

--------------------------------

### NGUIContextMenu.AddHelp

Source: https://www.tasharen.com/ngui/docs/class_n_g_u_i_context_menu.html

Adds help options to the context menu based on the components of a specified game object.

```APIDOC
## AddHelp

### Description
Add help options based on the components present on the specified game object.

### Method
static void

### Parameters
#### Path Parameters
- **go** (GameObject) - Required - The GameObject to inspect for components.
- **addSeparator** (bool) - Required - Whether to add a separator before the help items.
```

--------------------------------

### lineHeight

Source: https://www.tasharen.com/ngui/docs/class_u_i_text_list.html

Gets the height of each line in the text list.

```APIDOC
## lineHeight

### Description
Height of each line.

### Type
float

### Access
get
```
Tokens:
Raw