Flax Engine

https://docs.flaxengine.com
Admin
Flax Engine is a powerful game engine that allows developers to create games using C# and C++...
Tokens:2,418,701
Snippets:32,466
Trust Score:8.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Unity Script Example

Source: https://docs.flaxengine.com/manual/get-started/flax-for-unity-devs/index.html

Illustrates a basic Unity C# script using MonoBehaviour and the Start method.

```csharp
public class MyScript : MonoBehaviour
{
  void Start()
  {
      Debug.Log("It is Unity!");
  }
}
```

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

### Setup

Source: https://docs.flaxengine.com/api-cpp/Terrain.html

Setups the terrain and clears existing data.

```APIDOC
## Setup(int32 lodCount=6, int32 chunkSize=127)

### Description
Setups the terrain. Clears the existing data.

### Parameters
- **lodCount** (int32) - The LODs count.
- **chunkSize** (int32) - The size of the chunk (amount of quads per edge for the highest LOD).
```

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

### GetStartTime

Source: https://docs.flaxengine.com/api-cpp/AudioSource.html

Gets the start time for audio playback.

```cpp
public float GetStartTime() const
```

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

### GetSyncStart()

Source: https://docs.flaxengine.com/api-cpp/GPUTask.html

Gets work synchronization start point.

```APIDOC
## GPUSyncPoint GetSyncStart()

### Description
Gets work synchronization start point.

### Returns
- **GPUSyncPoint** - The synchronization start point.

### Declaration
```cpp
public GPUSyncPoint GetSyncStart() const
```
```

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

### Setup

Source: https://docs.flaxengine.com/api-cpp/Terrain.html

Initializes the terrain and clears existing data.

```cpp
public void Setup(int32 lodCount=6, int32 chunkSize=127)
```

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

### Start Listening for Connections (Server)

Source: https://docs.flaxengine.com/api/FlaxEngine.Networking.NetworkPeer.html

Call this method to make the current peer act as a server and begin accepting incoming connections. Returns true if the server started successfully.

```csharp
[Unmanaged]
public bool Listen()
```

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

### Setup

Source: https://docs.flaxengine.com/api-cpp/FontTextureAtlas.html

Sets up the atlas after creation.

```APIDOC
## FontTextureAtlas::Setup

### Description
Setups the atlas after creation.

### Signature
`public void Setup(PixelFormat format, PaddingStyle paddingStyle)`

### Parameters
- **format** (PixelFormat) - The pixel format.
- **paddingStyle** (PaddingStyle) - The padding style.
```

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

### NetworkManager StartClient Method

Source: https://docs.flaxengine.com/api-cpp/NetworkManager.html

Initiates the network manager to start in client mode. Returns true if the startup fails, for example, due to invalid configuration.

```csharp
public static bool StartClient()
```

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

### Setup

Source: https://docs.flaxengine.com/api-cpp/WheeledVehicle.html

Rebuilds the vehicle; call this after modifying settings.

```cpp
public void Setup()
```

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

### Begin()

Source: https://docs.flaxengine.com/api-cpp/GPUTimerQuery.html

Starts the GPU timer counter.

```APIDOC
## void Begin()

### Description
Starts the counter to begin measuring GPU operations.

### Declaration
`public virtual void Begin() = 0`
```

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

### SetUp

Source: https://docs.flaxengine.com/api-cpp/Matrix.html

Sets the up vector of the matrix.

```APIDOC
## SetUp(const Float3& value)

### Description
Sets the up vector of the matrix.

### Method
public void SetUp(const Float3& value)

### Parameters
- **value** (Float3) - The new up vector.
```

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

### NetworkManager StartHost Method

Source: https://docs.flaxengine.com/api-cpp/NetworkManager.html

Initiates the network manager to start in host mode. Returns true if the startup fails, for example, due to invalid configuration.

```csharp
public static bool StartHost()
```

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

### Start

Source: https://docs.flaxengine.com/api-cpp/Task.html

Starts the task execution.

```APIDOC
### void Start()

Starts this task execution (and will continue with all children).
```

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

### StartServer()

Source: https://docs.flaxengine.com/api-cpp/NetworkManager.html

Starts the network in server mode. Returns true if the operation failed, for example, due to invalid configuration.

```APIDOC
## StartServer()

### Description
Starts the network in server mode. Returns true if failed (eg. invalid config).

### Method
public static bool StartServer()

### Returns
bool
```

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

### Begin Method

Source: https://docs.flaxengine.com/api-cpp/GPUSwapChainVulkan.html

Initiates rendering for the specified task.

```cpp
public virtual void Begin(RenderTask* task) override
```

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

### GetNestedObject(ref Guid, out Guid, out Guid)

Source: https://docs.flaxengine.com/api/FlaxEngine.Prefab.html

Gets the reference to the other nested prefab for a specific prefab object.

```APIDOC
## Method: GetNestedObject(ref Guid objectId, out Guid outPrefabId, out Guid outObjectId)

### Description
Gets the reference to the other nested prefab for a specific prefab object.

### Parameters
- **objectId** (System.Guid) - The ID of the object in this prefab.
- **outPrefabId** (System.Guid) - Result ID of the prefab asset referenced by the given object.
- **outObjectId** (System.Guid) - Result ID of the prefab object referenced by the given object.

### Returns
- **bool** - True if got valid reference, otherwise false.
```

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

### Get buffer start time

Source: https://docs.flaxengine.com/api-cpp/AudioClip.html

Retrieves the start time of a specific buffer in seconds.

```cpp
public float GetBufferStartTime(int32 bufferIndex) const
```

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

### Setup(Int32, Int32)

Source: https://docs.flaxengine.com/api/FlaxEngine.Terrain.html

Initializes the terrain and clears existing data.

```APIDOC
## Setup(Int32, Int32)

### Description
Setups the terrain. Clears the existing data.

### Declaration
`public void Setup(int lodCount = 6, int chunkSize = 127)`

### Parameters
- **lodCount** (int) - The LODs count.
- **chunkSize** (int) - The size of the chunk (amount of quads per edge for the highest LOD).
```

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

### GetStringID(Guid)

Source: https://docs.flaxengine.com/api/FlaxEngine.Json.JsonSerializer.html

Gets the string representation of a Guid according to internal serialization rules.

```APIDOC
## GetStringID(Guid)

### Description
Gets the string representation of the given object ID (Guid), matching the internal serialization formatting rules.

### Method
```csharp
public static string GetStringID(Guid id)
```

### Parameters
*   **id** (System.Guid) - The Guid object identifier.

### Returns
System.String - The serialized ID of the Guid.
```

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

### StartServer

Source: https://docs.flaxengine.com/api/FlaxEngine.Networking.NetworkManager.html

Starts the network server. Returns true if the server started successfully, false otherwise.

```APIDOC
## StartServer()

### Description
Starts the network server.

### Method
static bool

### Returns
System.Boolean - True if the server started successfully, false otherwise.
```

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

### StartNew

Source: https://docs.flaxengine.com/api-cpp/Task.html

Static methods to start a new task with various action types.

```APIDOC
### static Task* StartNew(const Function<bool()>& action, Object* target=nullptr)
### static Task* StartNew(const Function<void()>& action, Object* target=nullptr)
### static Task* StartNew(Task* task)

Starts a new task based on the provided action or existing task object.

#### Parameters
- **action** (Function) - The action to perform.
- **target** (Object*) - The action target object.
- **task** (Task*) - The task to start.

#### Returns
- **Task*** - The started task.
```

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

### SetUp(ref Matrix, ref Matrix)

Source: https://docs.flaxengine.com/api/FlaxEngine.RenderView.html

Initializes the render view data with provided view and projection matrices.

```APIDOC
## SetUp(ref Matrix, ref Matrix)

### Description

Initializes render view data.

### Method

```csharp
public void SetUp(ref Matrix view, ref Matrix projection)
```

### Parameters

- **view** (ref Matrix) - Required - The view.
- **projection** (ref Matrix) - Required - The projection.
```

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

### GetStringID(Guid*)

Source: https://docs.flaxengine.com/api/FlaxEngine.Json.JsonSerializer.html

Gets the string representation of a Guid pointer according to internal serialization rules.

```APIDOC
## GetStringID(Guid*)

### Description
Gets the string representation of the given object ID (Guid pointer), matching the internal serialization formatting rules.

### Method
```csharp
public static string GetStringID(Guid* id)
```

### Parameters
*   **id** (System.Guid*) - A pointer to the Guid object identifier.

### Returns
System.String - The serialized ID of the Guid.
```

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

### Start Property

Source: https://docs.flaxengine.com/api/FlaxEditor.GUI.Timeline.Media.ProxyBase-2.html

Gets or sets the start frame of the media event in seconds. This property is visible when 'UseFrames' is true.

```csharp
[EditorDisplay("General", null)]
[EditorOrder(-10010)]
[VisibleIf("UseFrames", true)]
[Tooltip("Start frame of the media event (in seconds).")]
public float Start { get; set; }
```

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

### SetUp

Source: https://docs.flaxengine.com/api-cpp/RenderView.html

Sets up the view's transformation matrices.

```APIDOC
## SetUp (Matrix, Matrix)

### Description
Sets up the view's transformation matrices.

### Method
`public void SetUp(const Matrix& view, const Matrix& projection)`

### Parameters
- **view** (const Matrix&) - The view matrix.
- **projection** (const Matrix&) - The projection matrix.
```

```APIDOC
## SetUp (Matrix)

### Description
Sets up the view's combined view-projection matrix.

### Method
`public void SetUp(const Matrix& viewProjection)`

### Parameters
- **viewProjection** (const Matrix&) - The combined view-projection matrix.
```

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

### BackBufferDX12 Setup Method

Source: https://docs.flaxengine.com/api-cpp/BackBufferDX12.html

Sets up the backbuffer wrapper with the parent window and the DirectX 12 back buffer resource. This is a crucial step before using the backbuffer.

```cpp
public void Setup(GPUSwapChainDX12* window, ID3D12Resource* backbuffer)
```

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

### StartLogic()

Source: https://docs.flaxengine.com/api-cpp/Behavior.html

Starts the behavior logic.

```APIDOC
## StartLogic()

### Description
Starts the logic.

### Declaration
`public void StartLogic()`
```

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

### Begin() Method

Source: https://docs.flaxengine.com/api/FlaxEditor.Windows.Profiler.ProfilerMode.SharedUpdateData.html

Initiates the data usage for the profiler and prepares the data container.

```APIDOC
## Method Begin()

Begins the data usage. Prepares the container.

**Declaration**
```csharp
public void Begin()
```
```

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

### GetBufferStartTime

Source: https://docs.flaxengine.com/api-cpp/AudioClip.html

Gets the buffer start time in seconds.

```APIDOC
### float GetBufferStartTime(int32 bufferIndex)

#### Parameters
- **bufferIndex** (int32) - Index of the buffer.

#### Returns
- **float** - The buffer start time.
```

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

### Init Method

Source: https://docs.flaxengine.com/api-cpp/GPUSampler.html

Initializes a new sampler with the provided description.

```cpp
public bool Init(const GPUSamplerDescription& desc)
```

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

### OnCollisionEnter Method Declaration

Source: https://docs.flaxengine.com/api/FlaxEngine.PhysicsColliderActor.html

Called when a collision start gets registered for this collider. It signifies that this collider has started to collide with another object.

```csharp
[Unmanaged]
public virtual void OnCollisionEnter(Collision c)
```

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

### Setup

Source: https://docs.flaxengine.com/api-cpp/WheeledVehicle.html

Rebuilds the vehicle configuration.

```APIDOC
## void Setup()

### Description
Rebuilds the vehicle. Call it after modifying vehicle settings (eg. engine options).
```

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

### OnCollisionEnter

Source: https://docs.flaxengine.com/api-cpp/PhysicsColliderActor.html

Called when a collision start gets registered for this collider.

```APIDOC
## void OnCollisionEnter(const Collision& c)

### Description
Called when a collision start gets registered for this collider (it collides with something).

### Parameters
- **c** (Collision) - The collision info.
```

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

### ExecuteInEditMode C++ Example

Source: https://docs.flaxengine.com/manual/scripting/attributes.html

The C++ equivalent of using the ExecuteInEditMode attribute. This script generates a grid of point lights when the editor starts.

```cpp
#pragma once

#include "Engine/Scripting/Script.h"
#include "Engine/Level/Actors/PointLight.h"

API_CLASS(Attributes = "ExecuteInEditMode") class GAME_API MyGenerator : public Script
{
    API_AUTO_SERIALIZATION();
    DECLARE_SCRIPTING_TYPE(MyGenerator);

    // [Script]
    void OnStart() override
    {
        for (int x = 0; x < 5; x++)
        {
            for (int z = 0; z < 5; z++)
            {
                auto light = New<PointLight>();
                light->SetRadius(1000.0f);
                light->ShadowsMode = ShadowsCastingMode::None;
                light->SetPosition({ x * 100.0f, 0, z * 100.0f });
                light->SetParent(GetActor());
                //light->HideFlags = HideFlags::DontSave; // Uncomment to don't save generated actors
            }
        }
    }
};

```

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

### OnTriggerEnter

Source: https://docs.flaxengine.com/api-cpp/PhysicsColliderActor.html

Called when a trigger touching start gets registered for this collider.

```APIDOC
## void OnTriggerEnter(PhysicsColliderActor* c)

### Description
Called when a trigger touching start gets registered for this collider (the other collider enters it and triggers the event).

### Parameters
- **c** (PhysicsColliderActor*) - The other collider.
```

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

### FocusOnPlayOption

Source: https://docs.flaxengine.com/api/FlaxEditor.Windows.GameWindow.html

Gets or sets which panel should be focused when play mode starts.

```APIDOC
## FocusOnPlayOption

### Description
Gets or sets a value indicating what panel should be focused when play mode starts.

### Property Value
- **InterfaceOptions.PlayModeFocus**
```

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

### Init(const GPUSamplerDescription& desc)

Source: https://docs.flaxengine.com/api-cpp/GPUSampler.html

Initializes the sampler with the provided description.

```APIDOC
## Init(const GPUSamplerDescription& desc)

### Description
Creates or initializes a new sampler using the provided description.

### Parameters
- **desc** (GPUSamplerDescription) - The sampler description.

### Returns
- **bool** - Returns true if the sampler cannot be created, otherwise false.
```

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

### OnStartFrameChanged Method

Source: https://docs.flaxengine.com/api/FlaxEditor.GUI.Timeline.Tracks.CameraCutMedia.html

Called when media start frame gets changed.

```csharp
protected override void OnStartFrameChanged()
```

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

### Get Engine Startup Time

Source: https://docs.flaxengine.com/api/FlaxEngine.Engine.html

Retrieves the local time when the engine was started.

```csharp
[Unmanaged]
public static DateTime StartupTime { get; }
```

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

### Add System References in Build.cs

Source: https://docs.flaxengine.com/manual/scripting/csharp/project-file-management.html

Use the Setup method in your module build file to include required system assemblies.

```csharp
public override void Setup(BuildOptions options)
{
    base.Setup(options);

    options.ScriptingAPI.SystemReferences.Add("System.Text.RegularExpressions");
}
```

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

### SetStartTime Method

Source: https://docs.flaxengine.com/api-cpp/AudioSource.html

Defines the starting timestamp in seconds for audio playback when Play On Start is enabled.

```csharp
public void SetStartTime(float value)
```

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

### StartTime

Source: https://docs.flaxengine.com/api/FlaxEditor.GUI.Timeline.Tracks.NestedAnimationTrack.html

Gets or sets the start time offset for the nested animation in seconds.

```APIDOC
### Field
`public float StartTime`

#### Value
- **System.Single** - The start time position in seconds.
```

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

### Setup

Source: https://docs.flaxengine.com/api-cpp/ModelInstanceEntries.html

Sets up the buffer for a given model, skinned model, or slot count.

```APIDOC
## void Setup(const Model* model)
## void Setup(const SkinnedModel* model)
## void Setup(int32 slotsCount)

### Description
Setup buffer for given model, skinned model, or amount of material slots.

### Parameters
- **model** (const Model* / const SkinnedModel*) - Model to setup for.
- **slotsCount** (int32) - Amount of material slots.
```

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

### Get Iterator for Beginning (Begin)

Source: https://docs.flaxengine.com/api-cpp/Array.html

Provides an iterator pointing to the start of the collection for iteration.

```cpp
public Iterator Begin() const
```

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

### ExecuteInEditMode C# Example

Source: https://docs.flaxengine.com/manual/scripting/attributes.html

Use the [ExecuteInEditMode] attribute to enable script execution in the editor. This script generates a grid of point lights when the editor starts.

```csharp
using FlaxEngine;

[ExecuteInEditMode]
public class MyGenerator : Script
{
    public override void OnStart()
    {
        for (int x = 0; x < 5; x++)
        {
            for (int z = 0; z < 5; z++)
            {
                var light = new PointLight
                {
                    Radius = 1000,
                    ShadowsMode = ShadowsCastingMode.None,
                    Position = new Vector3(x * 100.0f, 0, z * 100.0f),
                    Parent = Actor
                    //HideFlags = HideFlags.DontSave; // Uncomment to don't save generated actors
                };
            }
        }
    }
}
```

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

### Get Culture English Name

Source: https://docs.flaxengine.com/api-cpp/CultureInfo.html

Retrieves the culture name in English. For example, 'polski (Polska)'.

```cpp
public String GetEnglishName() const
```

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

### Get Asset References

Source: https://docs.flaxengine.com/api-cpp/MaterialParams.html

Retrieves an array of Guids representing asset references used by the material parameters.

```cpp
public void GetReferences(Array<Guid>& assets) const
```

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

### StartLogic Method

Source: https://docs.flaxengine.com/api-cpp/Behavior.html

Initializes and starts the behavior logic.

```cpp
public void StartLogic()
```

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

### Get Material Parameter by ID

Source: https://docs.flaxengine.com/api-cpp/MaterialParams.html

Retrieves a pointer to a material parameter using its unique Guid identifier.

```cpp
public MaterialParameter* Get(const Guid& id)
```

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

### Start

Source: https://docs.flaxengine.com/api-cpp/Stopwatch.html

Starts the stopwatch.

```APIDOC
## Start()

### Description
Starts the stopwatch.

### Syntax
```cpp
public void Start()
```
```

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

### Get Culture Native Name

Source: https://docs.flaxengine.com/api-cpp/CultureInfo.html

Retrieves the full localized name of the culture. For example, 'Polish (Poland)'.

```cpp
public String GetNativeName() const
```

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

### Setup Method

Source: https://docs.flaxengine.com/api/FlaxEngine.WheeledVehicle.html

Rebuilds the vehicle. This method should be called after any modifications to the vehicle's settings, such as engine options.

```csharp
[Unmanaged]
public void Setup()
```

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

### Begin Method

Source: https://docs.flaxengine.com/api/FlaxEditor.Windows.Profiler.ProfilerMode.SharedUpdateData.html

Prepares the SharedUpdateData container for data usage by initiating the data collection process.

```csharp
public void Begin()
```

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

### GetCompilationsCount() Method

Source: https://docs.flaxengine.com/api-cpp/ScriptsBuilder.html

Gets the total number of source code compilation actions performed since the editor started.

```APIDOC
## GetCompilationsCount()

### Description
Gets amount of source code compile actions since Editor startup.

### Declaration
```
public static int32 GetCompilationsCount()
```

### Returns
int32
```

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

### RendererPassBase setupResources Method

Source: https://docs.flaxengine.com/api-cpp/RendererPassBase.html

Protected virtual method to set up the resources required for the renderer pass. Returns true if setup is successful.

```cpp
protected virtual bool setupResources()
```

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

### Get Compilations Count

Source: https://docs.flaxengine.com/api-cpp/ScriptsBuilder.html

Returns the total number of script compilation actions performed since the editor started.

```csharp
public static int32 GetCompilationsCount()
```

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

### Setup Method

Source: https://docs.flaxengine.com/api-cpp/FontTextureAtlas.html

Configures the atlas with a specific pixel format and padding style.

```cpp
public void Setup(PixelFormat format, PaddingStyle paddingStyle)
```

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

### Init Method

Source: https://docs.flaxengine.com/api-cpp/DynamicDiffuseGlobalIlluminationPass.html

Initializes the DDGI service.

```cpp
public virtual bool Init() override
```

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

### GetLayer(const Guid& id, Node* caller)

Source: https://docs.flaxengine.com/api-cpp/MaterialGenerator.html

Gets a layer by its ID, attempting to load it if it is not currently loaded.

```APIDOC
## GetLayer(const Guid& id, Node* caller)

### Description
Gets layer that has given ID, if not loaded tries to load it.

### Declaration
`public MaterialLayer* GetLayer(const Guid& id, Node* caller)`

### Parameters
- **id** (const Guid&) - Layer ID
- **caller** (Node*) - Calling node

### Returns
- **MaterialLayer*** - Material layer or null if cannot do that
```

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

### Engine UpdateCount Field

Source: https://docs.flaxengine.com/api-cpp/Engine.html

Gets the current update counter since the start of the game. Incremented on each update tick.

```csharp
public static uint64 UpdateCount
```

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

### setupResources Method

Source: https://docs.flaxengine.com/api-cpp/DynamicDiffuseGlobalIlluminationPass.html

Sets up internal resources for the pass.

```cpp
protected virtual bool setupResources() override
```

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

### Get Frame Count

Source: https://docs.flaxengine.com/api/FlaxEngine.Engine.html

Retrieves the total number of frames rendered since the game started. This is a read-only property.

```csharp
[Unmanaged]
public static ulong FrameCount { get; }
```

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

### setup Method

Source: https://docs.flaxengine.com/api-cpp/BinaryAssetUpgrader.html

Protected method for setting up the upgrader with a list of upgraders and their count. This is typically called internally during engine initialization or asset processing.

```cpp
protected void setup(Upgrader const* upgraders, int32 upgradersCount)
```

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

### Listen()

Source: https://docs.flaxengine.com/api/FlaxEngine.Networking.INetworkDriver.html

Starts listening for incoming connections, transitioning the driver into server mode.

```APIDOC
## Listen()

### Description
Starts listening for incoming connections. Once this is called, this driver becomes a server.

### Method
```
[Unmanaged]
bool Listen()
```

### Returns
System.Boolean True when succeeded.
```

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

### StartFrame Property

Source: https://docs.flaxengine.com/api/FlaxEditor.GUI.Timeline.Media.ProxyBase-2.html

Gets or sets the start frame of the media event in frames. This property is visible when 'UseFrames' is false.

```csharp
[EditorDisplay("General", null)]
[EditorOrder(-10010)]
[VisibleIf("UseFrames", false)]
[Tooltip("Start frame of the media event (in frames).")]
public int StartFrame { get; set; }
```

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

### GPUTimerQuery Begin Method

Source: https://docs.flaxengine.com/api-cpp/GPUTimerQuery.html

Starts the GPU timer counter.

```cpp
public virtual void Begin() = 0
```

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

### SetupSkeleton(SkeletonNode[])

Source: https://docs.flaxengine.com/api/FlaxEngine.SkinnedModel.html

Setups the skinned model skeleton. Uses the same nodes layout for skeleton bones and calculates the offset matrix by auto.

```APIDOC
## SetupSkeleton(SkeletonNode[])

### Description
Setups the skinned model skeleton. Uses the same nodes layout for skeleton bones and calculates the offset matrix by auto.

### Parameters
- **nodes** (SkeletonNode[]) - Required - The nodes hierarchy. The first node must be a root one (with parent index equal -1).

### Returns
- **System.Boolean** - True if failed, otherwise false.
```

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

### StartServer() - NetworkManager

Source: https://docs.flaxengine.com/api-cpp/NetworkManager.html

Starts the network in server mode. Returns true if failed, for example, due to invalid configuration.

```csharp
public static bool StartServer()
```

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

### Logging Examples

Source: https://docs.flaxengine.com/manual/scripting/cpp/logging-assertions.html

Demonstrates various ways to log messages with different types and arguments using LOG macros.

```cpp
String info = TEXT("Object: ") + this->ToString();
LOG_STR(Info, info);
LOG(Warning, "hello there! {0}", info);
LOG(Error, "player speed: {0}, direction: {1}", 11.0f, Vector3::UnitX);
```

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

### Engine FrameCount Field

Source: https://docs.flaxengine.com/api-cpp/Engine.html

Gets the current frame (drawing) count since the start of the game. Useful for performance monitoring.

```csharp
public static uint64 FrameCount
```

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

### Get Update Count

Source: https://docs.flaxengine.com/api/FlaxEngine.Engine.html

Retrieves the total number of update cycles that have occurred since the game started. This is a read-only property.

```csharp
[Unmanaged]
public static ulong UpdateCount { get; }
```

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

### OnInit Method

Source: https://docs.flaxengine.com/api/FlaxEditor.Windows.EditorOptionsWindow.html

Called when the window should be initialized, ensuring main window and content database are ready.

```csharp
public override void OnInit()
```

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

### Install .Net 8 SDK

Source: https://docs.flaxengine.com/manual/get-started/linux.html

Installs the .Net 8 Software Development Kit, which is a requirement for Flax Editor.

```bash
sudo apt install dotnet-sdk-8.0
```

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

### Init

Source: https://docs.flaxengine.com/api-cpp/GPUDeviceVulkan.html

Initializes the device resources.

```APIDOC
## Init

### Declaration
`public virtual bool Init()`

### Returns
- **bool** - True if initialization failed, otherwise false.
```

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

### Get Default Node

Source: https://docs.flaxengine.com/api-cpp/SkeletonUpdater.html

Retrieves the default root node for a skeleton. This can be useful for initial setup or when a specific node is not found.

```csharp
public static Node GetDefaultNode()
```

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

### GetSettings

Source: https://docs.flaxengine.com/api-cpp/WindowBase.html

Retrieves the window creation settings.

```cpp
public CreateWindowSettings GetSettings() const
```

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

### Get Initial Seed

Source: https://docs.flaxengine.com/api-cpp/RandomStream.html

Retrieves the initial seed value that the random stream was created with. This is useful for resetting the stream to its starting state.

```csharp
public int32 GetInitialSeed() const
```

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

### CollisionEnter Event Declaration

Source: https://docs.flaxengine.com/api/FlaxEngine.PhysicsColliderActor.html

An event that occurs when a collision start gets registered for this collider. Subscribe to this event to react to incoming collisions.

```csharp
[Unmanaged]
public event Action<Collision> CollisionEnter
```

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

### Begin Render Task

Source: https://docs.flaxengine.com/api-cpp/GPUSwapChain.html

Initiates rendering for the specified task.

```cpp
public virtual void Begin(RenderTask* task)
```

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

### SetupWindowSettings Method

Source: https://docs.flaxengine.com/api/FlaxEditor.Content.Create.CreateFilesDialog.html

Configures the window settings for the dialog.

```csharp
protected override void SetupWindowSettings(ref CreateWindowSettings settings)
```

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

### Start Listening for Connections

Source: https://docs.flaxengine.com/api/FlaxEngine.Networking.ENetDriver.html

Enables the ENetDriver to accept incoming connections, making it act as a server. Returns true if listening was successfully started.

```csharp
public bool Listen()
```

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

### TriggerEnter Event Declaration

Source: https://docs.flaxengine.com/api/FlaxEngine.PhysicsColliderActor.html

An event that occurs when a trigger touching start gets registered for this collider. Subscribe to detect when other colliders enter its trigger volume.

```csharp
[Unmanaged]
public event Action<PhysicsColliderActor> TriggerEnter
```

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

### SetupShadows Method

Source: https://docs.flaxengine.com/api-cpp/ShadowsPass.html

Sets up the shadows rendering process for batched scene drawing, determining which lights will cast shadows. Requires valid RenderContext and RenderContextBatch.

```cpp
public void SetupShadows(RenderContext& renderContext, RenderContextBatch& renderContextBatch)
```

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

### OnTriggerEnter Method Declaration

Source: https://docs.flaxengine.com/api/FlaxEngine.PhysicsColliderActor.html

Called when a trigger touching start gets registered for this collider. This event is fired when another collider enters the trigger area.

```csharp
[Unmanaged]
public virtual void OnTriggerEnter(PhysicsColliderActor c)
```

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

### ScriptsContainer.PrefabObjectId Property

Source: https://docs.flaxengine.com/api/FlaxEditor.CustomEditors.Dedicated.ScriptsEditor.ScriptsContainer.html

Gets the prefab object identifier used by the container scripts. This property returns an empty GUID if there is no valid linkage to a prefab object.

```APIDOC
## PrefabObjectId Property

### Description
Gets the prefab object identifier used by the container scripts. Empty if there is no valid linkage to the prefab object.

### Property Value
(Guid) - The prefab object identifier.
```

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

### GPUTimerQueryDX11 Begin Method

Source: https://docs.flaxengine.com/api-cpp/GPUTimerQueryDX11.html

Starts the GPU timer counter.

```cpp
public virtual void Begin() override
```

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

### OpenSolution Method

Source: https://docs.flaxengine.com/api-cpp/CodeEditor.html

Opens the project solution file.

```cpp
public virtual void OpenSolution() = 0
```

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

### Install Android .NET Workload

Source: https://docs.flaxengine.com/manual/release-notes/1_6/index.html

Use this command to install the necessary .NET workload for Android development on your system.

```bash
dotnet workload install android
```

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

### Install .Net iOS Workload

Source: https://docs.flaxengine.com/manual/platforms/ios.html

Command to install the required .Net iOS workload for building iOS applications.

```bash
dotnet workload install ios
```

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

### Start Method Declaration

Source: https://docs.flaxengine.com/api-cpp/ThreadSpawner.html

The declaration for the Start method used to initiate a new thread with a callback.

```cpp
public static Thread* Start(const Function<int32()>& callback, const String& threadName, ThreadPriority priority=ThreadPriority::Normal, uint32 stackSize = 0)
```

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

### LightPass SetupLights Method

Source: https://docs.flaxengine.com/api-cpp/LightPass.html

Sets up the lights rendering for batched scene drawing. It requires a render context and a render context batch.

```cpp
public void SetupLights(RenderContext& renderContext, RenderContextBatch& renderContextBatch)
```

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

### Get All Actors from Root

Source: https://docs.flaxengine.com/api-cpp/SceneQuery.html

Retrieves all actors in the scene hierarchy starting from a specified root actor. The results are appended to the provided array, excluding the root actor itself.

```csharp
public static void GetAllActors(Actor* root, Array<Actor* >& actors)
```

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

### Init

Source: https://docs.flaxengine.com/api-cpp/BinaryAsset.html

Initializes the asset.

```cpp
public bool Init(AssetInitData& initData)
```

```cpp
protected virtual bool init(AssetInitData& initData)
```

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

### Get Material Parameter Bind Offset

Source: https://docs.flaxengine.com/api-cpp/MaterialParameter.html

Retrieves the offset of the parameter's binding within the constant buffer. This is an internal detail for graphics pipeline setup.

```cpp
public uint16 GetBindOffset() const
```

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

### Init()

Source: https://docs.flaxengine.com/api-cpp/GPUDeviceDX11.html

Initializes the GPU device resources.

```APIDOC
## Init()

### Description
Init device resources.

### Returns
- **bool** - True if cannot init, otherwise false.
```

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

### Try Get Serialized Object IDs from Bytes

Source: https://docs.flaxengine.com/api/FlaxEngine.Actor.html

This static method deserializes an array of Guids representing serialized object IDs from a given byte array. It is marked as unmanaged.

```csharp
[Unmanaged]
public static Guid[] TryGetSerializedObjectsIds(byte[] data)
```

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

### Init()

Source: https://docs.flaxengine.com/api-cpp/DynamicDiffuseGlobalIlluminationPass.html

Initializes the service.

```APIDOC
## bool Init()

### Description
Initialize service.

### Returns
- **bool** - Returns true if initialization was successful.
```

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

### Init

Source: https://docs.flaxengine.com/api-cpp/GPUBuffer.html

Initializes a new buffer with the provided description.

```cpp
public bool Init(const GPUBufferDescription& desc)
```

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

### GradientEditor.Stop Frame Field

Source: https://docs.flaxengine.com/api/FlaxEditor.GUI.Timeline.GUI.GradientEditor.Stop.html

Represents the frame position of the gradient stop on the time axis, relative to the event start. Use this to set or get the stop's temporal location.

```csharp
[EditorOrder(0)]
[Tooltip("The gradient stop frame position (on time axis, relative to the event start).")]
public int Frame
```

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

### OnInit()

Source: https://docs.flaxengine.com/api/FlaxEditor.Windows.EditorOptionsWindow.html

Called when the window should be initialized.

```APIDOC
## OnInit()

### Description
Called when window should be initialized. At this point, main window, content database, default editor windows are ready.

### Declaration
```csharp
public override void OnInit()
```
```

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

### SetJobStartingOnDispatch(Boolean)

Source: https://docs.flaxengine.com/api/FlaxEngine.JobSystem.html

Sets whether automatically start jobs execution on Dispatch. If disabled jobs won't be executed until it gets re-enabled. Can be used to optimize execution of multiple dispatches that should overlap.

```APIDOC
## SetJobStartingOnDispatch(Boolean)

### Description
Sets whether automatically start jobs execution on Dispatch. If disabled jobs won't be executed until it gets re-enabled. Can be used to optimize execution of multiple dispatches that should overlap.

### Declaration
```csharp
[Unmanaged]
public static void SetJobStartingOnDispatch(bool value)
```

### Parameters
- **value** (System.Boolean) - 
```

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

### Install curl and libcurl development files

Source: https://docs.flaxengine.com/manual/get-started/linux.html

Installs the 'curl' utility and development libraries required by Flax Editor on Debian-based systems.

```bash
sudo apt-get install -y curl libcurl4-gnutls-dev
```

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

### Guid Constructor

Source: https://docs.flaxengine.com/api-cpp/Guid.html

Initializes a new Guid instance. The empty constructor creates a default Guid.

```cpp
public Guid()

```

```cpp
public Guid(uint32 a, uint32 b, uint32 c, uint32 d)

```

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

### SetupPresentQueue

Source: https://docs.flaxengine.com/api-cpp/GPUDeviceVulkan.html

Sets up the present queue for the given window surface.

```APIDOC
## SetupPresentQueue

### Declaration
`public void SetupPresentQueue(VkSurfaceKHR surface)`

### Parameters
- **surface** (VkSurfaceKHR) - The surface.
```

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

### Flax Script Example

Source: https://docs.flaxengine.com/manual/get-started/flax-for-godot-devs/index.html

Demonstrates a basic script structure in Flax Engine using C#, highlighting the equivalent of Godot's _Ready() function.

```csharp
public class MyScript : Script
{
  public override void OnStart()
  {
      Debug.Log("It is Flax!");
  }
}
```

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

### StartupFolder

Source: https://docs.flaxengine.com/api-cpp/Globals.html

Path to the startup folder.

```APIDOC
## StartupFolder

### Description
Path to the startup folder.

### Declaration
```
public static String StartupFolder
```

### Field Value
String
```

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

### Guid Fields

Source: https://docs.flaxengine.com/api-cpp/Guid.html

Access the components of a Guid. 'Empty' provides a default invalid Guid, and 'Raw' accesses the 16-byte representation.

```cpp
public uint32 A

```

```cpp
public uint32 B

```

```cpp
public uint32 C

```

```cpp
public uint32 D

```

```cpp
public static Guid Empty

```

```cpp
public byte Raw[16]

```

```cpp
public uint32 Values[4]

```

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

### Init()

Source: https://docs.flaxengine.com/api-cpp/PhysicsScene.html

Initializes the physics scene with a name and settings.

```cpp
public bool Init(const StringView& name, const PhysicsSettings& settings)
```

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

### FromBytes (Byte[], Dictionary<Guid, Guid>)

Source: https://docs.flaxengine.com/api/FlaxEngine.Actor.html

Deserializes actors from a raw byte array using a provided mapping for GUIDs.

```APIDOC
## FromBytes(Byte[], Dictionary<Guid, Guid>)

### Description
Performs actors deserialization from the raw bytes.

### Method Signature
```csharp
public static Actor[] FromBytes(byte[] data, Dictionary<Guid, Guid> idsMapping)
```

### Parameters
* **data** (System.Byte[]) - The input data.
* **idsMapping** (Dictionary<Guid, Guid>) - A mapping to resolve GUIDs during deserialization.
```

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

### ForwardPass.setupResources()

Source: https://docs.flaxengine.com/api-cpp/ForwardPass.html

Sets up the resources required for the ForwardPass.

```APIDOC
## setupResources()

### Declaration
```cpp
protected virtual bool setupResources() override
```

### Returns
bool

### Overrides
RendererPassBase::setupResources()
```

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

### LoadingThread Start Method

Source: https://docs.flaxengine.com/api-cpp/LoadingThread.html

Starts the thread execution with a given name. Returns true if the thread cannot be started, false otherwise.

```cpp
public bool Start(const String& name)
```

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

### StartTrackingMouse Method

Source: https://docs.flaxengine.com/api-cpp/WindowBase.html

Starts the mouse tracking process, with an option to use a screen offset.

```cpp
public virtual void StartTrackingMouse(bool useMouseScreenOffset)
```

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

### Write Guid

Source: https://docs.flaxengine.com/api-cpp/JsonWriter.html

Serializes a Guid structure.

```cpp
public void Guid(const Guid& value)
```

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

### Unreal Engine Script Example

Source: https://docs.flaxengine.com/manual/get-started/flax-for-ue4-devs/index.html

Example of a basic actor script in Unreal Engine that logs an incrementing count each frame.

```cpp
#pragma once
#include "GameFramework/Actor.h"
#include "MyScript.generated.h"

UCLASS()
class AMyScript : public AActor
{
    GENERATED_BODY()
    int Count;

    AMyScript()
    {
        // Allows Tick() to be called
        PrimaryActorTick.bCanEverTick = true;
    }

    void BeginPlay()
    {
        // Called when the game starts or when spawned
        Super::BeginPlay();
        Count = 0;
    }

    void Tick(float DeltaSeconds)
    {
        // Called every frame
        Super::Tick(DeltaSeconds);
        GLog->Log(FString::FromInt(Count++));
    }
};


```

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

### StartSimulateScene

Source: https://docs.flaxengine.com/api-cpp/PhysicsBackend.html

Starts the simulation of a physics scene.

```APIDOC
## StartSimulateScene(void* scene, float dt)

### Description
Starts the simulation of a physics scene.

### Parameters
- **scene** (void*) - The physics scene to simulate.
- **dt** (float) - The time step for the simulation.
```

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

### Init()

Source: https://docs.flaxengine.com/api-cpp/ScreenSpaceReflectionsPass.html

Initializes the screen space reflections service.

```APIDOC
## Init()

### Description
Initialize the SSR service.

### Returns
- **bool** - Returns true if initialization was successful.
```

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

### AssetReference Guid Assignment Operator

Source: https://docs.flaxengine.com/api-cpp/AssetReference.html

Assigns an asset reference by its unique Guid. The system will attempt to load the asset associated with the provided Guid.

```cpp
public AssetReference operator=(const Guid& id)
```

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

### NavLink Start Property

Source: https://docs.flaxengine.com/api/FlaxEngine.NavLink.html

The 'Start' property represents the starting position of a navigation link. It is defined in the local-space of the actor and indicates where the link begins.

```APIDOC
## NavLink.Start

### Description
The start location which transform is representing link start position. It is defined in local-space of the actor.

### Declaration
```csharp
[EditorDisplay("Nav Link", null)]
[EditorOrder(0)]
[Unmanaged]
public Vector3 Start { get; set; }
```

### Property Value
Vector3
```

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

### GPUSampler.Init Method

Source: https://docs.flaxengine.com/api/FlaxEngine.GPUSampler.html

Creates a new GPU sampler with the specified description. Returns true if the sampler cannot be created, otherwise false.

```APIDOC
## Init(ref GPUSamplerDescription)

### Description
Creates new sampler.

### Declaration
```csharp
[Unmanaged]
public bool Init(ref GPUSamplerDescription desc)
```

### Parameters
* **desc** (GPUSamplerDescription) - Required - The sampler description.

### Returns
System.Boolean - True if cannot create sampler, otherwise false.
```

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

### Example Custom HLSL File Content

Source: https://docs.flaxengine.com/manual/graphics/materials/shader-code-in-material.html

This example demonstrates including another shader file and defining a custom function that utilizes it. The custom function can then be called from other shader nodes.

```hlsl
#include "./Flax/Noise.hlsl"

float2 GetRandomValue(float2 uv)
{
    return rand2dTo2d(uv);
}

```

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

### Async File Handling Example

Source: https://docs.flaxengine.com/manual/scripting/advanced/multithreading.html

Perform asynchronous file operations using C# async/await. This example demonstrates reading a file asynchronously and performing a simulated slow computation.

```csharp
using System;
using System.IO;
using System.Threading;
using System.Threading.Tasks;
using FlaxEngine;

class AsyncTest : Script
{
    private Task _task;

    /// <inheritdoc />
    public override void OnEnable()
    {
        // Start async work
        _task = Task.Run(HandleFileAsync);
    }

    /// <inheritdoc />
    public override void OnDisable()
    {
        // End async work
        _task.Wait();
    }

    async Task HandleFileAsync()
    {
        Debug.Log("Starting async job from thread: " + Thread.CurrentThread.ManagedThreadId);
        string file = Path.Combine(Globals.ProjectContentFolder, "myFile.txt");
        int count = 0;

        // Read in the specified file (use async StreamReader method)
        using (StreamReader reader = new StreamReader(file))
        {
            string v = await reader.ReadToEndAsync();

            // Process the file data somehow
            count += v.Length;

            // A slow-running computation
            for (int i = 0; i < 10000; i++)
            {
                int x = v.GetHashCode();
                if (x == 0)
                {
                    count--;
                }
            }
        }

        Debug.Log("Job result " + count);
    }
}
```

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

### Get()

Source: https://docs.flaxengine.com/api-cpp/Array.html

Gets the pointer to the first item in the collection.

```APIDOC
## Get()

### Description
Gets the pointer to the first item in the collection (linear allocation).

### Method
```
public T* Get()
```

### Returns
T*
```

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

### Init Method

Source: https://docs.flaxengine.com/api-cpp/FenceManagerVulkan.html

Initializes the fence manager with the provided Vulkan GPU device.

```cpp
public void Init(GPUDeviceVulkan* device)
```

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

### BeginPlay Method

Source: https://docs.flaxengine.com/api-cpp/AnimatedModel.html

Initializes the object when added to the game.

```cpp
protected virtual void BeginPlay(SceneBeginData* data) override
```

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

### Equality Check with Guid

Source: https://docs.flaxengine.com/api-cpp/SoftAssetReference.html

Compares this SoftAssetReference with a Guid for equality.

```APIDOC
## operator==(const Guid& other) const

### Description
Compares this SoftAssetReference with a Guid for equality.

### Method
`bool operator==(const Guid& other) const`

### Parameters
- **other** (const Guid&) - The Guid to compare with.

### Returns
- bool - True if the SoftAssetReference is equal to the Guid, false otherwise.
```

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

### Init Method

Source: https://docs.flaxengine.com/api-cpp/GPUPipelineState.html

Initializes the pipeline state using the provided description.

```cpp
public virtual bool Init(const Description& desc)
```

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

### SoftAssetReference::operator!=(Guid)

Source: https://docs.flaxengine.com/api-cpp/SoftAssetReference.html

Compares the SoftAssetReference with a Guid for inequality.

```cpp
public bool operator!=(const Guid& other) const
```

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

### SetupRender Delegate

Source: https://docs.flaxengine.com/api-cpp/SceneRenderTask.html

An action called before rendering to customize setup. Use this to enable specific rendering features like Motion Vectors.

```csharp
public Delegate<RenderContext> SetupRender
```

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

### Guid Constructors

Source: https://docs.flaxengine.com/api-cpp/Guid.html

Provides information on how to initialize a Guid struct.

```APIDOC
## Guid()
### Description
Empty constructor.
### Declaration
```cpp
public Guid()
```

## Guid(uint32 a, uint32 b, uint32 c, uint32 d)
### Description
Initializes a new instance of the Guid struct.
### Declaration
```cpp
public Guid(uint32 a, uint32 b, uint32 c, uint32 d)
```
### Parameters
- **a** (uint32) - The first component.
- **b** (uint32) - The second component.
- **c** (uint32) - The third component.
- **d** (uint32) - The fourth component.
```

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

### SetUp(const Float3& value)

Source: https://docs.flaxengine.com/api-cpp/Matrix3x3.html

Sets the up vector of the matrix.

```APIDOC
## SetUp(const Float3& value)

### Parameters
- **value** (Float3)
```

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

### Get()

Source: https://docs.flaxengine.com/api-cpp/StringBase.html

Gets the pointer to the string (or null if text is empty).

```APIDOC
## Get()

### Description
Gets the pointer to the string (or null if text is empty).

### Returns
- **T* ** - The string handle.
```

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

### Set Asset by Guid

Source: https://docs.flaxengine.com/api-cpp/SoftAssetReference.html

Sets the asset reference using a Guid.

```APIDOC
## Set(const Guid& id)

### Description
Sets the asset reference using a Guid. Uses Scripting to find the registered asset of the given ID.

### Method
`void Set(const Guid& id)`

### Parameters
- **id** (const Guid&) - The object ID of the asset to set.

### Returns
- void
```

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

### Init()

Source: https://docs.flaxengine.com/api-cpp/VolumetricFogPass.html

Initializes the volumetric fog service.

```APIDOC
## Init()

### Description
Initialize service.

### Declaration
```cpp
virtual bool Init() override
```

### Returns
- **bool** - Returns true if initialization was successful.
```

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

### Guid Methods

Source: https://docs.flaxengine.com/api-cpp/Guid.html

Explains the various methods available for the Guid struct.

```APIDOC
## IsValid()
### Description
Checks if the Guid is valid.
### Declaration
```cpp
public bool IsValid() const
```
### Returns
bool

## New()
### Description
Creates a new unique identifier.
### Declaration
```cpp
public static Guid New()
```
### Returns
Guid New Guid

## operator!=()
### Description
Compares two Guids for inequality.
### Declaration
```cpp
public bool operator!=(const Guid& other) const
```
### Parameters
- **other** (Guid) - The Guid to compare against.
### Returns
bool

## operator[]()
### Description
Accesses a component of the Guid by index.
### Declaration
```cpp
public uint32 operator[](int index) const
```
### Parameters
- **index** (int) - The index of the component to access.
### Returns
uint32

## operator[]()
### Description
Accesses a component of the Guid by index.
### Declaration
```cpp
public uint32 operator[](int32 index)
```
### Parameters
- **index** (int32) - The index of the component to access.
### Returns
uint32

## operator==()
### Description
Compares two Guids for equality.
### Declaration
```cpp
public bool operator==(const Guid& other) const
```
### Parameters
- **other** (Guid) - The Guid to compare against.
### Returns
bool

## Parse(const StringAnsiView& text, Guid& value)
### Description
Attempts to parse a Guid from an ANSI string.
### Declaration
```cpp
public static bool Parse(const StringAnsiView& text, Guid& value)
```
### Parameters
- **text** (StringAnsiView) - The input text to parse.
- **value** (Guid&) - The Guid struct to store the parsed value.
### Returns
bool - True if the text cannot be parsed, otherwise false.

## Parse(const StringView& text, Guid& value)
### Description
Attempts to parse a Guid from a string.
### Declaration
```cpp
public static bool Parse(const StringView& text, Guid& value)
```
### Parameters
- **text** (StringView) - The input text to parse.
- **value** (Guid&) - The Guid struct to store the parsed value.
### Returns
bool - True if the text cannot be parsed, otherwise false.

## ToString()
### Description
Converts the Guid to its string representation.
### Declaration
```cpp
public String ToString() const
```
### Returns
String

## ToString(char* buffer, FormatType format)
### Description
Converts the Guid to its string representation and stores it in a character buffer.
### Declaration
```cpp
public void ToString(char* buffer, FormatType format) const
```
### Parameters
- **buffer** (char*) - The buffer to store the string representation.
- **format** (FormatType) - The format to use for the string representation.

## ToString(Char* buffer, FormatType format)
### Description
Converts the Guid to its string representation and stores it in a character buffer.
### Declaration
```cpp
public void ToString(Char* buffer, FormatType format) const
```
### Parameters
- **buffer** (Char*) - The buffer to store the string representation.
- **format** (FormatType) - The format to use for the string representation.

## ToString(FormatType format)
### Description
Converts the Guid to its string representation with a specified format.
### Declaration
```cpp
public String ToString(FormatType format) const
```
### Parameters
- **format** (FormatType) - The format to use for the string representation.
### Returns
String
```

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

### setupResources

Source: https://docs.flaxengine.com/api-cpp/GlobalSignDistanceFieldPass.html

Sets up the necessary resources for the rendering pass. This is a virtual method that can be overridden by derived classes.

```APIDOC
## setupResources()

### Description
Sets up the necessary resources for the rendering pass. This is a virtual method that can be overridden by derived classes.

### Declaration
```cpp
protected virtual bool setupResources() override
```

### Returns
bool - True if resources were set up successfully, false otherwise.

### Overrides
RendererPassBase::setupResources()
```

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

### Guid Fields

Source: https://docs.flaxengine.com/api-cpp/Guid.html

Details about the fields available within the Guid struct.

```APIDOC
## Fields
### A
##### Declaration
```cpp
public uint32 A
```
##### Field Value
uint32

### B
##### Declaration
```cpp
public uint32 B
```
##### Field Value
uint32

### C
##### Declaration
```cpp
public uint32 C
```
##### Field Value
uint32

### D
##### Declaration
```cpp
public uint32 D
```
##### Field Value
uint32

### Empty
##### Declaration
```cpp
public static Guid Empty
```
##### Field Value
Guid

### Raw
##### Declaration
```cpp
public byte Raw[16]
```
##### Field Value
byte

### Values
##### Declaration
```cpp
public uint32 Values[4]
```
##### Field Value
uint32
```

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

### setupResources

Source: https://docs.flaxengine.com/api-cpp/LightPass.html

Protected method to set up resources, overriding the base class implementation. Returns a boolean indicating success.

```APIDOC
## setupResources()

### Description
Sets up the necessary resources for the renderer.

### Declaration
```cpp
protected virtual bool setupResources() override
```

### Returns
bool

### Overrides
RendererPassBase::setupResources()
```

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

### FindAsset (by Guid)

Source: https://docs.flaxengine.com/api-cpp/AssetsCache.html

Finds asset information by its unique identifier (Guid).

```APIDOC
## FindAsset (Guid)

### Description
Finds the asset information by its unique identifier (Guid).

### Method
```cpp
public bool FindAsset(const Guid& id, AssetInfo& info)
```

### Parameters
- **id** (Guid) - Required - The asset ID.
- **info** (AssetInfo&) - Output - The output asset info. Filled with valid values if the method returns true.

### Returns
- bool - True if an asset was found, otherwise false.
```

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

### SetupLights

Source: https://docs.flaxengine.com/api-cpp/LightPass.html

Setups the lights rendering for batched scene drawing. It requires a render context and a render context batch.

```APIDOC
## SetupLights(RenderContext& renderContext, RenderContextBatch& renderContextBatch)

### Description
Setups the lights rendering for batched scene drawing.

### Declaration
```cpp
public void SetupLights(RenderContext& renderContext, RenderContextBatch& renderContextBatch)
```

### Parameters
- **renderContext** (RenderContext&)
- **renderContextBatch** (RenderContextBatch&)
```

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

### Process

Source: https://docs.flaxengine.com/api-cpp/ShaderProcessing.ShaderFunctionReader.StripLineReader.html

Starts processing the source code after reading the start token.

```APIDOC
## Process(IShaderParser* parser, Reader& text)

### Description
Begins processing the source code after the initial start token has been read.

### Parameters
- **parser** (IShaderParser*) - The parser object.
- **text** (Reader&) - The source code reader.

### Overrides
ITokenReader::Process(IShaderParser* parser, Reader& text)
```

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

### SetupSkinningData

Source: https://docs.flaxengine.com/api-cpp/AnimatedModel.html

Validates and initializes the skinning data for the model.

```cpp
public void SetupSkinningData()
```

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

### Get Y Component

Source: https://docs.flaxengine.com/api-cpp/ShaderGraphValue.html

Gets the Y component of a ShaderGraphValue. This is only valid for vector types.

```cpp
public ShaderGraphValue GetY() const
```

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

### SetupSkeleton(const Array<SkeletonNode>& nodes, ...)

Source: https://docs.flaxengine.com/api-cpp/SkinnedModel.html

Setups the skinned model skeleton with nodes and optional bone data.

```APIDOC
## SetupSkeleton(const Array<SkeletonNode>& nodes, const Array<SkeletonBone>& bones, bool autoCalculateOffsetMatrix)

### Description
Setups the skinned model skeleton.

### Parameters
- **nodes** (Array<SkeletonNode>) - The nodes hierarchy. The first node must be a root one (with parent index equal -1).
- **bones** (Array<SkeletonBone>) - The bones hierarchy.
- **autoCalculateOffsetMatrix** (bool) - If true then the OffsetMatrix for each bone will be auto-calculated by the engine, otherwise the provided values will be used.

### Returns
- **bool** - True if failed, otherwise false.
```

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

### Get Position Handle

Source: https://docs.flaxengine.com/api-cpp/MemoryReadStream.html

Gets the current handle to the position in the buffer.

```cpp
public byte* GetPositionHandle() const
```
Tokens:
Raw