FairyGUI

https://www.fairygui.com/docs
Admin
FairyGUI is a UI editor for creating and managing user interface projects, offering tools for...
Tokens:52,279
Snippets:806
Trust Score:8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Load External Resources

Source: https://www.fairygui.com/docs/editor/loader

Examples of setting the URL for external resources across different platforms.

```text
// AS3, load a network image
    aLoader.url = "http://www.fairygui.com/logo.png";

    // Egret, here demoRes is a resource defined in resources.json
    aLoader.url = "demoRes";

    // Unity, here is a texture with the path Assets / Resources / demo / aimage
    aLoader.url = "demo/aimage";
```

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

### TypeScript Plugin API Examples

Source: https://www.fairygui.com/docs/editor/plugin

Examples for interacting with C# classes, handling publishing lifecycle events, and performing HTTP requests in TypeScript plugins.

```typescript
//Introduce C# class
const FairyEditor = CS.FairyEditor;

//Publish start notification
export function onPublishStart(pkgs: CS.System.Array$1<CS.FairyEditor.FPackage>) {
     console.log(pkgs.get_Item(0).name);
}

//Publish end notification
export function onPublishEnd(pkgs: CS.System.Array$1<CS.FairyEditor.FPackage>) {
     console.log(pkgs.get_Item(0).name);
}

//Initiate an http request
async function httpGetSample() {
     let client = new CS.System.Net.Http.HttpClient()
     var responseString = await puerts.$promise(client.GetStringAsync("http:/example.com/"));
     console.log(responseString);
}
```

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

### Setup UI Graphic Holder

Source: https://www.fairygui.com/docs/unity/insert3d

Retrieve the graphic component in the UI to act as a placeholder for the 3D object.

```csharp
GGraph holder = view.GetChild("holder").asGraph;
```

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

### Implementing VR Controller Input

Source: https://www.fairygui.com/docs/unity/input

Example of passing SteamVR controller data into FairyGUI's custom input system within the Update loop.

```csharp
SteamVR_TrackedObject controller;
SteamVR_Controller.Device controllerDevice;

void Start()
{
    controller = ...
    controllerDevice = ...
}

void Update() 
{
    Vector3 pos = controller.transform.position;
    Vector3 dir = controller.transform.forward;
    bool trigger_down = controllerDevice.GetPress(Valve.VR.EVRButtonId.k_EButton_SteamVR_Trigger);

    RaycastHit rh;
    if (Physics.Raycast(pos, dir, out rh))
    {
        Stage.inst.SetCustomInput(rh, trigger_down);
    }
}
```

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

### Configure Loop Playback

Source: https://www.fairygui.com/docs/editor/movieclip

Define loop settings including start frame, end frame, and repeat count.

```C#
aMovie.SetPlaySettings(0, -1, 0, -1);
```

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

### Initialize and Create UI with Binding Classes

Source: https://www.fairygui.com/docs/editor/publish

Demonstrates the mandatory initialization of the binder class and the correct method for instantiating UI components.

```text
// First call BindAll. The released code has a file named XXXBinder
    // Note: Be sure to call it at startup.
    XXXBinder.BindAll ();

    // Create UI interface. Note: Not directly new XXX.
    XXX view = XXX.CreateInstance ();
    view.m_n10.text = ...;
```

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

### Create and display UI components synchronously

Source: https://www.fairygui.com/docs/unity/index

Demonstrates creating a component from a package and adding it to the root, a window, or another component.

```csharp
GComponent view = UIPackage.CreateObject ("package name", "component name").asCom;
	
	// The following methods can display the view:
	
	// 1, directly added to GRoot and displayed
	GRoot.inst.AddChild (view);
	
	// 2, use window display
	aWindow.contentPane = view;
	aWindow.Show ();
	
	// 3, add to other components
	aComponnent.AddChild (view);
```

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

### Create and display a window

Source: https://www.fairygui.com/docs/editor/window

Instantiate a new window and assign a UI component as its content pane before calling Show.

```C#
Window win = new Window ();
    win.contentPane = UIPackage.CreateObject ("package name", "content component name"). asCom;
    win.Show ();
```

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

### Get Input Position

Source: https://www.fairygui.com/docs/unity/input

Retrieve the current mouse or finger position outside of an event callback.

```csharp
// This is the position of the mouse, or the position of the last finger
		Vector2 pos1 = Stage.inst.touchPosition;

		// Get the specified finger position, the parameter is the finger id
		Vector2 pos2 = Stage.inst.GetTouchPosition (1);
```

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

### Create and Display UI Components

Source: https://www.fairygui.com/docs/sdk/creator

Demonstrates creating a component from a package and adding it to the display list via GRoot, a window, or another component.

```typescript
let view: fgui.GComponent = fgui.UIPackage.createObject ("package name", "component name"). asCom;
		
		// The following methods can display the view:
		
		// 1, directly added to GRoot and displayed
		fgui.GRoot.inst.addChild (view);
		
		// 2, use window display
		aWindow.contentPane = view;
		aWindow.show ();
		
		// 3, add to other components
		aComponnent.addChild (view);
```

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

### Load UI Package from Resources or Path

Source: https://www.fairygui.com/docs/unity/index

Demonstrates loading packages from the Resources directory or a specific file path.

```csharp
UIPackage.AddPackage ("demo");
// if in a subdirectory  
UIPackage.AddPackage ("path/demo");
// If you do not put it in Resources or its subdirectories, you can pass in the full path, but this method can only be used in Editor  
UIPackage.AddPackage ("Assets/SomePath/Package1");
```

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

### UBB Color Gradient Syntax

Source: https://www.fairygui.com/docs/editor/text

Examples of using UBB color tags for vertical, horizontal, or multi-directional color transitions.

```text
// Specify two colors for up and down transition



[color = # FFFFFF, # 000000] text [/ color]
// Specify four colors can do left and right transition or two-direction transition  
[color = # FFFFFF, # CCCCCC, # 000000, # FFFF00] text [/ color]
```

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

### Create UI components

Source: https://www.fairygui.com/docs/sdk/cryengine

Instantiate UI components and display them by adding them to GRoot, a window, or another component.

```csharp
GComponent view = UIPackage.CreateObject ("package name", "component name").asCom;
    
    // The following methods can display the view:
    
    // 1, directly added to GRoot and displayed
    GRoot.inst.AddChild (view);
    
    // 2, use window display
    aWindow.contentPane = view;
    aWindow.Show ();
    
    // 3, add to other components
    aComponnent.AddChild (view);
```

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

### Retrieve Mouse or Touch Position

Source: https://www.fairygui.com/docs/sdk/cryengine

Get the current mouse position or the position of a specific finger using the Stage instance.

```csharp
// This is the position of the mouse, or the position of the last finger
    Vector2 pos1 = Stage.inst.touchPosition;

    // Get the specified finger position, the parameter is the finger id
    Vector2 pos2 = Stage.inst.GetTouchPosition (1);
```

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

### Load and Create Package Objects

Source: https://www.fairygui.com/docs/editor/publish

Use the published file name to load the package and the package name to instantiate components.

```csharp
// here file_name is the name of the published file.
    UIPackage.AddPackage ('file_name');

    // Here Package1 is the name of the package.
    UIPackage.CreateObject ("Package1 ',' Component1 ');
```

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

### Handle drag lifecycle events

Source: https://www.fairygui.com/docs/editor/dragdrop

Register callbacks for drag start, move, and end events across various supported platforms.

```text
//Unity/Cry
    aObject.onDragStart.Add(onDragStart);
    aObject.onDragMove.Add(onDragMove);
    aObject.onDragEnd.Add(onDragEnd);

    //AS3
    aObject.addEventListener(DragEvent.DRAG_START, onDragStart);
    aObject.addEventListener(DragEvent.DRAG_MOVING, onDragMove);
    aObject.addEventListener(DragEvent.DRAG_END, onDragEnd);

    //Egret
    aObject.addEventListener(fairygui.DragEvent.DRAG_START, this.onDragStart, this);
    aObject.addEventListener(fairygui.DragEvent.DRAG_MOVING, this.onDragMove, this);
    aObject.addEventListener(fairygui.DragEvent.DRAG_END, this.onDragEnd, this);

    //Laya
    aObject.on(fairygui.Events.DRAG_START, this, this.onDragStart);
    aObject.on(fairygui.Events.DRAG_MOVE, this, this.onDragMove);
    aObject.on(fairygui.Events.DRAG_END, this, this.onDragEnd);

    //Cocos2dx
    aObject->addEventListener(UIEventType::DragStart, CC_CALLBACK_1(AClass::onDragStart, this));
    aObject->addEventListener(UIEventType::DragMove, CC_CALLBACK_1(AClass::onDragMove, this));
    aObject->addEventListener(UIEventType::DragEnd, CC_CALLBACK_1(AClass::onDragEnd, this));

    //CocosCreator
    aObject.on(fgui.Event.DRAG_START, this.onDragStart, this);
    aObject.on(fgui.Event.DRAG_MOVING, this.onDragMove, this);
    aObject.on(fgui.Event.DRAG_END, this.onDragEnd, this);
```

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

### Instantiate a GImage

Source: https://www.fairygui.com/docs/editor/image

Create a GImage instance from a UI package.

```C#
GImage aImage = UIPackage.CreateObject("package name", "image name").asImage;
```

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

### Incorrect GList removal usage

Source: https://www.fairygui.com/docs/editor/list

Example of improper removal where objects are added from the pool but removed without returning them, causing memory leaks.

```csharp
for(int i=0;i<10;i++)
        aList.AddItemFromPool();

    aList.RemoveChildren();
```

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

### Incorrect GList object pool usage

Source: https://www.fairygui.com/docs/editor/list

Example of improper pool management where objects are created manually but returned to the pool, leading to pool growth.

```csharp
GObject obj = UIPackage.CreateObject(...);
    aList.AddChild(obj);
    
    aList.RemoveChildrenToPool();
```

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

### Initialize GLoader

Source: https://www.fairygui.com/docs/editor/loader

GLoader requires explicit size settings to be displayed correctly.

```csharp
GLoader aLoader = new GLoader ();
    aLoader.SetSize (100,100);
    aLoader.url = "ui://package name/image name";
```

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

### GMovieClip Instantiation

Source: https://www.fairygui.com/docs/editor/movieclip

How to create a new GMovieClip instance from a UI package.

```APIDOC
## GMovieClip.CreateObject

### Description
Instantiates a GMovieClip object from a specified UI package.

### Method
`UIPackage.CreateObject(packageName, movieClipName).asMovieClip`

### Parameters
- **packageName** (string) - The name of the UI package.
- **movieClipName** (string) - The name of the movieclip asset.
```

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

### Dynamically Create a GComponent

Source: https://www.fairygui.com/docs/editor/component

Instantiate an empty component and add it to the root display list.

```csharp
   GComponent = new GComponent ();  
	   gcom.SetSize (100,100);
	   GRoot.inst.AddChild (com);
```

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

### Create Component from UI Package

Source: https://www.fairygui.com/docs/editor/component

Load a pre-defined component from a specific package and add it to the display list.

```csharp
   GComponent com = UIPackage.CreateObject ("Package Name", "Component Name").asCom;
	   GRoot.inst.AddChild (com);
```

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

### Initialize FairyGUI in Egret

Source: https://www.fairygui.com/docs/sdk/egret

Set up the UI package, default fonts, scroll bars, and root display object within the game scene creation method.

```typescript
/**
   * 创建游戏场景
   * Create a game scene
   */
  private createGameScene():void {
      fairygui.UIPackage.addPackage("basic");
      
      fairygui.UIConfig.defaultFont = "宋体";
      fairygui.UIConfig.verticalScrollBar = fairygui.UIPackage.getItemURL("Basic", "ScrollBar_VT");
      fairygui.UIConfig.horizontalScrollBar = fairygui.UIPackage.getItemURL("Basic", "ScrollBar_HZ");
      fairygui.UIConfig.popupMenu = fairygui.UIPackage.getItemURL("Basic", "PopupMenu");
      fairygui.UIConfig.buttonSound = fairygui.UIPackage.getItemURL("Basic","click");
      
      this.stage.addChild(fairygui.GRoot.inst.displayObject);

      this.mainPanel = new MainPanel();
 }
```

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

### Command line publishing syntax

Source: https://www.fairygui.com/docs/editor/publish

Use this command structure to trigger a project publish from the terminal.

```bash
FairyGUI-Editor -p project_desc_file [-b package_names] [-t branch_name] [-x callback] [-o output_path]
```

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

### Create and Manage Popup Menus

Source: https://www.fairygui.com/docs/editor/popup

Instantiate a PopupMenu, add items with callbacks, and manage menu properties like width and item state.

```csharp
// If the constructor takes no parameters, it means using the resources defined in UIConfig.popupMenu.
	/ / Can also take a parameter, specify the menu component resources used by this menu
	PopupMenu menu = new PopupMenu ();

	// If you want to modify the width of the menu.
	menu.contentPane.width = 300;

	// Add a menu item and register the click callback function
	GButton item = menu.AddItem ("Title", MenuItemCallback);
	item.name = "item1";

	// click callback function, context.data is the item that is currently clicked
	void MenuItemCallback (EventContext context)
	{
		GButton item = (GButton) context.data);
		Debug.Log (item.name);
	}

	// CocosCreator version callback function, the first parameter is the clicked item
	MenuItemCallback (item, evt) {
	}

	// Add divider
	menu.AddSeperator ();

	// Setting menu items are grayed out
	menu.SetItemGrayed ("item1", true);
```

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

### Instantiate 3D Object

Source: https://www.fairygui.com/docs/unity/insert3d

Load and instantiate a 3D prefab for use within the UI.

```csharp
Object prefab = Resources.Load("Role/npc");
  GameObject go = (GameObject)Object.Instantiate(prefab);
```

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

### UIPackage.AddPackage

Source: https://www.fairygui.com/docs/sdk/cryengine

Loads a UI package into the system. The package should be published to the Assets directory or a subdirectory.

```APIDOC
## UIPackage.AddPackage(string packageName)

### Description
Loads a UI package from the Assets directory. The parameter should be the file name or the path relative to the Assets directory.

### Parameters
- **packageName** (string) - Required - The name or path of the package to load.
```

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

### Set Component to Full Screen with Relations

Source: https://www.fairygui.com/docs/editor/relation

Configures a component to match the screen size and maintain that relationship during screen resizing.

```csharp
aComponent.SetSize (GRoot.inst.width, GRoot.inst.height);
	// Keep the full screen when the screen changes. This sentence can also be ignored if the screen size is always the same
	aComoponet.AddRelation (GRoot.inst, RelationType.Size);
```

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

### Create Custom Component Extensions

Source: https://www.fairygui.com/docs/unity/lua

Defining and registering custom component extensions in Lua.

```lua
MyButton = fgui.extension_class (GButton)
  
  -Note that this is not a constructor, it is called when the component has been built

  function MyButton: ctor ()
  print (self: GetChild ('n1'))
  end
  
  -Add custom methods and fields
  function MyButton: Test ()
  print ('test')
  end
  
  local get = tolua.initget (MyButton)
  local set = tolua.initset (MyButton)
  get.myProp = function (self)
  return self._myProp
  end
  
  set.myProp = function (self, value)
  self._myProp = value
  self: GetChild ('n1'). text = value
  end
```

```lua
fgui.register_extension ("ui://package name/my button", MyButton)
```

```lua
local myButton = someComponent: GetChild ("myButton") --The resource of this myButton is "My Button"
  myButton: Test ()
  myButton.myProp = 'hello'
  
  local myButton2 = UIPackage.CreateObject ("package name", "my button")
  myButton2: Test ()
  myButton2.myProp = 'world'
```

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

### Accessing Resource Information at Runtime

Source: https://www.fairygui.com/docs/editor/package

Retrieve resource URLs, object names, and package ownership details using these properties and methods.

```csharp
// URL address of the object
	Debug.Log (aObject.resourceURL);

	// The name of the object in the resource library
	Debug.Log (aObject.packageItem.name);

	// The name of the package where the object is located
	Debug.Log (aObject.packageItem.owner.name);

	// Get the resource name based on the URL
	Debug.Log (UIPackage.GetItemByURL (resourceURL) .name);
```

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

### Configure Global Sound Settings

Source: https://www.fairygui.com/docs/faq

Methods to toggle sound and adjust volume globally, as UIConfig.buttonSoundVolume only applies during initialization.

```csharp
// Switch sound
    GRoot.inst.EnabledSound ();
    GRoot.inst.DisableSound ();

    // Adjust the global sound volume, this includes the button sound and the sound played by the effect
    GRoot.inst.soundVolume = 0.5f;
```

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

### Instantiate a GMovieClip

Source: https://www.fairygui.com/docs/editor/movieclip

Create a new GMovieClip instance using the UIPackage system.

```C#
GMovieClip aMovie = UIPackage.CreateObject ("package name", "movieclip name").asMovieClip;
```

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

### Extend Window Class

Source: https://www.fairygui.com/docs/unity/lua

Creating and extending a Window class in Lua using fgui.window_class.

```lua
WindowBase = fgui.window_class ()
    
    --Build function
    function WindowBase: ctor ()
    end
    
    --Overridable functions (optional, not necessarily required)
    function WindowBase: OnInit ()
        self.contentPane = UIPackage.CreateObject ("Basics", "WindowA");
    end
    
    function WindowBase: OnShown ()
    end
    
    function WindowBase: OnHide ()
    end
    
    function WindowBase: DoShowAnimation ()
        self: OnShown ();
    end
    
    function WindowBase: DoHideAnimation ()
        self: HideImmediately ();
    end

    --Create and display window
    local win = WindowBase.New ();
    win: Show ();
    
    You can also continue to inherit the Window class obtained above, for example:
    MyWindow = fgui.window_class (WindowBase)
    
    Calling the parent method in the inherited class:
    function MyWindow: OnInit ()
    WindowBase.OnInit (self)
    end
```

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

### Troubleshoot component creation failure

Source: https://www.fairygui.com/docs/faq

Error message indicating a failure to instantiate a UI component.

```text
Create Component1@Package1 failed!
```

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

### Instantiate Extended Component

Source: https://www.fairygui.com/docs/editor/component

Create an instance of the extended component and access its custom methods.

```csharp
MyComponent gcom = (MyComponent) UIPackage.CreateObject ("Package name", "Component A");
	gcom.ShowMessage ("Hello world");
```

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

### Enable FairyGUI Batching

Source: https://www.fairygui.com/docs/unity/drawcall

Toggle the depth adjustment optimization for a specific component.

```csharp
aComponent.fairyBatching = true;
```

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

### Configure Mini-Game Script

Source: https://www.fairygui.com/docs/sdk/egret

Add the necessary global reference for FairyGUI in the wxgame.ts script for mini-game platform compatibility.

```typescript
if(filename == "libs/fairygui/fairygui.js" || filename == "libs/fairygui/fairygui.min.js") {
      content += ";window.fairygui = fairygui;";
  }
```

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

### Configure Tooltips

Source: https://www.fairygui.com/docs/editor/object

Sets the global tooltip component path for the runtime environment.

```csharp
UIConfig.tooltipsWin = "ui://package name/component name";
```

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

### Show Popup Components

Source: https://www.fairygui.com/docs/editor/popup

Use GRoot.inst.ShowPopup to display components at specific positions or relative to other UI elements.

```csharp
// popup at current mouse position


GRoot.inst.ShowPopup (aComponent);
// pop up below aButton  
GRoot.inst.ShowPopup (aComponent, aButton);
// popup at custom position  
GRoot.inst.ShowPopup (aComponent);  
aComponent.SetXY (100, 100);
```

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

### Configure egretProperties.json

Source: https://www.fairygui.com/docs/sdk/egret

Add the FairyGUI and rawinflate libraries to the egretProperties.json file to include them in the project build.

```json
{
      "name": "rawinflate",
      "path": "./libs/rawinflate"
  },
  {
      "name": "fairygui",
      "path": "./libs/fairygui"
  }
```

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

### Configure Perspective Simulation

Source: https://www.fairygui.com/docs/editor/object

Enables perspective simulation for 2D UI objects to allow for 3D rotation effects.

```csharp
// Set the practical perspective simulation of the object

aObject.displayObject.perspective = true;  
// Can set camera distance  
aObject.displayObject.focalLength = 2000;
// At this time, rotating the X or Y axis can have a perspective effect.  
aObject.rotaionX = 30;
```

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

### UIPackage.CreateObject

Source: https://www.fairygui.com/docs/sdk/cryengine

Creates a UI component instance from a loaded package.

```APIDOC
## UIPackage.CreateObject(string packageName, string componentName)

### Description
Synchronously creates a GObject from the specified package and component name.

### Parameters
- **packageName** (string) - Required - The name of the package.
- **componentName** (string) - Required - The name of the component within the package.
```

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

### Creating and Adding Tree Nodes

Source: https://www.fairygui.com/docs/editor/tree

Instantiate a new GTreeNode and attach it to the tree's root node.

```csharp
GTreeNode aNode = new GTreeNode (true); // true indicates a folder node, false indicates a leaf node
rootNode.AddChild (aNode);
```

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

### UIPackage.CreateObjectAsync

Source: https://www.fairygui.com/docs/sdk/cryengine

Asynchronously creates a UI component to prevent frame freezes during heavy UI instantiation.

```APIDOC
## UIPackage.CreateObjectAsync(string packageName, string componentName, Action<GObject> callback)

### Description
Creates a UI component asynchronously. The creation process is spread across frames to maintain performance.

### Parameters
- **packageName** (string) - Required - The name of the package.
- **componentName** (string) - Required - The name of the component.
- **callback** (Action<GObject>) - Required - The callback function invoked when creation is complete.
```

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

### Register Component Extension

Source: https://www.fairygui.com/docs/editor/component

Bind the custom class to a specific UI package item. Registration must occur before the component is created.

```csharp
UIObjectFactory.SetPackageItemExtension ("ui:// package name / component A", typeof (MyComponent));
```

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

### Manage GComboBox items and selection

Source: https://www.fairygui.com/docs/editor/combobox

Demonstrates how to set items and values for a GComboBox and retrieve or set the current selection.

```csharp
GComboBox combo = gcom.GetChild ("n1").asComboBox;

	// items is an array of list item titles.
	combo.items = new string [] {"Item 1", "Item 2", ...};

	// values is optional and represents the value of each list item.
	combo.values = new string [] {"value1", "value2", ...};

	// Get the index of the currently selected item
	Debug.Log (combo.selectedIndex);

	// Get the value of the currently selected item.
	Debug.Log (combo.value);

	// Set the selected item by index
	combo.selectedIndex = 1;

	// Set the selected item by value
	combo.value = "value1";
```

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

### Load UI Package from Split AssetBundles

Source: https://www.fairygui.com/docs/unity/index

Loads a package split into separate definition and resource AssetBundles.

```csharp
 // desc_bundle and res_boundle are loaded by the developer.
	UIPackage.AddPackage (desc_bundle, res_bundle);
```

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

### Handle Events in Virtual List ItemRenderer (C#)

Source: https://www.fairygui.com/docs/editor/list

Demonstrates correct event listener management in C# to avoid memory leaks and excessive garbage collection.

```C#
void EventCallback()
    {
    }

    EventCallback0 callback = EventCallback;

    void OnRenderItem(int index, GObject obj)
    {
        GButton btn = obj.asCom.GetChild("btn").asButton;

        //错误！ Temporary functions will cause multiple callbacks to be added. Lua uses "function () end" similarly.
		btn.onClick.Add (() => {});

		// Yes, the same method will only be added once. But using the method name directly will generate tens of B of GC.
		btn.onClick.Add (EventCallback);

		// Correct, callback is a cached proxy instance and does not generate GC.
		btn.onClick.Add (callback);

		// Correct, use Set to ensure that it will not be added repeatedly.
		btn.onClick.Set (callback);

		//error! , You cannot use onClick.Set for ITEM, you need to use GList.onClickItem
		obj.onClick.Set (EventCallback);
    }
```

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

### Load Language Files at Runtime

Source: https://www.fairygui.com/docs/editor/i18n

Load translated XML content into the FairyGUI package system. This must be performed before UI creation as real-time switching is not supported.

```csharp
// Unity
    string fileContent; // Load the language file by yourself, here it is assumed that it has been loaded into this variable
    FairyGUI.Utils.XML xml = new FairyGUI.Utils.XML (fileContent);
    UIPackage.SetStringsSource (xml);
```

```actionscript
// AS3
    var fileContent: String; // Load the language file by yourself, it is assumed here that this variable has been loaded
    var xml: XML = new XML (fileContent);
    UIPackage.setStringsSource (xml);
```

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

### Set Native Object Placeholder

Source: https://www.fairygui.com/docs/editor/graph

Use a blank graphic as a placeholder to insert a native display object into the FairyGUI display list.

```text
holder.SetNativeObject (aSprite);
```

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

### Create a GRichTextField instance

Source: https://www.fairygui.com/docs/editor/richtext

Initialize a new GRichTextField and set its size and text content.

```csharp
GRichTextField aRichTextField = new GRichTextField (); aRichTextField.SetSize (100,100); aRichTextField.text = " <a href='xxx'>Hello World</a> ";
```

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

### Window Class Methods

Source: https://www.fairygui.com/docs/editor/window

Methods for controlling the display state and modal behavior of individual window instances.

```APIDOC
## Window Methods

### Show()
Displays the window.

### Hide()
Hides the window without destroying it.

### isShowing()
Returns a boolean indicating if the window is currently displayed.

### capital(isModal: boolean)
Sets whether the window is a modal window. Modal windows prevent interaction with elements behind them and can display a background overlay.

### ShowModalWait()
Locks the window to prevent user operations, optionally displaying a waiting prompt defined by UIConfig.windowModalWaiting.

### CloseModalWait()
Unlocks the window.
```

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

### Load UI package in Cry Engine

Source: https://www.fairygui.com/docs/sdk/cryengine

Add a UI package to the project by specifying the package name or path relative to the Assets directory.

```csharp
// demo is the file name filled in when publishing
    UIPackage.AddPackage ("demo");
    
    // if in a subdirectory
    UIPackage.AddPackage ("path/demo");
```

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

### Configure Global Popup Menu Resources

Source: https://www.fairygui.com/docs/editor/popup

Set the default component resources used for popup menus and separators.

```csharp
UIConfig.popupMenu = "ui://package name/menu component name";
	
	// if there is a design divider
	UIConfig.popupMenu_seperator = "ui://package name/menu separator";
```

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

### UBB Tag Nesting Rules

Source: https://www.fairygui.com/docs/editor/text

Demonstration of allowed and disallowed tag nesting patterns in FairyGUI.

```csharp
//allow
    [color = # FFFFFF] [size = 20] text [/ size] [/ color]

    // not allowed
    [color = # FFFFFF] [size = 20] text [/ color] [/ size]
```

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

### Configure 3D Object Transform

Source: https://www.fairygui.com/docs/unity/insert3d

Set the position, scale, and rotation of the instantiated GameObject.

```csharp
go.transform.localPosition = new Vector3(61, -89, 1000); 
  go.transform.localScale = new Vector3(180, 180, 180);
  go.transform.localEulerAngles = new Vector3(0, 100, 0);
```

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

### Handle Events in Virtual List ItemRenderer (AS3/Starling/Egret/Laya)

Source: https://www.fairygui.com/docs/editor/list

Demonstrates correct event listener management in AS3-based frameworks to avoid issues with temporary functions.

```ActionScript
//
		private function EventCallback (evt: Event): void
		{
		}

		private function onRenderItem (index: int, obj: GObject): void
		{
			var btn: GButton = obj.asCom.getChild ("btn"). asButton;

			// Error, temporary functions should not be used here
			btn.addClickListener (function (): void (});

			// correct, the same method will only be added once
			btn.addClickListener (EventCallback);
		}
```

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

### Rendering Nodes via Callback

Source: https://www.fairygui.com/docs/editor/tree

Use a callback function to handle node rendering logic.

```csharp
aTree.treeNodeRender = RenderTreeNode;

void RenderTreeNode (GTreeNode node, GComponent obj)
{
}
```

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

### Retrieve Resource Information

Source: https://www.fairygui.com/docs/editor/object

Accesses the package item name or resolves the resource name from a URL.

```csharp
// The name of the object in the resource library

Debug.Log (aObject.packageItem.name);
// Get the resource name based on the URL  
Debug.Log (UIPackage.GetItemByURL (resourceURL) .name);
```

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

### Troubleshoot Lua Delegate Registration

Source: https://www.fairygui.com/docs/faq

Error message encountered when Lua delegates are not properly registered or initialized.

```text
LuaException: Delegate FairyGUI.EventCallback1 not register
```

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

### Configure Package File Extension

Source: https://www.fairygui.com/docs/sdk/laya

Sets a custom file extension for UI packages, required for platforms that do not support the default .fui extension.

```typescript
fairygui.UIConfig.packageFileExtension = "The extension you defined";
```

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

### Handling Node Expansion Events

Source: https://www.fairygui.com/docs/editor/tree

Listen for expansion or collapse events to perform dynamic child node insertion.

```csharp
aTree.treeNodeWillExpand = onExpand;

void onExpand(GTreeNode node, bool expand)
{
}
```

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

### Initialize FairyGUI in LayaAir

Source: https://www.fairygui.com/docs/sdk/laya

Initializes the FairyGUI root display object and configures default UI settings such as fonts and scrollbars.

```typescript
onLoaded(): void {
      Laya.stage.addChild(fgui.GRoot.inst.displayObject);
      
      fgui.UIPackage.addPackage("res/Basic");
      fgui.UIConfig.defaultFont = "宋体";
      fgui.UIConfig.verticalScrollBar = "ui://Basic/ScrollBar_VT";
      fgui.UIConfig.horizontalScrollBar = "ui://Basic/ScrollBar_HZ";
      fgui.UIConfig.popupMenu = "ui://Basic/PopupMenu";
      fgui.UIConfig.buttonSound = "ui://Basic/click";
  }
```

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

### Load UI Package via fgui.UIPackage

Source: https://www.fairygui.com/docs/sdk/creator

Automatically load a UI package using the built-in FairyGUI loader. This method handles package registration internally.

```typescript
// Filled here is relative to the path in resources
    fgui.UIPackage.loadPackage ("UI/Bag", function (err) {
        // You don't need to call addPackage here, you can start creating the interface directly.
    });
```

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

### Implement Substitute Dragging

Source: https://www.fairygui.com/docs/editor/dragdrop

Enables dragging objects across the full screen using a substitute icon.

```C#
aObject.draggable = true;
    aObject.onDragStart.Add (onDragStart);

    // Unity / Cry / MonoGame
    void onDragStart (EventContext context)
    {
        // Cancel source drag
        context.PreventDefault ();
    
        // icon is the avatar image of this object, userData can be arbitrary data, and the underlying layer does not parse it. context.data is the id of the finger.
        DragDropManager.inst.StartDrag (null, icon, userData, (int) context.data);
    }
```

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

### Configure Global Link Styles

Source: https://www.fairygui.com/docs/editor/richtext

Set static properties on HtmlParseOptions to define default hyperlink appearance globally before creating rich text.

```csharp
// Note: Global settings should be called before creating rich text.



// Set whether all links in the entire project are underlined  
HtmlParseOptions.DefaultLinkUnderline = false;
// Set the color of the hyperlink  
HtmlParseOptions.DefaultLinkColor = …;  
HtmlParseOptions.DefaultLinkBgColor = …;  
HtmlParseOptions.DefaultLinkHoverBgColor = …;
```

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

### Code Template Parameters

Source: https://www.fairygui.com/docs/editor/publish

Lists the available placeholders for customizing Component and Binder code templates.

```text
Component.template
    -------------
    {packageName} UI module name
    {componentName} UI component parent class name
    {className} UI component class name
    {uiPkgName} UI resource package name
    {uiResName} UI resource name
    {uiPath} UI resource path
    
    Binder.template
    -------------
    {className} UI module name + "Binder"
    {packageName} UI module name
```

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

### Configure Global Button Sound

Source: https://www.fairygui.com/docs/editor/button

Set the global sound for buttons, with platform-specific resource handling.

```C#
// The Unity version requires an AudioClip object. If you use the resources in the library, you can use:
    UIConfig.buttonSound = (NAudioClip) UIPackage.GetItemAssetByURL("ui://package name/sound name");

    // Other versions require a resource url, that is:
    UIConfig.buttonSound = "ui://package name/sound name";
```

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

### Show Popup Window

Source: https://www.fairygui.com/docs/editor/popup

Windows can be displayed as popups to enable the automatic click-to-close behavior.

```csharp
Window aWindow;
	GRoot.inst.ShowPopup (aWindow);

	// The only difference from using aWindow.Show to display the window is that it has the function of clicking blank to close, there is no difference in other usage.
```

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

### Define a Component Extension Class

Source: https://www.fairygui.com/docs/editor/component

Create a custom class inheriting from GComponent to encapsulate component logic. Use ConstructFromXML for initialization instead of the constructor.

```csharp
public class MyComponent: GComponent
	{
		GObject msgObj;

		// If you need to initialize the contents of the container, you must // in this method, not in the constructor. The parameters of the function prototype of each SDK may be slightly different, please refer to the code hints. In Cocos2dx / CocosCreator, the method name is onConstruct without parameters
		override protected void ConstructFromXML (XML xml)
		{
			base.ConstructFromXML (xml);
			
			// Continue your initialization here
			msgObj = GetChild ("msg");
		}

		public void ShowMessage (string msg)
		{
			msgObj.text = msg;
		}
	}
```

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

### Handle GTextInput submit event

Source: https://www.fairygui.com/docs/editor/text

Register a listener for the Enter key press event on PC platforms.

```csharp
//Unity
    aTextInput.onSubmit.Add(onSubmit);
```

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

### Enable custom bold rendering

Source: https://www.fairygui.com/docs/unity/font

Uses extra mesh rendering to fix incorrect bold display for fonts that lack native bold support.

```csharp
FontManager.GetFont ("font name"). CustomBold = true;
```

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

### Create GRoot

Source: https://www.fairygui.com/docs/sdk/creator

Initializes the root node of the UI system. This must be called manually after the scene loads.

```typescript
fgui.GRoot.create ();
```
Tokens:
Raw