id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_sr_7d8ce3e09c39
unity_docs
scripting
Give me an overview of the `SerializeReference` class in Unity.
SerializeReference class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Marks a field to be serialized as a reference instead of as a value. See the serialization manual page for information about serialization and the complete serialization rules. Without the use of the [SerializeRefere...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae20991a1ae7
unity_docs
editor
What are the parameters of `EditorGUILayout.EnumPopup` in Unity?
Returns Enum The enum option that has been selected by the user. Description Make an enum popup selection field. Takes the currently selected enum value as a parameter and returns the enum value selected by the user. Creates a primitive selected by the user. ```csharp using UnityEditor; using UnityEngine; using System....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2f3339e38506
unity_docs
scripting
Show me a Unity code example for 'Introduction to asynchronous programming with Awaitable'.
y’s asynchronous APIs support the async and await pattern, including: Unity coroutines: NextFrameAsync , WaitForSecondsAsync , EndOfFrameAsync , FixedUpdateAsync Switching to Background Thread or Main Thread All types inheriting from AsyncOperation Unity Events Async GPU Readback You can use the Awaitable class with bo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1422a8762542
unity_docs
scripting
What are the parameters of `PlayerPrefs.GetInt` in Unity?
Returns int The int value that corresponds to the given key . Returns 0 if no int value is found for the given key . Description Gets the int value that corresponds to key in the player preferences. Returns 0 if no int value is found for the given key . ```csharp //Use this script to fetch the settings and show them as...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d97d6187e204
unity_docs
ui
Show me a Unity code example for 'Foldout'.
en the container is expanded, the arrow points down. Container : A container contains the visual elements that you want to show or hide when you toggle the Foldout. You can add elements to a Foldout’s container, and the show-or-hide function works automatically. The following UI Document creates a Foldout with two butt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_683e60602397
unity_docs
rendering
Explain 'Adding material properties to shaders' in Unity.
Resources and techniques for adding properties to shaders that artists can use to create, edit, and share materials with different configurations. Page Description Introduction to material properties Understand how to add material properties, how material property values are provided to shaders, and the difference betw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55a008def4f0
unity_docs
performance
Show me a Unity C# example demonstrating `Unity.Profiling.ProfilerRecorderOptions.CollectOnlyOnCurrentThread`.
ProfilerRecorderOptions.CollectOnlyOnCurrentThread Description Use to collect samples only on the thread ProfilerRecorder was initialized on. ```csharp using System; using Unity.Profiling; using UnityEngine;public class CollectGCAllocCountExample { static void PrintGCAllocCount(Action a) { using (var gcAllocReco...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0dcf5f794026
unity_docs
scripting
Give me an overview of the `TerrainData` class in Unity.
TerrainData class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.TerrainModule Description The TerrainData class stores heightmaps, detail mesh positions, tree instances, and terrain texture alpha maps. The Terrain component links to the terrain data and renders it. Static Properties ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7dff94dda4da
unity_docs
scripting
Show me a Unity C# example demonstrating `CharacterController.isGrounded`.
ching the ground during the most recent call to CharacterController.Move or CharacterController.SimpleMove. This property is updated after each call to Move, based on collision detection with the ground. It returns true if the controller collided with any object below it during the movement — typically used to determi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47b57e2aaace
unity_docs
math
What is `IMGUI.Controls.SphereBoundsHandle.ctor` in Unity? Explain its purpose and usage.
SphereBoundsHandle Constructor Declaration public SphereBoundsHandle (); Obsolete Use parameterless constructor instead. Declaration public SphereBoundsHandle (int controlIDHint ); Parameters Parameter Description controlIDHint An integer value used to generate consistent control IDs for each control ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5c3e7c92cee0
unity_docs
rendering
In Unity's 'Trail Renderer component reference', what is 'Trail settings' and how does it work?
Property Function Width Define a width value, and a curve value to control the width of your trail along its length. The curve is sampled at each vertex, so its accuracy is limited by the number of vertices in your trail. The overall width of the trail is controlled by the width value. Time Define the lifetime of a poi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc4b656a6cd2
unity_docs
rendering
What is `GUILayout.SelectionGrid` in Unity? Explain its purpose and usage.
GUILayout.SelectionGrid Declaration public static int SelectionGrid (int selected , string[] texts , int xCount , params GUILayoutOption[] options ); Declaration public static int SelectionGrid (int selected , Texture[] images , int xCount , params GUILayoutOption[] options ); Declaration public stati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_957e399b3d1a
unity_docs
scripting
What is `Unity.Properties.IPropertyBag_1` in Unity? Explain its purpose and usage.
IPropertyBag<T0> interface in Unity.Properties Implements interfaces: IPropertyBag Description Base typed interface for implementing property bags. Public Methods Method Description Accept Call this method to invoke IPropertyBagVisitor.Visit_1 with the strongly typed container. CreateInstance Create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39d3f88ae026
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.GetTotalSizeOfNonASRMReadsBytes` in Unity? Explain its purpose and usage.
AsyncReadManagerMetrics.GetTotalSizeOfNonASRMReadsBytes Declaration public static ulong GetTotalSizeOfNonASRMReadsBytes (bool emptyAfterRead ); Parameters Parameter Description emptyAfterRead Set to true to reset the underlying data counter to zero after calling this function. Set to false if you want ea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_39487cdd8206
unity_docs
scripting
Explain 'VR frame timing' in Unity.
Frame timing in VR mode works exactly like it does in VSync-enabled non-VR mode (see documentation on the Execution order of event functions ). The only difference is that Unity does not depend on the underlying 3D SDK’s VSync , but instead whichever VR SDK it currently renders with. There is no benefit to rendering fa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b9128dae34e6
unity_docs
editor
In Unity's 'Refreshing the Asset Database', what is 'Restarting the refresh process' and how does it work?
Unity restarts the Asset Database refresh process if: The import of an asset fails. After the import, a file that the importer used has changed on disk. In OnPostProcessAllAssets , you call any of the following: ForceReserializeAssets AssetImporter.SaveAndReimport Any AssetDatabase API that queues an additional refresh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7471c0f7ed41
unity_docs
rendering
What are the parameters of `GL.GetGPUProjectionMatrix` in Unity?
Returns Matrix4x4 Adjusted projection matrix for the current graphics API. Description Compute GPU projection matrix from camera's projection matrix. In Unity, projection matrices follow OpenGL convention. However on some platforms they have to be transformed a bit to match the native API requirements. Use this functio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d3cea98d75d
unity_docs
ui
What is `EditorWindow.OnDestroy` in Unity? Explain its purpose and usage.
EditorWindow.OnDestroy() Description OnDestroy is called to close the EditorWindow window. A simple example of OnDestroy() ```csharp // Close the window when the Button is pressed. The window // will receive an OnDestroy() call. using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class OnD...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46c217cb83e5
unity_docs
physics
Give me an overview of the `JointSuspension2D` class in Unity.
JointSuspension2D struct in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Joint suspension is used to define how suspension works on a WheelJoint2D . Additional resources: WheelJoint2D class. Properties Property Description angle The world angle (in degrees) along which the suspen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0646b19af3be
unity_docs
rendering
What is `Rendering.CommandBuffer.IssuePluginCustomTextureUpdateV2` in Unity? Explain its purpose and usage.
CommandBuffer.IssuePluginCustomTextureUpdateV2 Declaration public void IssuePluginCustomTextureUpdateV2 (IntPtr callback , Texture targetTexture , uint userData ); Parameters Parameter Description callback Native code callback to queue for Unity's renderer to invoke. targetTexture Texture resource to b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_afcba067dff9
unity_docs
rendering
Explain 'Streaming Virtual Texturing' in Unity.
Streaming Virtual Texturing (SVT) is a feature that reduces GPU memory usage and texture loading times when you have many high resolution textures in your Scene . It splits textures into tiles, and progressively uploads these tiles to GPU memory when they are needed. SVT lets you set a fixed memory cost. For full textu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49c8af090b48
unity_docs
physics
What is `PhysicsScene.SphereCast` in Unity? Explain its purpose and usage.
PhysicsScene.SphereCast Declaration public bool SphereCast ( Vector3 origin , float radius , Vector3 direction , out RaycastHit hitInfo , float maxDistance = Mathf.Infinity, int layerMask = DefaultRaycastLayers, QueryTriggerInteraction queryTriggerInteraction = QueryTriggerInteraction.UseGlobal); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0fa52a5e7e6d
unity_docs
scripting
What is `Unity.Android.Gradle.ExternalNativeBuild` in Unity? Explain its purpose and usage.
ExternalNativeBuild class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the externalNativeBuild element in a gradle file. For more information about the element, see Android's documentation: ExternalNativeBuild Properties Property Description Cma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d5f9d370f872_doc_7
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Input action assets associated with locomotion to affect when the active movement control scheme is set.Can use this list by itself or together with the Action Maps list to set control scheme masks by Asset or Map. Signature: ```csharp public List<InputActionAsset> actionAssets ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
gh_02e8dd62f2b3_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Gets a for the new entry object. Signature: ```csharp public static SerializedObject NewEntryObject ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_c7eb8e1c273e
unity_docs
rendering
What is `Rendering.RenderPipeline.BeginContextRendering` in Unity? Explain its purpose and usage.
RenderPipeline.BeginContextRendering Declaration protected static void BeginContextRendering ( Rendering.ScriptableRenderContext context , List<Camera> cameras ); Description Calls the RenderPipelineManager.beginContextRendering and RenderPipelineManager.beginFrameRendering delegates. Use the delegates t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_06aa10cb2de3
unity_docs
editor
Explain 'Create your own overlay' in Unity.
You can create custom panel overlays and toolbar overlays for the Scene view window. Panel Overlays Toolbar Overlays Tip : For information about creating UIElements, refer to the UI Elements Developer Guide . ## Understand EditorToolbarElement A toolbar element can contain text, an icon, or a combination of both. Use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59408695a241
unity_docs
physics
What is `VersionControl.Provider.requiresNetwork` in Unity? Explain its purpose and usage.
Provider.requiresNetwork public static bool requiresNetwork ; Description This is true if a network connection is required by the currently selected version control plugin to perform any action. E.g. before doing anything using Perforce you need to checkout the asset, in order to do that a connection to the ser...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08b3ee07cb54
unity_docs
scripting
What is `Progress.Item.parentId` in Unity? Explain its purpose and usage.
Progress.Item.parentId public int parentId ; Description Returns the unique ID of the progress indicator's parent, or -1 if the progress indicator is not a child of another progress indicator. Additional resources: Progress.GetParentId .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f346f152c307
unity_docs
rendering
What is `CombineInstance` in Unity? Explain its purpose and usage.
CombineInstance struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Struct used to describe meshes to be combined using Mesh.CombineMeshes . Properties Property Description lightmapScaleOffset The baked lightmap UV scale and offset applied to the Mesh. mesh Mesh to combine. realti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ea26d266530
unity_docs
scripting
What are the parameters of `MonoBehaviour.StopCoroutine` in Unity?
Description Stops the first coroutine named methodName , or the coroutine stored in routine running on this behaviour. StopCoroutine takes one of three arguments that specify which coroutine to stop: A string function naming the active coroutine. The IEnumerator variable used earlier to create the coroutine. The Corout...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9c525edf288
unity_docs
rendering
What is `Rendering.RayTracingMeshInstanceConfig` in Unity? Explain its purpose and usage.
RayTracingMeshInstanceConfig struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Parameters you can use to configure ray tracing Mesh instances that are part of a RayTracingAccelerationStructure . This structure groups common parameters between different ray tracing instances...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66088d9d6e2b
unity_docs
animation
Show me a Unity C# example demonstrating `ArmDof.LastArmDof`.
ArmDof.LastArmDof Description The last value of the ArmDof enum. This value can be used in for loops. ```csharp using UnityEngine;using UnityEngine.Animations;public class ExampleClass : MonoBehaviour { void Start() { for (int i = 0; i < (int)ArmDof.LastArmDof; ++i) { var handle = new MuscleHandle(HumanPa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e857f47be01c
unity_docs
rendering
In Unity's 'Render queues and sorting behaviours', what is 'Sorting behaviors within render queues' and how does it work?
Within each render queue, Unity sorts and draws objects based on their distance from the camera . The sorting behavior depends on the index of the render queue: For queues with an index up to and including 2500 (Geometry + 500), Unity sorts Renderers in these queues using the behavior defined in OpaqueSortMode.FrontToB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b97744940c5
unity_docs
math
What is `AndroidJNI.ToLongArray` in Unity? Explain its purpose and usage.
AndroidJNI.ToLongArray Declaration public static IntPtr ToLongArray (long[] array ); Description Converts a managed array of System.Int64 to a Java array of long . Additional resources: AndroidJNI.NewLongArray , AndroidJNI.SetLongArrayElement .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ee60d7eeefc3
unity_docs
rendering
In Unity's 'iOS authorizations in Unity', what is 'Provide feature usage description' and how does it work?
A feature usage description or purpose string is a message that the iOS system displays when your application tries to access the device feature. It’s best practice to add a clear description stating the reason for application access. You can enter the feature usage description in Configuration section of Player settin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2fc05902e6c0
unity_docs
animation
Explain 'Create an Animator Controller' in Unity.
You can view and set up character behavior from the Animator Controller view (Menu: Window > Animation > Animator ). To create an Animator Controller, do one of the following: Select Create > Animator Controller from the Project window. Right-click in the Project window and select Create > Animator Controller . From th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3bd9cda4d88b
unity_docs
scripting
What is `AI.NavMeshBuildSettings.ledgeDropHeight` in Unity? Explain its purpose and usage.
NavMeshBuildSettings.ledgeDropHeight public float ledgeDropHeight ; Description Maximum agent drop height. Drop-Down link generation is controlled by the Drop Height parameter. The parameter controls what is the highest drop that will be connected, setting the value to 0 will disable the generation. The traject...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b191e5cd8e3
unity_docs
physics
What is `Physics2D.OverlapCapsule` in Unity? Explain its purpose and usage.
Physics2D.OverlapCapsule Declaration public static Collider2D OverlapCapsule ( Vector2 point , Vector2 size , CapsuleDirection2D direction , float angle , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0d2bc68f42b
unity_docs
editor
What are the parameters of `Android.AndroidProjectFiles.SetFileContents` in Unity?
Description Sets the content of a new file to the specified bytes. To use this method, you must first declare the new file in AndroidProjectFilesModifier.Setup using the AndroidProjectFilesModifierContext.AdditionalOutputs.AddFileWithContents method. ```csharp using UnityEditor.Android;public class ModifyProjectScript ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_221713f444a3_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Destroys the given GameObject if it is not null, then creates a child GameObject with the given TComponent component and assigns it to the reference.TComponent will be initialized with the given arguments.Can be null, if it is not then it will be destroyed.The TArgs object to be passed in on initialization.The type of ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
gh_6910d9d9a9ea_doc_11
github
scripting
What does `FixedUpdateAsObservable` do in this Unity script? Explain its purpose and signature.
This function is called every fixed framerate frame, if the MonoBehaviour is enabled. Signature: ```csharp public static IObservable<Unit> FixedUpdateAsObservable(this Component component) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_959b78b63138
unity_docs
scripting
What are the parameters of `Physics2D.Simulate` in Unity?
Returns bool Whether the simulation was run or not. Running the simulation during physics callbacks will always fail. Description Simulate physics in the default physics scene. Calling Physics2D.Simulate will perform a single simulation step, simulating physics over the specified step time. By default, All Layers are ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08df5983151f
unity_docs
editor
What is `Device.SystemInfo.supportsMultiview` in Unity? Explain its purpose and usage.
SystemInfo.supportsMultiview public static bool supportsMultiview ; Description This has the same functionality as SystemInfo.supportsMultiview and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba2c29090722
unity_docs
scripting
What is `Search.QueryFilterOperator.token` in Unity? Explain its purpose and usage.
QueryFilterOperator.token public string token ; Description The operator identifier. This property is the token used when creating a QueryFilterOperator . See QueryEngine.AddOperator or IQueryEngineFilter.AddOperator .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ede1d4fa266
unity_docs
input
What is `AI.NavMeshAgent.FindClosestEdge` in Unity? Explain its purpose and usage.
NavMeshAgent.FindClosestEdge Declaration public bool FindClosestEdge (out AI.NavMeshHit hit ); Parameters Parameter Description hit Holds the properties of the resulting location. Returns bool True if a nearest edge is found. Description Locate the closest NavMesh edge. The returned NavMeshHit o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4427805634f1_doc_4
github
scripting
What does `CommitFrame` do in this Unity script? Explain its purpose and signature.
Commit a video pixel buffer for encoding.The pixel buffer MUST have an RGBA8888 pixel layout.Pixel buffer in native memory to commit.Not used. Signature: ```csharp public void CommitFrame (IntPtr nativeBuffer, long timestamp = default) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67e4e5622e44
unity_docs
rendering
What is `MeshPreview` in Unity? Explain its purpose and usage.
MeshPreview class in UnityEditor Description Use this class to render an interactive preview of a mesh. Use this class from an ObjectPreview or Editor.OnPreviewGUI to render an interactive mesh preview. Properties Property Description mesh The Mesh to display in the preview space. Constructors Construct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b30d3405da95
unity_docs
scripting
What is `TerrainTools.BrushTransform.FromRect` in Unity? Explain its purpose and usage.
BrushTransform.FromRect Declaration public static TerrainTools.BrushTransform FromRect ( Rect brushRect ); Parameters Parameter Description brushRect Brush rectangle, in target XY coordinates. Returns BrushTransform BrushTransform describing the brush. Description Creates an axis-aligned BrushTran...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d4571970c24
unity_docs
scripting
What is `DetailInstanceTransform.posX` in Unity? Explain its purpose and usage.
DetailInstanceTransform.posX public float posX ; Description The X coordinate of the detail object in the Terrain's local space. To get the X in world space, add this value to position X of the Terrain.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfd3d3847969
unity_docs
performance
What is `Unity.Collections.LowLevel.Unsafe.NativeArrayUnsafeUtility.ConvertExistingDataToNativeArray` in Unity? Explain its purpose and usage.
NativeArrayUnsafeUtility.ConvertExistingDataToNativeArray Declaration public static NativeArray<T> ConvertExistingDataToNativeArray (void* dataPointer , int length , Unity.Collections.Allocator allocator ); Parameters Parameter Description dataPointer Pointer to the preallocated data. length Number of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0ec467fcd7e0
unity_docs
scripting
Explain 'Native plug-ins' in Unity.
Unity supports native plug-ins , which are libraries of native code you can write in languages such as C, C++, and Objective-C. Plug-ins allow the code you write in C# to call functions from these libraries. This feature allows Unity to integrate with middleware libraries or existing C/C++ code. The native plug-in prov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b082bf2d2b28
unity_docs
editor
What is `Search.QueryEngine_1.AddTypeParser` in Unity? Explain its purpose and usage.
QueryEngine<T0>.AddTypeParser Declaration public void AddTypeParser (Func<string,ParseResult<TFilterConstant>> parser ); Parameters Parameter Description parser Callback used to determine if a string can be converted into TFilterConstant. Takes a string and returns a ParseResult object. This contains the suc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e5970f3d2af3
github
scripting
Write a Unity C# MonoBehaviour script called Rotater
```csharp using UnityEngine; class Rotater: MonoBehaviour { public void Update() { _angle = transform.rotation.eulerAngles.x; if (_angle <= rotationAngle) _multiplier *= -1; transform.Rotate(transform.right, rotationSpeed * _multiplier * Time.deltaTime); } public f...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_dfb90c5c2267
unity_docs
scripting
Explain 'Script Execution Order reference' in Unity.
Use the Script Execution Order settings to specify the relative execution order of different MonoBehaviour script components in your project. The execution order between different scripts in the project is different from and doesn’t change the order of execution for event functions within each individual script. Unity ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79bb79dbdf63
unity_docs
editor
What is `EditorApplication.pauseStateChanged` in Unity? Explain its purpose and usage.
EditorApplication.pauseStateChanged Description Event that is raised whenever the Editor's pause state changes. Add an event handler to this event to receive a notification that the pause state has changed, as well as information about the state it has changed into. Note that the Editor may be paused or unpaused in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17a36d229d03
unity_docs
input
Show me a Unity C# example demonstrating `Input.GetAxisRaw`.
ommended best practice is that you don't use this API in new projects. For new projects, use the Input System package. To learn more about input, refer to Input . The value will be in the range -1...1 for keyboard and joystick input. Since input is not smoothed, keyboard input will always be either -1, 0 or 1. This is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d42aa010518
unity_docs
scripting
What is `PlayerSettings.SetDynamicBatchingForPlatform` in Unity? Explain its purpose and usage.
PlayerSettings.SetDynamicBatchingForPlatform Declaration public static void SetDynamicBatchingForPlatform ( BuildTarget platform , bool enable ); Parameters Parameter Description platform BuildTarget to set dynamic batching for. enable Should dynamic batching be enabled. Description Sets dynamic batch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c1881c015a3e
unity_docs
animation
Show me a Unity code example for 'Deterministic builds introduction'.
the same Unity Editor version, Xcode version, and toolchains across builds. Small serialization changes between Unity versions can change AssetBundle byte layouts. Disable automatic new line conversion in Git: Windows and macOS encode line endings differently, and automatic line conversion modifies file hashes and brea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9dc63cbac101
unity_docs
editor
Explain 'Run Unity from a command-line interface' in Unity.
You can launch the Unity Editor from your operating system’s command-line interface and pass in arguments to change how the Editor launches. You can also use the command line to execute specific methods from your project’s C# scripts at launch. When launching the Unity Editor, the delimiter for a command-line argument ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88df0ca93edc
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.MinMaxGradient`.
or a Min-Max Gradient. This contains two Gradient s, and returns a Color based on ParticleSystem.MinMaxGradient.mode . Depending on the mode, this may return the value randomized. Gradients are edited via the ParticleSystem Inspector once a ParticleSystemGradientMode requiring them has been selected. Some modes ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f5160a63271
unity_docs
scripting
What is `Events.UnityEventBase.GetPersistentListenerState` in Unity? Explain its purpose and usage.
UnityEventBase.GetPersistentListenerState Declaration public Events.UnityEventCallState GetPersistentListenerState (int index ); Parameters Parameter Description index Index of the listener to query. Returns UnityEventCallState Execution state of the persistent listener. Description Returns the exe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_248701e48920
unity_docs
scripting
What is `ObjectFactory.CreateGameObject` in Unity? Explain its purpose and usage.
ObjectFactory.CreateGameObject Declaration public static GameObject CreateGameObject (string name , params Type[] types ); Declaration public static GameObject CreateGameObject ( SceneManagement.Scene scene , HideFlags hideFlags , string name , params Type[] types ); Parameters Parameter Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d1aa5fcd5556
unity_docs
rendering
In Unity's 'Lightmap Parameters Asset Inspector window reference', what is 'Realtime GI' and how does it work?
These parameters configure Enlighten Realtime Global Illumination . See render pipeline feature comparison for more information about support for Enlighten Realtime Global Illumination across render pipelines . Property Function Resolution This value scales the Realtime Resolution value in the Scene tab of the Lighting...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_14
github
scripting
What does `Rotate` do in this Unity script? Explain its purpose and signature.
Rotates the brush by 90 degrees in the given direction.Direction to rotate by.Cell Layout for rotating. Signature: ```csharp public override void Rotate(RotationDirection direction, Grid.CellLayout layout) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_0c69a9037fb8
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.GetComponentInParent`.
can then call GetComponentInParent on that reference. Note : If the type you request is a derivative of MonoBehaviour and the associated script can't be loaded then this function will return null for that component. The following example gets a reference to a hinge joint component on the referenced GameObject or an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f8c6f5db08a
unity_docs
animation
Show me a Unity C# example demonstrating `Animator.GetBehaviours`.
Animator.GetBehaviours Declaration public T[] GetBehaviours (); Description Returns all StateMachineBehaviour that match type T or are derived from T . Returns null if none are found. ```csharp using UnityEngine; using System.Collections;// An example StateMachineBehaviour. public class BreathBehaviour : ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d514b971008
unity_docs
ui
What is `IMGUI.Controls.TreeView.foldoutOverride` in Unity? Explain its purpose and usage.
TreeView.foldoutOverride protected IMGUI.Controls.TreeView.DoFoldoutCallback foldoutOverride ; Description Register a callback to this property to override the Foldout button in the TreeView.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_06eb00675f41
unity_docs
rendering
In Unity's 'Render queues and sorting behaviours', what is 'Render queues' and how does it work?
Unity sorts objects into groups called render queues. Unity renders the contents of one render queue, and then renders the contents of another render queue, and so on. Unity has the following named render queues, which it renders in the following order: Name Index Description Background 1000 Use this queue for anything...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c40536ae52c6
unity_docs
performance
Show me a Unity code example for 'Bucket allocator example'.
Bucket allocators produce different usage reports for a development build and a release build because in a development build each allocation has an additional 40 byte header. The following diagram demonstrates the difference between development and release builds for 16 byte and 64 byte allocations: The header is the r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4206f08b8ca5
unity_docs
rendering
What is `RenderTextureFormat` in Unity? Explain its purpose and usage.
RenderTextureFormat enumeration Description Format of a RenderTexture . Note that a particular render texture format might not be supported by the current platform or GPU. Use SystemInfo.SupportsRenderTextureFormat to check before using. Additional resources: RenderTexture class. Properties Property Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e509f5034caa
unity_docs
ui
In Unity's 'Child selectors', what is 'Example' and how does it work?
To demonstrate how simple selectors match elements, here is an example UI Document. ``` <UXML xmlns="UnityEngine.UIElements"> <VisualElement name="container1"> <VisualElement name="container2" class="yellow"> <Button name="OK" class="yellow" text="OK" /> <Button name="Cancel" text="Cancel" /> </VisualElement> </V...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_138fdb84a130
github
scripting
Write a Unity C# XR/VR script for Locale Changer
```csharp using System; using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Events; using UnityEngine.Localization.Settings; using UnityEngine.Localization; using ExPresSXR.Misc; using System.Text.RegularExpressions; namespace ExPresSXR.Localization { public class Local...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_c9a144eb4d12
unity_docs
physics
What is `Rigidbody2D.localToWorldMatrix` in Unity? Explain its purpose and usage.
Rigidbody2D.localToWorldMatrix public Matrix4x4 localToWorldMatrix ; Description The transformation matrix used to transform the Rigidbody2D to world space. The transformation matrix is calculated as the combination of the Rigidbody2D.position and the Rigidbody2D.rotation . Additional resources: Collider2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6249fe96f826
unity_docs
scripting
What is `Windows.Speech.DictationRecognizer` in Unity? Explain its purpose and usage.
DictationRecognizer class in UnityEngine.Windows.Speech / Implemented in: UnityEngine.CoreModule Description DictationRecognizer listens to speech input and attempts to determine what phrase was uttered. Users can register and listen for hypothesis and phrase completed events. Start() and Stop() methods respect...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1a14ea5a5400
github
scripting
Write a Unity C# MonoBehaviour script called Default Style Controller
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; namespace BehaviourInject.Example { //another examble of dependency recipient public class DefaultStyleController : MonoBehaviour { //Injected dependency (TileStyle here) is resolved by Injector on the same gameObject //In...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_a0e3bcdc36fe
unity_docs
xr
In Unity's 'Notarize with Xcode and command-line tools', what is 'Use Xcode command-line tools' and how does it work?
If you can’t notarize your application in the Xcode environment or want to control notarization manually, you can use Xcode’s command-line tools. To do this, you need the following: An Apple ID . An Apple device that runs macOS 10.15 Catalina or later. Xcode 11 or later . This installs the required command-line tools. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41b4f25d91dc
unity_docs
scripting
What is `AI.NavMesh.onPreUpdate` in Unity? Explain its purpose and usage.
NavMesh.onPreUpdate public static AI.NavMesh.OnNavMeshPreUpdate onPreUpdate ; Description Set a function to be called before the NavMesh is updated during the frame update execution. This lets you set a delegate function to be called every frame, right before the NavMesh system gets updated. Additional resour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2006ebac982
unity_docs
rendering
Show me a Unity C# example demonstrating `Matrix4x4.Perspective`.
, m22 and m32) by -1. Note that depending on the graphics API used, projection matrices in shaders can follow different convention, for example the D3D-style clip space has near plane at zero and far plane at one; and "reversed Z" projection has near plane at one and far plane at zero. To calculate projection matrix va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1d0c2d8ea65
unity_docs
scripting
What is `GUI.Window` in Unity? Explain its purpose and usage.
GUI.Window Declaration public static Rect Window (int id , Rect clientRect , GUI.WindowFunction func , string text ); Declaration public static Rect Window (int id , Rect clientRect , GUI.WindowFunction func , Texture image ); Declaration public static Rect Window (int id , Rect c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e81d23c5a3c8
unity_docs
xr
What is `LightTransport.BakeProgressState.Cancel` in Unity? Explain its purpose and usage.
BakeProgressState.Cancel Declaration public void Cancel (); Description Cancel the asynchronous operation. Requests cancellation of any ongoing operations that use this progress state. This method returns immediately and the operation is cancelled once the implementation has a chance to react to the request and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f97a5b849499
unity_docs
rendering
What is `Experimental.Rendering.GraphicsStateCollection.isWarmedUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsStateCollection.isWarmedUp public bool isWarmedUp ; Description Flag indicating if the collection is warmed up. When a collection is "warmed up", all the GPU representations of the shader variants and graphics states...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1130c858cbd
unity_docs
math
What is `Color.LerpUnclamped` in Unity? Explain its purpose and usage.
Color.LerpUnclamped Declaration public static Color LerpUnclamped ( Color a , Color b , float t ); Description Linearly interpolates between colors a and b by t . When t is 0 returns a . When t is 1 returns b . Additional resources: Lerp .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bef917354a02
unity_docs
editor
What is `PlayerSettings.WSA.splashScreenBackgroundColor` in Unity? Explain its purpose and usage.
PlayerSettings.WSA.splashScreenBackgroundColor public static Nullable<Color> splashScreenBackgroundColor ; Description The Override background color for the Unity splash screen. In the Editor, Unity displays this under Splash Image in UWP Player Settings as the Override background color setting. This ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6eb384bc73c0
unity_docs
editor
What is `NonReorderableAttribute` in Unity? Explain its purpose and usage.
NonReorderableAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Disables reordering of an array or list in the Inspector window. By default, array or list script variables are presented with a UI control that allows array element reordering ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c70012af2f45
unity_docs
xr
Explain 'Apple ARKit XR Plugin' in Unity.
com.unity.xr.arkit ## Description Provides native Apple ARKit integration for use with Unity’s multi-platform XR API. Supports the following features: -Efficient Background Rendering -Horizontal Planes -Depth Data -Anchors -Hit Testing -Face Tracking -Environment Probes -Meshing -Occlusion * Apple and ARKit are trade...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11608f490454
unity_docs
xr
What is `XR.XRDisplaySubsystemDescriptor` in Unity? Explain its purpose and usage.
XRDisplaySubsystemDescriptor class in UnityEngine.XR / Inherits from: IntegratedSubsystemDescriptor / Implemented in: UnityEngine.XRModule Description Class providing information about XRDisplaySubsystem registration. Properties Property Description disablesLegacyVr Indicates whether legacy VR settings m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c194ecc7f220
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody.AddForceAtPosition`.
que will be unrealistically large. Force can be applied only to an active rigidbody. If a GameObject is inactive, AddForceAtPosition has no effect. Wakes up the Rigidbody by default. If the force size is zero then the Rigidbody will not be woken up. For more information on how ForceMode affects velocity, see Rigidbody...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_967a6307b5d9_doc_13
github
scripting
What does `GetOverrides` do in this Unity script? Explain its purpose and signature.
Gets Sprite overrides for thisA list of Sprite overrides to fillThe input overrides list is not valid Signature: ```csharp public void GetOverrides(List<KeyValuePair<Sprite, Sprite>> overrides) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_16b9a2fc815b
unity_docs
scripting
What is `UIElements.UxmlColorAttributeDescription.GetValueFromBag` in Unity? Explain its purpose and usage.
UxmlColorAttributeDescription.GetValueFromBag Declaration public Color GetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. Returns Color The value of the a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cf2da7c5955
unity_docs
scripting
What is `RenderSettings.fogMode` in Unity? Explain its purpose and usage.
RenderSettings.fogMode public static FogMode fogMode ; Description Fog mode to use. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { // Use linear fog RenderSettings.fogMode = FogMode.Linear; } } ``` Additional resources: RenderSettings....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9c007fd8f12
unity_docs
scripting
What is `ParticleSystem.InheritVelocityModule.enabled` in Unity? Explain its purpose and usage.
ParticleSystem.InheritVelocityModule.enabled public bool enabled ; Description Specifies whether the InheritVelocityModule is enabled or disabled. Additional resources: ParticleSystem.inheritVelocity . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public cla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09d85d8cf4cc
unity_docs
editor
Give me an overview of the `Gradient` class in Unity.
Gradient class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Represents a Gradient used for animating colors. Gradients allow animating or interpolating colors by having several "color keys" and "alpha keys". Color keys and alpha keys are separate, and each key has a time specified for it,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_967a6307b5d9_doc_10
github
scripting
What does `RefreshTile` do in this Unity script? Explain its purpose and signature.
This method is called when the tile is refreshed.Position of the Tile on the Tilemap.The Tilemap the tile is present on. Signature: ```csharp public override void RefreshTile(Vector3Int position, ITilemap tilemap) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_84da3d28ba70
unity_docs
xr
What is `XR.XRDisplaySubsystem.zNear` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.zNear public float zNear ; Description Set DisplaySubsystem to use zNear for rendering. zNear is the near plan in meters from the main camera. ZFar and ZNear are used for explicit XR depth buffer sharing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e86068e29316
unity_docs
scripting
What is `Rendering.VertexAttributeDescriptor.dimension` in Unity? Explain its purpose and usage.
VertexAttributeDescriptor.dimension public int dimension ; Description Dimensionality of the vertex attribute. Dimension should be between 1 and 4 inclusive. Default value is 3. Additional resources: Mesh.SetVertexBufferParams .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6eb56eefc6df
unity_docs
rendering
What is `ParticleSystem.SubEmittersModule.SetSubEmitterProperties` in Unity? Explain its purpose and usage.
ParticleSystem.SubEmittersModule.SetSubEmitterProperties Declaration public void SetSubEmitterProperties (int index , ParticleSystemSubEmitterProperties properties ); Parameters Parameter Description index The index of the sub-emitter you want to modify. properties The new properties to assign to this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d357ea0eb047
unity_docs
scripting
What is `QualitySettings.desiredColorSpace` in Unity? Explain its purpose and usage.
QualitySettings.desiredColorSpace public static ColorSpace desiredColorSpace ; Description Desired color space (Read Only). This is the desired color space based on player settings ( PlayerSettings.colorSpace ). Note that if the platform or hardware does not support the given color space, the actually used c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44c5483aad30
unity_docs
rendering
What is `Experimental.Rendering.GraphicsStateCollection.ClearVariants` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsStateCollection.ClearVariants Declaration public void ClearVariants (); Description Clears all shader variants and associated graphics states from collection.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b854945c6c29
unity_docs
xr
What is `XR.InputTracking.GetNodeStates` in Unity? Explain its purpose and usage.
InputTracking.GetNodeStates Declaration public static void GetNodeStates (List<XRNodeState> nodeStates ); Parameters Parameter Description nodeStates A list that is populated with XRNodeState objects. Description Describes all currently connected XRNodes and provides available tracking states for each. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.