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_3ce6053329b4
unity_docs
physics
What is `Tilemaps.TileAnimationFlags` in Unity? Explain its purpose and usage.
TileAnimationFlags enumeration Description Options for flags controlling behavior for a Tile Animation on a Tilemap . Properties Property Description None Sets no TileAnimationFlags and the Tile Animation will run normally. LoopOnce Loops the Tile Animation once, then stops on the last Sprite of the animation...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9d79089b5f0
unity_docs
scripting
What are the parameters of `Caching.ClearCachedVersion` in Unity?
Returns bool Returns true when cache clearing succeeded. Can return false if any cached bundle is in use. Description Removes the given version of the AssetBundle. ```csharp using UnityEngine;public class Example : MonoBehaviour { void ClearAssetBundleBundleFromCache(AssetBundle bundleToClear, string manifestBundl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e47c8d9f9051
unity_docs
scripting
What is `Experimental.GraphView.GraphElement.IsMovable` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphElement.IsMovable Declaration public bool IsMovable (); Returns bool Returns true if the GraphElement is movable. Returns false otherwise. Description The GraphElement is movable.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cccda9e1fa7e
unity_docs
scripting
What is `QualitySettings.terrainBasemapDistance` in Unity? Explain its purpose and usage.
QualitySettings.terrainBasemapDistance public static float terrainBasemapDistance ; Description Value set to Terrain.basemapDistance if TerrainQualityOverrides.BasemapDistance is set in terrainQualityOverrides .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d93f0207c56
unity_docs
math
What is `Search.QueryEngine_1.SetDefaultParamFilter` in Unity? Explain its purpose and usage.
QueryEngine<T0>.SetDefaultParamFilter Declaration public void SetDefaultParamFilter (Func<TData,string,string,string,string,bool> handler ); Parameters Parameter Description handler Callback used to handle the function filter. Takes an object of type TData, the filter identifier, the parameter, the operator,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aa9d33c2c696
unity_docs
ui
Explain 'Test UI' in Unity.
You can test your UI inside the UI Builder, and use debugging tools to investigate styles. ## Test UI in Preview mode To test your UI inside the UI Builder, directly inside the Canvas , you can enable Preview mode, found in the Viewport ’s toolbar . Preview mode removes the UI Builder-specific picking overlay and han...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1ed642f57a7
unity_docs
animation
What is `AnimationWindow.recording` in Unity? Explain its purpose and usage.
AnimationWindow.recording public bool recording ; Description This property toggles recording in the Animation window. Recording allows the Animation window to update the animation clip with modifications to the Game Object in the Scene View. Enabling this also enables AnimationWindow.previewing .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7af2ba47a999
unity_docs
editor
What is `AI.NavMeshBuildDebugFlags.PolygonMeshes` in Unity? Explain its purpose and usage.
NavMeshBuildDebugFlags.PolygonMeshes Description Meshes of convex polygons constructed within the unified contours of adjacent regions. Additional resources: NavMeshBuildSettings.debug , NavMeshEditorHelpers.DrawBuildDebug .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_21ee21324c50
unity_docs
performance
Explain 'Adding profiling information to your code' in Unity.
You can add profiler markers and counters to your code to further understand specific performance data related to your application, and visualize that data in custom Profiler modules. Topic Description Adding profiling information to your code introduction Use profiler markers and counters to collect specific data abou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa94e454a363
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGB_PVRTC_2Bpp_UNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGB_PVRTC_2Bpp_UNorm Description A three-component, PVRTC compressed format where each 64-bit compressed texel block encodes a 8×4 rectangle of unsigned normalized RGB texel data. This format has no alpha and is co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c733dbe1df51
unity_docs
ui
Explain 'Introduction to visual elements and the visual tree' in Unity.
The most basic building block in UI Toolkit is a visual element . The visual elements are ordered into a hierarchy tree with parent-child relationships. This is called the visual tree . The diagram below displays a simplified example of the visual tree, and the rendered result in UI Toolkit. The Root in the diagram rep...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d5e0c7deffd5
unity_docs
rendering
Explain 'Real-time shadows' in Unity.
Techniques and resources for shadows that use shadow maps and shadow cascades to update shadows when lights move at runtime. Page Description Shadow mapping Understand how Light components generate depth textures that Unity samples to generate real-time shadows. Set shadow distance in a scene Use the Shadow Distance pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_15fa94366d2d
unity_docs
networking
Show me a Unity code example for 'Web networking'.
ing it to must authorize the Unity content. To access cross-domain web resources in Web, the server you are trying to access needs to use cross-origin resource sharing (CORS) to authorize cross-domain web resources. If you try to access content using UnityWebRequest, and the remote server doesn’t have CORS set up or co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e844d4c6bd1a
unity_docs
editor
In Unity's 'Customize your workspace layout', what is 'Manage tabs' and how does it work?
Any window you add from the main menu opens as a new tab. You can also right-click a tab’s name to: Maximise the tab. Close the tab. Add tabs. Manage overlays. For more information, refer to Overlays .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c53710c0144
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R_BC4_SNorm` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R_BC4_SNorm Description A one-component, block-compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of signed normalized red texel data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72b5f80245a9
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.IsHDRFormat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.IsHDRFormat Declaration public static bool IsHDRFormat ( Experimental.Rendering.GraphicsFormat format ); Declaration public static bool IsHDRFormat ( TextureFormat format ); Description Returns t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3636f40d7621
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.LightsModule.ratio`.
ParticleSystem.LightsModule.ratio public float ratio ; Description Choose what proportion of particles receive a dynamic light. Use a value between 0 and 1, where 0 attaches Lights to no particles, and 1 attaches Lights to every particle. ```csharp using UnityEngine; using System.Collections;// For best resul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9f4917548802_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Destroys the child GameObject and creates a new child GameObject, by loading from resources and instantiating.TComponent will be initialized with the given arguments.The child Component to destroy.The path to the resourced asset.The TArgs object to be passed in on initialization.Will the instantiated GameObject stay in...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_426b2e852695
unity_docs
rendering
What is `AssetDatabase.GUIDToAssetPath` in Unity? Explain its purpose and usage.
AssetDatabase.GUIDToAssetPath Declaration public static string GUIDToAssetPath (string guid ); Declaration public static string GUIDToAssetPath (GUID guid ); Parameters Parameter Description guid The GUID of an asset. Returns string Path of the asset relative to the project folder. Description G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77b94b6f9194
unity_docs
scripting
What is `KeyCode.D` in Unity? Explain its purpose and usage.
KeyCode.D Description 'd' key. ```csharp //Attach this to a GameObject //This script tells when the D arrow key is pressed down and when it is released using UnityEngine;public class Example : MonoBehaviour { void Update() { //Detect when the D arrow key is pressed down if (Input.GetKeyDown(KeyCode.D)) Debug.L...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_102871f9c2c2
unity_docs
scripting
What is `Experimental.GraphView.Group.CollectElements` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Group.CollectElements Declaration public void CollectElements (HashSet<GraphElement> collectedElementSet , Func<GraphElement,bool> conditionFunc ); Parameters Parameter Description collectedElementSet The set of matching...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e38dd6b1604a
unity_docs
editor
What is `Device.SystemInfo.systemMemorySize` in Unity? Explain its purpose and usage.
SystemInfo.systemMemorySize public static int systemMemorySize ; Description This has the same functionality as SystemInfo.systemMemorySize 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.
gh_35f8fb3212ea_doc_7
github
scripting
What does `DoStateTransition` do in this Unity script? Explain its purpose and signature.
Apply color transitions to both primary and secondary graphics based on button state.This extends Unity's default behavior to support multiple graphics changing color together. Signature: ```csharp protected override void DoStateTransition(SelectionState state, bool instant) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_ab5bb4ea3f77
unity_docs
scripting
What is `CharacterController.radius` in Unity? Explain its purpose and usage.
CharacterController.radius public float radius ; Description The radius of the character's capsule. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Set the controller radius to 0.3f CharacterController controller; void Start() { controller = GetComponent<CharacterController>(); contr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_907b60360bd7
unity_docs
rendering
What is `XR.XRDisplaySubsystem.contentProtectionEnabled` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.contentProtectionEnabled public bool contentProtectionEnabled ; Description Sets or gets the state of content protection for the current active provider. For most providers, content protection allows you to use write only textures for rendering. This stops the ability for apps to read texture...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d585d54188c4_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A class for retrieving data from the Asset Store backend Note: most data retrieval methods require to be set Signature: ```csharp internal static class AssetStoreAPI ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_6ad22dbdfd4a
unity_docs
editor
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.Release` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.Release Declaration public static void Release ( Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle ); Parameters Parameter Description handle The AtomicSafetyHandle to release. Description Releases a previously created AtomicSafetyHandle. After this call, this AtomicSafetyHan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee1b80eb57a1
unity_docs
rendering
What is `Playables.PlayableBehaviour.OnBehaviourPause` in Unity? Explain its purpose and usage.
PlayableBehaviour.OnBehaviourPause Declaration public void OnBehaviourPause ( Playables.Playable playable , Playables.FrameData info ); Parameters Parameter Description playable The Playable that owns the current PlayableBehaviour. info A FrameData structure that contains information about the curr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c2dd00a56ed
unity_docs
rendering
What is `PlayerSettings.SetOverrideShaderChunkSettingsForPlatform` in Unity? Explain its purpose and usage.
PlayerSettings.SetOverrideShaderChunkSettingsForPlatform Declaration public static void SetOverrideShaderChunkSettingsForPlatform ( BuildTarget buildTarget , bool value ); Parameters Parameter Description buildTarget The build target to set the override for. value Set the value to true if you want set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_799c2146c292
unity_docs
scripting
What are the parameters of `Sprite.OverrideGeometry` in Unity?
Description Sets up new Sprite geometry. Vertex positions are in Sprite.rect space meaning from Rect.zero to Rect.size . Pivot offset and transformation to unit space is done automatically. The size of the triangle array must always be a multiple of 3. The vertices connected to the triangle can be shared by simply ind...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa309faae8fc
unity_docs
scripting
What is `GUILayoutUtility.GetRect` in Unity? Explain its purpose and usage.
GUILayoutUtility.GetRect Declaration public static Rect GetRect ( GUIContent content , GUIStyle style ); Declaration public static Rect GetRect ( GUIContent content , GUIStyle style , params GUILayoutOption[] options ); Parameters Parameter Description content The content to make room for d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b222506049a
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.AddShellScriptBuildPhase`.
cies. Returns string Returns the GUID of the new phase. Description Creates a new copy shell script phase for a given target. If a shell script build phase with the same name, shellPath , shellScript , and inputPaths is already configured for the target, the function returns the existing phase. The new pha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a033ef58e48c
unity_docs
scripting
Show me a Unity C# example demonstrating `AssetImporters.ScriptedImporter`.
roperties in the Inspector and use them to control the behaviour of the importer for each asset. To programmatically access the value of an asset's properties, use AssetImporter.GetAtPath and type cast the return value to the correct class derived from ScriptedImporter. After changing values, trigger a fresh import b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af81e20f288b
unity_docs
math
What are the parameters of `Graphics.RenderPrimitives` in Unity?
Description Renders non-indexed primitives with GPU instancing and a custom shader. Renders a given number of instances and primitives that have specific topology. This method requires custom shaders to fetch or calculate vertex data using the SV_VertexID semantic. To access instance ID use SV_InstanceID semantic. Addi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35d2a88ec0b2
unity_docs
input
What is `UIElements.PointerOutEvent` in Unity? Explain its purpose and usage.
PointerOutEvent class in UnityEngine.UIElements / Inherits from: UIElements.PointerEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description This event is sent when a pointer exits an element. The event trickles down and bubbles up. Inherited Members Properties Property Description bubbles ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aedabd05ee46
unity_docs
scripting
What is `Playables.FrameData.effectivePlayState` in Unity? Explain its purpose and usage.
FrameData.effectivePlayState public Playables.PlayState effectivePlayState ; Description The accumulated play state of this playable. The effective play state is the accumulated play state of the playable and its ancestors. For example, a playable can be set to the Playing play state, but if its parent is Pau...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c41f5eaab4a2
unity_docs
rendering
In Unity's 'Create a skybox', what is 'Synchronizing light sources' and how does it work?
If your skybox contains a visible sun, moon, or other light source, align a Directional Light in your scene to match the light’s direction in the skybox. This creates the illusion that the light in the skybox is casting shadows. For scenes with multiple directional lights, specify the one to use: From the main menu, se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17394d9d3288
unity_docs
scripting
What is `WSA.Tile.UpdateBadgeNumber` in Unity? Explain its purpose and usage.
Tile.UpdateBadgeNumber Declaration public void UpdateBadgeNumber (float number ); Parameters Parameter Description number Number to be shown on a badge. Description Set or update a badge on a tile to a number. Number must be supported by the system, see: http://msdn.microsoft.com/en-us/library/windows/app...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6afda63ef63
unity_docs
ui
What is `UIElements.ToggleButtonGroupState` in Unity? Explain its purpose and usage.
ToggleButtonGroupState struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description The structure that keeps track of the Button states inside a ToggleButtonGroup . To set properties on how to serialize this type, use ToggleButtonGroupStatePropertiesAttribute . Properti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_395312426916
unity_docs
scripting
What is `SubsystemsImplementation.SubsystemWithProvider.Destroy` in Unity? Explain its purpose and usage.
SubsystemWithProvider.Destroy Declaration public void Destroy (); Description Destroys this instance of a subsystem. Also unloads all resources acquired during the initialization step. Call this when you no longer need this instance of a subsystem. Note: Once a subsystem is Destroyed, script can still hold a ref...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_733604282afe
unity_docs
scripting
What is `Unity.Properties.ISetPropertyVisitor` in Unity? Explain its purpose and usage.
ISetPropertyVisitor interface in Unity.Properties Description Interface for receiving strongly typed property callbacks for sets. Public Methods Method Description Visit Implement this method to accept visitation for a specialized set property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebdd79d48ce5
unity_docs
scripting
What is `GizmoUtility.SetIconEnabled` in Unity? Explain its purpose and usage.
GizmoUtility.SetIconEnabled Declaration public static void SetIconEnabled (Type type , bool enabled ); Parameters Parameter Description type The component type to render or hide icons. enabled Set true to render icons for this component type in the Scene View, false to hide. Description Enable or disabl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee1669c6d027
unity_docs
editor
What is `EditorJsonUtility.ToJson` in Unity? Explain its purpose and usage.
EditorJsonUtility.ToJson Declaration public static string ToJson (object obj ); Declaration public static string ToJson (object obj , bool prettyPrint ); Parameters Parameter Description obj The object to convert to JSON form. prettyPrint If true, format the output for readability. If false, format t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20d30f50bdb8
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GetCounterValuePtr`.
GetCounterValuePtr Declaration public void* GetCounterValuePtr (int markerId ); Parameters Parameter Description markerId Marker identifier. Returns void* Returns unsafe pointer to the counter value. Description Gets unsafe pointer to the last value of a counter marker in the frame. Use to retrieve ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_96f5b28edb53
unity_docs
physics
In Unity's 'Hinge Joint component reference', what is 'Properties' and how does it work?
Property Description Edit Angular Limits Adds a visual gizmo to the Scene view that helps you edit joint angular limits. To use this gizmo, set the Angular X, Y, Z Motion to Limited and then handles appear for you to drag and adjust the joint’s rotational space. Connected Body Optional reference to the Rigidbody that t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ac964ee4ed5
unity_docs
rendering
What is `Rendering.ShaderCompilerData` in Unity? Explain its purpose and usage.
ShaderCompilerData struct in UnityEditor.Rendering Description Collection of data used for shader variants generation, including targeted platform data and the keyword set representing a specific shader variant. Properties Property Description buildTarget The build target to compile the shader variant for. (Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b0c8ed166414
unity_docs
scripting
Show me a Unity code example for 'Enter Play mode with domain reload disabled'.
of the event handler. With domain reload disabled, the counter value and the event handler registration are both preserved from the previous run. On the next run of Play mode, the counter begins with the value it had at the end of the previous run and the event handler method is called multiple times on one occurrence ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_320eb930a745
unity_docs
editor
What is `SearchService.AdvancedObjectSelectorAttribute` in Unity? Explain its purpose and usage.
AdvancedObjectSelectorAttribute class in UnityEditor.SearchService Description This attribute lets you register a custom advanced object selector. An advanced object selector is an object selector that can be customized programatically to be opened on specific object fields, without modifying the object fields th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_140b32fbfb95
unity_docs
scripting
Show me a Unity C# example demonstrating `Color.operator_subtract`.
Color.operator - public static Color operator - ( Color a , Color b ); Description Subtracts color b from color a . Each component is subtracted separately. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Color redColor = Color.magenta - Color.blue; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_829011f851e7
unity_docs
physics
What is `CircleCollider2D` in Unity? Explain its purpose and usage.
CircleCollider2D class in UnityEngine / Inherits from: Collider2D / Implemented in: UnityEngine.Physics2DModule Description Collider for 2D physics representing an circle. Additional resources: BoxCollider class, PolygonCollider2D class. Properties Property Description radius Radius of the circle. In...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6fa0c699366
unity_docs
performance
What is `Unity.Collections.NativeArray_1.AsReadOnlySpan` in Unity? Explain its purpose and usage.
NativeArray<T0>.AsReadOnlySpan Declaration public ReadOnlySpan<T> AsReadOnlySpan (); Returns ReadOnlySpan<T> A System.ReadOnlySpan<T> . Description Exposes NativeArray<T0> data as a System.ReadOnlySpan<T> .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b3b96610c06
unity_docs
physics
What is `EditorGUI.Popup` in Unity? Explain its purpose and usage.
EditorGUI.Popup Declaration public static int Popup ( Rect position , int selectedIndex , string[] displayedOptions , GUIStyle style = EditorStyles.popup); Declaration public static int Popup ( Rect position , int selectedIndex , GUIContent[] displayedOptions , GUIStyle style = EditorStyles.popup...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79e4a09bc39b
unity_docs
editor
Give me an overview of the `VideoCodec` class in Unity.
VideoCodec enumeration Description Choose the video codec to use to import video clips. Use this enum to set VideoImporterTargetSettings.codec . A video codec compresses (encodes) or decompresses (decodes) video data to reduce the file size but avoid reduction of quality as much as possible. For Unity to conside...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b80ddd7501fc
unity_docs
rendering
Show me a Unity code example for 'Reflection Surface Shader examples in the Built-In Render Pipeline'.
Here’s a Shader that does cubemapped reflection using built-in worldRefl input. It’s very similar to built-in Reflective/Diffuse Shader: ```csharp Shader "Example/WorldRefl" { Properties { _MainTex ("Texture", 2D) = "white" {} _Cube ("Cubemap", CUBE) = "" {} } SubShader { Tags { "RenderType" = "Opaque" } CGPROGR...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f77cff17a91
unity_docs
rendering
What is `Rendering.ShaderKeywordType` in Unity? Explain its purpose and usage.
ShaderKeywordType enumeration Description Type of a shader keyword, eg: built-in or user defined. Additional resources: ShaderKeyword . Properties Property Description None No type is assigned. BuiltinDefault The keyword is built-in the runtime and it is systematically reserved. UserDefined The keyword is d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_da0ef05a44fc
unity_docs
rendering
Explain 'Declare shader keywords' in Unity.
To declare shader keywords, use a #pragma directive in the HLSL code. For example: ``` #pragma shader_feature REFLECTION_TYPE1 REFLECTION_TYPE2 REFLECTION_TYPE3 ``` Use one of the following shader directives: dynamic_branch to keep branching code in one compiled shader program. multi_compile or shader_feature to compil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8dbba503900b
unity_docs
scripting
Give me an overview of the `LightingDataAsset` class in Unity.
LightingDataAsset class in UnityEditor / Inherits from: Object Description The lighting data asset used by the active Scene. Please note that modifying this value currently does not affect the Scene immediately, the lighting data is only patched into the active Scene when loading the Scene. Constructors Const...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fe3acec76e4
unity_docs
xr
What is `XR.MeshVertexAttributes.Normals` in Unity? Explain its purpose and usage.
MeshVertexAttributes.Normals Description Vertex normals Used by XRMeshSubsystem.GenerateMeshAsync to request that normals get generated, or by MeshGenerationResult to indicate normals were written to the Mesh .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60180c378eed
unity_docs
math
What is `ComputeShader.SetVector` in Unity? Explain its purpose and usage.
ComputeShader.SetVector Declaration public void SetVector (string name , Vector4 val ); Declaration public void SetVector (int nameID , Vector4 val ); Parameters Parameter Description name Variable name in shader code. nameID Property name ID, use Shader.PropertyToID to get it. val Value to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6b2ed71462e
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.SearchService.OrderedProviders`.
SearchService.OrderedProviders public static IEnumerable<SearchProvider> OrderedProviders ; Description Returns the list of search providers sorted by priority. ``` // Print providers by their search priority when a query is executed. foreach (var provider in SearchService.OrderedProviders) Debug.Log($"[{provi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be1e9bfcabc2
unity_docs
editor
What is `IMGUI.Controls.PrimitiveBoundsHandle.DrawHandle` in Unity? Explain its purpose and usage.
PrimitiveBoundsHandle.DrawHandle Declaration public void DrawHandle (); Description A function to display this instance in the current handle camera using its current configuration. Always write properties to the handle before calling this function. Place the calls to this function inside EditorGUI.BeginChange...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2eae4a64eca1
github
scripting
Write a Unity C# script called Sprite Switcher
```csharp using System.Collections.Generic; using UnityEngine; using UnityEngine.UI; namespace UIStateSwitcher { public class SpriteSwitcher : SwitchableElement { [SerializeField] private Image targetImage; [SerializeField] private List<SwitchableSprite> switchableSprites; ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_0d07c33d1973
unity_docs
scripting
Show me a Unity C# example demonstrating `Application.version`.
on.version public static string version ; Description Returns application version number (Read Only). This function returns the current version of the application. This is read-only. To set the version number in Unity, go to Edit > Project Settings > Player . Unity uses PlayerSettings.bundleVersion on all pl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e18ec3d6ef9
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetDatabase.GUIDToAssetPath`.
static string GUIDToAssetPath (GUID guid ); Parameters Parameter Description guid The GUID of an asset. Returns string Path of the asset relative to the project folder. Description Gets the corresponding asset path for the supplied GUID, or an empty string if the GUID can't be found. Returned paths ar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4ba18c1417c
unity_docs
scripting
What is `TerrainData.ComputeDetailCoverage` in Unity? Explain its purpose and usage.
TerrainData.ComputeDetailCoverage Declaration public float ComputeDetailCoverage (int detailPrototypeIndex ); Description This function computes and returns the coverage (how many instances fit in a square unit) of a detail prototype, given its index. Computes detail coverage. In CoverageMode , this coverage ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b2580f075f3
unity_docs
ui
Show me a Unity C# example demonstrating `GUI.FocusWindow`.
GUI.FocusWindow Declaration public static void FocusWindow (int windowID ); Parameters Parameter Description windowID The identifier used when you created the window in the Window call. Description Make a window become the active window. Additional resources: GUI.UnfocusWindow . ```csharp // Draw 2 wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31d5958316d9
unity_docs
rendering
What is `Experimental.GlobalIllumination.LinearColor.Convert` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LinearColor.Convert Declaration public static Experimental.GlobalIllumination.LinearColor Convert ( Color color , float intensity ); Parameters Parameter Description color Light color. intensity Light intensity. Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbcdf9504230
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.AddFrameworkToProject`.
must be .framework . weak True if the framework is optional, for example if it's weakly linked, and false if the framework is required. Description Adds a system framework dependency for the specified target. The function assumes system frameworks are located in the System/Library/Frameworks folder in the SDK sou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93cb10ecc85f
unity_docs
rendering
What is `Rendering.CameraProperties.GetShadowCullingPlane` in Unity? Explain its purpose and usage.
CameraProperties.GetShadowCullingPlane Declaration public Plane GetShadowCullingPlane (int index ); Parameters Parameter Description index Plane index (up to 5). Returns Plane Shadow culling plane. Description Get a shadow culling plane. Additional resources: SetShadowCullingPlane .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b52429bf3c24
github
scripting
Write a Unity C# MonoBehaviour script called Enqueue Sample
```csharp using System; using System.Threading; using UnityEngine; namespace UnityMainThreadDispatcher.Sample { public class EnqueueSample : MonoBehaviour { private bool _quitting; private Thread _thread; private void Start() { _thread = new Thread(RunsInAnother...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_aeacdf613739
unity_docs
rendering
What is `CustomRenderTextureUpdateZone` in Unity? Explain its purpose and usage.
CustomRenderTextureUpdateZone struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Structure describing an Update Zone. UpdateZones are used when updating the full custom render texture is not required. They are defined by a position, a size and a rotation inside the surface of the texture...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_50b03e0c1e7c
unity_docs
scripting
Explain 'BindableElement' in Unity.
BindableElement is the base class for all elements that you can bind to a data source. It provides the following properties: bindingPath : The path to the data source property to bind to. binding : The binding object that represents the binding between the element and the data source. ## Create a BindableElement You ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69e40a93ba77
unity_docs
editor
What is `AssetModificationProcessor.FileModeChanged` in Unity? Explain its purpose and usage.
AssetModificationProcessor.FileModeChanged(string[],FileMode) Description Unity calls this method when file mode has been changed for one or more files. Array of strings specifies changed files. FileMode specifies new file mode. This method must be static if implemented. ```csharp using UnityEngine; using UnityE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3f54aaa53211
unity_docs
editor
In Unity's 'Build a macOS application', what is 'Build the application' and how does it work?
To build your Unity application, use the following steps: Open the Build Profiles window (menu: File > Build Profiles ). From the list of platforms in the Platforms panel, select macOS or create a build profile for the macOS platform. In the Platform Settings section, set Architecture to the architecture type you want ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_03343dd56c4f
unity_docs
rendering
Explain 'Sprite (2D and UI) texture Import Settings window reference' in Unity.
Set the import settings for the texture asset when you set its Texture Type to Sprite (2D and UI) . The Sprite (2D and UI) texture type formats the texture asset so that it can be used in 2D features as a Sprite . Unity automatically locks Texture Shape to 2D for this texture type. Property Description Sprite Mode Spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2f171e10c28
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchExpressionEvaluatorAttribute.ctor`.
ified the name of the evaluator functio will be used. hints Hints to specify to the evaluator runtime how function should be run. Description Use this attribute to register a static C# function as a new evaluator. SearchExpressionEvaluator when use within a SearchExpression can have a signature that is validated ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b76b678bd03f
unity_docs
math
What is `Rendering.MeshUpdateFlags.DontValidateIndices` in Unity? Explain its purpose and usage.
MeshUpdateFlags.DontValidateIndices Description Indicates that Unity should not check index values when you use Mesh.SetIndexBufferData to modify a Mesh's data. When you use Mesh.SetIndexBufferData to modify a Mesh's data, Unity's default behaviour is to validate the indices array that you supplied, to check fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_807dd03cfce8
unity_docs
audio
What is `AudioSource.PlayOnGamepad` in Unity? Explain its purpose and usage.
AudioSource.PlayOnGamepad Declaration public bool PlayOnGamepad (int slot ); Parameters Parameter Description slot Slot number of the gamepad (0-3). Returns bool Returns TRUE if enabling audio output through this users controller was successful. Description Enable the audio source to play through a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_647189eed451
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.CollisionModule.type`.
ParticleSystem.CollisionModule.type public ParticleSystemCollisionType type ; Description The type of particle collision to perform. Here is an example of plane collsiion: ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBehavio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2b2e749622f
unity_docs
math
What is `SerializedProperty.vector2IntValue` in Unity? Explain its purpose and usage.
SerializedProperty.vector2IntValue public Vector2Int vector2IntValue ; Description Value of a 2D integer vector property. Additional resources: propertyType , SerializedPropertyType.Vector2Int , Vector2Int .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a00d7c42a5cf
unity_docs
scripting
Show me a Unity C# example demonstrating `MonoBehaviour.OnTriggerEnter`.
llider component. At least one of the colliders must be a trigger collider and at least one must be a physics body collider. For more information, refer to OnTrigger events . Both the trigger and the collider that touches the trigger receive OnTriggerEnter if they have implemented it. Trigger events are sent to dis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74f556d23889
unity_docs
editor
Show me a Unity C# example demonstrating `TypeCache`.
bute, or for classes that extend or implement a specific type, when building or extending the Unity Editor. Iterating types in the current domain is usually a slow operation that scales linearly based on the number of types. To speed up type extraction, the Editor builds an acceleration table, on the native side, that ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_360fc1187e6f
unity_docs
math
Show me a Unity code example for 'Sample a cubemap array in a shader'.
Here is an example of a shader that uses a cubemap array. ``` Shader "CubemapArrayShaderExample" { Properties { _MainTex ("CubemapArray", CubeArray) = "" {} _Mip ("Mip", Float) = 0.0 _Intensity ("Intensity", Float) = 1.0 _SliceIndex ("Slice", Int) = 0 _Exposure ("Exposure", Float) = 0.0 } SubShader { Tags {"Queu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9946a36f59e0
unity_docs
ui
What is `UIElements.RepeatButton.ctor` in Unity? Explain its purpose and usage.
RepeatButton.RepeatButton Constructor Declaration public RepeatButton (); Description Constructor. Parameters Parameter Description clickEvent The action to execute when the button is pressed. delay The initial delay before the action is executed for the first time. Value is defined in milliseconds. i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3e7eaf2d36c
unity_docs
math
What is `Embree.GpuBvhBuildOptions.minLeafSize` in Unity? Explain its purpose and usage.
GpuBvhBuildOptions.minLeafSize public uint minLeafSize ; Description The minimum number of primitives allowed in a leaf node. Increase this value to decrease the BVH's memory footprint at the expense of ray tracing performance. Default value: 1.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ad3a49e549c9
unity_docs
rendering
What are the parameters of `Random.ColorHSV` in Unity?
Returns Color A random color with HSV and alpha values in the (inclusive) input ranges. Values for each component are derived via linear interpolation of value . Description Generates a random color from HSV and alpha ranges. ```csharp using UnityEngine;public class ColorOnClick : MonoBehaviour { void OnMouseDown()...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4d29b79b237
unity_docs
ui
What is `AssetImporters.AssetImporterEditor.ApplyRevertGUI` in Unity? Explain its purpose and usage.
AssetImporterEditor.ApplyRevertGUI Declaration protected void ApplyRevertGUI (); Description Add's the 'Apply' and 'Revert' buttons to the editor. To be called from the OnInstpectorGUI event handler method as this is where the Apply/Revert buttons are placed on editor. This method may not be overridden but cust...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_86c6c0018ce5
unity_docs
editor
In Unity's 'scriptmultiplescenes', what is 'Use scripts within the Editor' and how does it work?
When using (or running) scripts within the Editor, use: Scene struct: Available both in the Editor and at runtime, Scene struct contains read-only properties that relate to the scene itself, such as name and asset path. EditorSceneManager API: This class is only available only in the Editor and has several functions to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_103347a59c12_doc_7
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Stores the used to select the source to define the forward direction of continuous movement. Signature: ```csharp public Dropdown forwardSourceDropdown ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7265b08e2640
unity_docs
editor
What are the parameters of `VersionControl.Provider.ChangeSetDescription` in Unity?
Description Given a changeset only containing the changeset ID, this will start a task for quering the description of the changeset. The resulting description can be retrieved using the task's "text" property. ```csharp using System.Collections.Generic; using UnityEditor; using UnityEditor.VersionControl; using UnityEn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_582a424f1036
unity_docs
editor
What is `Handles.DrawTexture3DSDF` in Unity? Explain its purpose and usage.
Handles.DrawTexture3DSDF Declaration public static void DrawTexture3DSDF ( Texture texture , float stepScale = 1.0f, float surfaceOffset = 0.0f, Gradient customColorRamp = null); Parameters Parameter Description texture The volumetric texture to draw. stepScale The number by which to multiply the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ff2f3101f1bf
unity_docs
rendering
What is `Shader.SetGlobalFloatArray` in Unity? Explain its purpose and usage.
Shader.SetGlobalFloatArray Declaration public static void SetGlobalFloatArray (string name , float[] values ); Declaration public static void SetGlobalFloatArray (int nameID , float[] values ); Declaration public static void SetGlobalFloatArray (string name , List<float> values ); Declaration publi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1b0c5a1e1ddc
unity_docs
scripting
In Unity's 'Unity programming best practices', what is 'Garbage collector overhead and allocations' and how does it work?
One of the most important performance risks to be mindful of in Unity applications is runtime code that allocates memory and increases garbage collector overhead, especially in hot paths. To avoid this, apply the following coding practices: Avoid per-frame allocations by caching and reusing lists and using non-allocati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a0d05e66ea8a
unity_docs
rendering
Explain '2D renderer sorting' in Unity.
Unity sorts Renderers according to a priority order that depends on their types and usages. You can specify the render order of Renderers through their Render Queue . In general, there are two main queues: the Opaque queue and the Transparent queue . 2D Renderers are mainly within the Transparent queue, and include the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d586177c5cfa
unity_docs
math
What is `Rendering.ResourceFormattedPathsAttribute.ctor` in Unity? Explain its purpose and usage.
ResourceFormattedPathsAttribute Constructor Declaration public ResourceFormattedPathsAttribute (string pathFormat , int rangeMin , int rangeMax , Rendering.SearchType location ); Parameters Parameter Description pathFormat The format used for the path with a varying index. rangeMin The varying index s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4fca52b9f267
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchFlags`.
SearchFlags enumeration Description Search options used to fetch items. Mostly with SearchContext to specify how a search should be handled. ```csharp using System.Collections; using System.Collections.Generic; using UnityEditor; using UnityEditor.Search; using UnityEngine; public class SearchFlags_NoIndexing {...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_686807b1ceac
unity_docs
physics
What is `Physics2D.OverlapCapsuleAll` in Unity? Explain its purpose and usage.
Physics2D.OverlapCapsuleAll Declaration public static Collider2D[] OverlapCapsuleAll ( Vector2 point , Vector2 size , CapsuleDirection2D direction , float angle , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9c0f2fb259a
unity_docs
scripting
What is `WaitForSecondsRealtime` in Unity? Explain its purpose and usage.
WaitForSecondsRealtime class in UnityEngine / Inherits from: CustomYieldInstruction / Implemented in: UnityEngine.CoreModule Description Suspends the coroutine execution for the specified real (unscaled) time in seconds. WaitForSecondsRealtime can only be used with a yield statement in coroutines. To wai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf107e9ca194
unity_docs
rendering
What is `CullingGroup.targetCamera` in Unity? Explain its purpose and usage.
CullingGroup.targetCamera public Camera targetCamera ; Description Locks the CullingGroup to a specific camera. If targetCamera is assigned then the bounding spheres will only be culled from the perspective of that camera.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ffde982cac28
unity_docs
xr
Show me a Unity code example for 'AssetBundle platform considerations'.
f your project. ## Build AssetBundles into the StreamingAssets folder AssetBundles placed in the StreamingAssets folder are automatically packaged as part of your application’s APK or OBB file. You can’t load these files directly from the APK or OBB file with the standard file path APIs. Instead, you must load them w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.