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_man_b23b3f26540a
unity_docs
rendering
In Unity's 'Standard Particle Shaders Material Inspector window reference for the Built-In Render Pipeline', what is 'Main Options' and how does it work?
Property Function Flip-Book Mode Render flip-books as individual frames or blend the frames together to give smoother animations. Set to either: Simple - Render frames in a flip-book as a sequence of individual frames. Blended - Blend the frames in a flip-book to render the flip-book as a smooth animation. Two Sided Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7cfb44413390
unity_docs
math
What is `UIElements.MeshGenerationContext.AddMeshGenerationJob` in Unity? Explain its purpose and usage.
MeshGenerationContext.AddMeshGenerationJob Declaration public void AddMeshGenerationJob ( Unity.Jobs.JobHandle jobHandle ); Parameters Parameter Description jobHandle JobHandle to wait for. Description Instructs the renderer to wait for the completion of the provided JobHandle before beginning processing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebd4ffdb3240
unity_docs
rendering
What is `TerrainData.GetAlphamapTexture` in Unity? Explain its purpose and usage.
TerrainData.GetAlphamapTexture Declaration public Texture2D GetAlphamapTexture (int index ); Parameters Parameter Description index Index of the alphamap. Returns Texture2D Alphamap texture at the specified index. Description Returns the alphamap texture at the specified index.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9bc12a16d00f
unity_docs
rendering
What is `Rendering.SphericalHarmonicsL2.AddDirectionalLight` in Unity? Explain its purpose and usage.
SphericalHarmonicsL2.AddDirectionalLight Declaration public void AddDirectionalLight ( Vector3 direction , Color color , float intensity ); Parameters Parameter Description direction The direction from the light probe to the light. The vector should be normalized for correct results. color The color o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba81c8d00c01
unity_docs
rendering
What is `LightProbeProxyVolume.gridResolutionZ` in Unity? Explain its purpose and usage.
LightProbeProxyVolume.gridResolutionZ public int gridResolutionZ ; Description The 3D grid resolution on the z-axis. This property is used only when the resolutionMode is set to Custom . The final resolution will be the closest power of 2.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5cc873530e2b
unity_docs
scripting
What is `UIElements.UxmlEnumAttributeDescription_1` in Unity? Explain its purpose and usage.
UxmlEnumAttributeDescription<T0> class in UnityEngine.UIElements / Inherits from: UIElements.TypedUxmlAttributeDescription_1 / Implemented in: UnityEngine.UIElementsModule Description Describes a UXML attribute representing an enum as a string . Properties Property Description defaultValueAsString ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd7bc6a7a052
unity_docs
scripting
What is `MeshPreview.ctor` in Unity? Explain its purpose and usage.
MeshPreview Constructor Declaration public MeshPreview ( Mesh target ); Parameters Parameter Description target The Mesh to be displayed. Description Creates a new MeshPreview instance with a Mesh target.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cf655575b05
unity_docs
scripting
Show me a Unity C# example demonstrating `KeyCode.DownArrow`.
KeyCode.DownArrow Description Down arrow key. Use this as a parameter to a function like Input.GetKey to detect when the user presses the down arrow key. Additional resources: Input.GetKey , Input.GetKeyDown , Input.GetKeyUp . ```csharp //Attach this to a GameObject //This script tells when the down arrow key...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4aafcd6c1683_doc_0
github
scripting
What does `SnapshotFlashAnimation` do in this Unity script? Explain its purpose and signature.
Animates a 'flash and fade' on the specified camera screen object, with the giventexture Signature: ```csharp public IEnumerator SnapshotFlashAnimation(int camera, Texture texture) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_cac0af51e3cc
unity_docs
scripting
Show me a Unity C# example demonstrating `PointerType.Pen`.
often mixed with pen events in the event stream, and you can't distinguish them by type because mouse and pen events share the same EventType . Instead, use PointerType to distinguish them. Otherwise, Unity processes all incoming mouse events as pen events, which can lead to unexpected behavior because the mouse eve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_da387798ca03
unity_docs
rendering
Explain 'UsePass directive in ShaderLab reference' in Unity.
For information on adding a name to a Pass in ShaderLab code, see ShaderLab: adding a name to a Pass . ## Render pipeline compatibility Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline UsePass Yes Yes Yes Yes ## Syntax Signature Function UsePass...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec6331412baf
unity_docs
rendering
What is `Rendering.ThreadedBatchContext.RemoveBatch` in Unity? Explain its purpose and usage.
ThreadedBatchContext.RemoveBatch Declaration public void RemoveBatch ( Rendering.BatchID batchID ); Parameters Parameter Description batchID Unity removes the batch with this ID. Description Thread-safe alias for BatchRendererGroup.RemoveBatch .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a87bdff16008
unity_docs
scripting
What is `BuildOptions.AcceptExternalModificationsToPlayer` in Unity? Explain its purpose and usage.
BuildOptions.AcceptExternalModificationsToPlayer Description Appends to an existing Xcode (iOS) project during the build process. This preserves any changes made to the existing Xcode project settings. With the IL2CPP scripting backend, this setting also allows incremental builds of the generated C++ code to work i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58a7d834ba40
unity_docs
scripting
Show me a Unity C# example demonstrating `RectTransform.sendChildDimensionsChange`.
RectTransform.sendChildDimensionsChange public bool sendChildDimensionsChange ; Description Whether the RectTransform notifies components when a child RectTransform changes dimensions. If true, this RectTransform calls MonoBehaviour.OnChildRectTransformDimensionsChange on all components attached to the same G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_95c71f24d65e_doc_3
github
scripting
What does `CreateNew` do in this Unity script? Explain its purpose and signature.
Helper method to call with unique key Signature: ```csharp public static ContextWithLocator CreateNew() ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_b9f2dc5508ce
unity_docs
scripting
What is `ContactFilter2D.SetLayerMask` in Unity? Explain its purpose and usage.
ContactFilter2D.SetLayerMask Declaration public void SetLayerMask ( LayerMask layerMask ); Parameters Parameter Description layerMask The value used to set the layerMask . Description Sets the layerMask filter property using the layerMask parameter provided and also enables layer mask filtering by se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20e94f3224c0
unity_docs
physics
What is `Rigidbody.solverIterations` in Unity? Explain its purpose and usage.
Rigidbody.solverIterations public int solverIterations ; Description The solverIterations determines how accurately Rigidbody joints and collision contacts are resolved. Overrides Physics.defaultSolverIterations . Must be positive. If you are having trouble with connected Rigidbodies oscillating and behaving ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9390680f1e65
unity_docs
editor
What is `EditorSnapSettings.snapEnabled` in Unity? Explain its purpose and usage.
EditorSnapSettings.snapEnabled public static bool snapEnabled ; Description Gets or sets whether snapping is enabled. Enable to quantize built-in Scene view Transform tools, such as Move, Rotate, Scale, Transform, and Rect, to rounded values when they are manipulated. The translate handle snaps to the nearest ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34e9c6511003
unity_docs
physics
What are the parameters of `PhysicsScene.CapsuleCast` in Unity?
Returns bool True when the capsule sweep intersects any collider, otherwise false. Description Casts a capsule against all colliders in this physics scene and returns detailed information on what was hit. Additional resources: Physics.CapsuleCast . Declaration public int CapsuleCast ( Vector3 point1 , Vector3 point2 , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ff351909681
unity_docs
editor
Show me a Unity C# example demonstrating `UIElements.DropdownMenu.ClearItems`.
DropdownMenu.ClearItems Declaration public void ClearItems (); Description Clears all items from the menu. ```csharp using UnityEditor; using UnityEngine; using UnityEngine.UIElements;public class ContextMenuWindow : EditorWindow { [MenuItem("My/Context Menu Window")] static void ShowMe() => GetWindow<Cont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fd55e1915f6f
unity_docs
rendering
Explain 'Wrapped diffuse Surface Shader example in the Built-In Render Pipeline' in Unity.
The following example shows Wrapped Diffuse , a modification of Diffuse lighting where illumination “wraps around” the edges of objects. It’s useful for simulating subsurface scattering effects. Only the CGPROGRAM section changes, so once again, the surrounding Shader code is omitted: ```csharp ...ShaderLab code... CG...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_746558da83b0
unity_docs
scripting
Show me a Unity code example for 'Native plug-ins'.
must declare the functions with C linkage to avoid name mangling issues. For platform-specific information on native plug-ins, refer to the relevant section under Platform development . ## Example A simple native library with a single function might have code that looks like this: float ExamplePluginFunction () { ret...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fecd76bd34d
unity_docs
scripting
What are the parameters of `ParticleSystem.ExternalForcesModule.GetInfluence` in Unity?
Returns ParticleSystemForceField The ForceField from the list. Description Gets the ParticleSystemForceField at the given index in the influencers list. When influenceFilter is set to ParticleSystemGameObjectFilter.List then only Force Fields in the influencers list affect the Particle System. ```csharp using UnityEngi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c5696d0f32c8
unity_docs
audio
Explain 'Audio Parametric Equalizer Effect' in Unity.
The Audio Param EQ Effect is used to alter the frequency response of an audio system using linear filters. ## Properties Property: Function: Center freq The frequency in Hertz where the gain is applied (range 20.0 to 22000.0, default = 8000.0 Hz). Octave Range The number of Octaves over which the gain is applied (Cen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc7ad49265d8
unity_docs
scripting
What is `Unity.Android.Gradle.SigningConfig` in Unity? Explain its purpose and usage.
SigningConfig class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the signingConfigs child elements in a gradle file. For more information about the file, see Android's documentation: SigningConfig Properties Property Description KeyAlias The C# ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ffdcb310cb2
unity_docs
audio
Show me a Unity C# example demonstrating `AudioHighPassFilter.cutoffFrequency`.
AudioHighPassFilter.cutoffFrequency public float cutoffFrequency ; Description Highpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioHighPassFilter))] public class Example : MonoBehaviour { // Moves...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3e117861ec0
unity_docs
rendering
What is `IHVImageFormatImporter.mipmapLimitGroupName` in Unity? Explain its purpose and usage.
IHVImageFormatImporter.mipmapLimitGroupName public string mipmapLimitGroupName ; Description Name of the texture mipmap limit group to which this texture belongs. For additional information, see Texture2D.mipmapLimitGroup .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fe1a4b26ba1b
unity_docs
rendering
In Unity's 'Importing a model', what is 'Rig and animation settings' and how does it work?
If your file contains animation data, you can set up the rig with the Rig tab and then extract or define Animation Clips with the Animation tab . The workflow differs between humanoid and generic animation types because Unity needs the humanoid’s bone structure to be specific, but only needs to know which bone is the r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a216857dbdbb
unity_docs
editor
What is `Tilemaps.Tilemap.GetEditorPreviewSprite` in Unity? Explain its purpose and usage.
Tilemap.GetEditorPreviewSprite Declaration public Sprite GetEditorPreviewSprite ( Vector3Int position ); Parameters Parameter Description position Position of the editor preview Tile on the Tilemap . Returns Sprite Sprite at the XYZ coordinate. Description Gets the Sprite used in an editor prev...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d8a1f8dd699
unity_docs
physics
What is `EffectorSelection2D` in Unity? Explain its purpose and usage.
EffectorSelection2D enumeration Description Selects the source and/or target to be used by an Effector2D . Properties Property Description Rigidbody The source/target is defined by the Rigidbody2D. Collider The source/target is defined by the Collider2D.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de3522fe65b7
unity_docs
rendering
Show me a Unity C# example demonstrating `Mesh.uv2`.
or Vector4 value if you need to. This property returns a copy of the data. This means that it causes a heap memory allocation. It also means that to make changes to the original data, you must update the copy and then reassign the updated copy to the mesh. The following example demonstrates how to create an array to ho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7bcff456b40f
unity_docs
math
What is `Search.QueryFilterOperator` in Unity? Explain its purpose and usage.
QueryFilterOperator struct in UnityEditor.Search Description A QueryFilterOperator defines a boolean operator between a value returned by a filter and an operand inputted in the search query. You get an object of this type whenever you add a new operator on a QueryEngine or IQueryEngineFilter . ```csharp usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bca74644388
unity_docs
scripting
What is `UIElements.StyleTranslate` in Unity? Explain its purpose and usage.
StyleTranslate struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IStyleValue<T0> Description Style value that can be either a Translate or a StyleKeyword . Properties Property Description keyword The style keyword. value The Translate value. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f3abe68e3e55
unity_docs
scripting
What is `Unity.Hierarchy.HierarchyNodeTypeHandlerBase.SearchMatch` in Unity? Explain its purpose and usage.
HierarchyNodeTypeHandlerBase.SearchMatch(HierarchyNode) Parameters Parameter Description node The hierarchy node. Returns void true if the node matches the search query, false otherwise. Description Determines if a node matches the search query.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4f7123e5d23
unity_docs
rendering
In Unity's 'Color over Lifetime module reference', what is 'Properties' and how does it work?
For some properties in this section, you can use different modes to set their value. For information on the modes you can use, refer to Vary Particle System properties over time . Property: Function: Color The color gradient of a particle over its lifetime. The very left-hand point of the gradient bar indicates the beg...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4427805634f1_doc_6
github
scripting
What does `FinishWriting` do in this Unity script? Explain its purpose and signature.
Finish writing and return the path to the recorded media file. Signature: ```csharp public Task<string> FinishWriting () ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_dcdd14023e93
unity_docs
rendering
What is `SkinWeights` in Unity? Explain its purpose and usage.
SkinWeights enumeration Description Skin weights. How many bones affect each vertex. This can be used when accessing the Bone Weight Buffer with Mesh.GetBoneWeightBuffer to determine what way the data will be ordered. Additional resources: QualitySettings.skinWeights , SkinnedMeshRenderer.quality , Mesh.GetBo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8e8ffd97af4d
unity_docs
scripting
Explain 'Use your native plug-in for iOS' in Unity.
Enable your iOS project to use your native plug-in . To use your native plug-in in an iOS project in Unity, you must ensure you configure your project appropriately: Topic Description Call native plug-ins for iOS Wrap native code in C# layer to only run code when using an iOS device. Callback from native code Understan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c2870112942
unity_docs
physics
What is `HumanPoseHandler.SetHumanPose` in Unity? Explain its purpose and usage.
HumanPoseHandler.SetHumanPose Declaration public void SetHumanPose (ref HumanPose humanPose ); Parameters Parameter Description humanPose The human pose to set. In the human pose, the bodyPosition and bodyRotation are the position and rotation of the approximate center of mass of the humanoid. This is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd85bca64ed4
unity_docs
scripting
What is `UIElements.StyleBackgroundRepeat.ctor` in Unity? Explain its purpose and usage.
StyleBackgroundRepeat Constructor Declaration public StyleBackgroundRepeat ( UIElements.BackgroundRepeat v ); Description Creates a new StyleBackgroundRepeat from either a BackgroundRepeat or a StyleKeyword . Declaration public StyleBackgroundRepeat ( UIElements.StyleKeyword keyword ); Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5197add060ce
unity_docs
physics
Explain 'Wind reference' in Unity.
Property Function Mode: Directional The Wind Zone affects the entire scene and blows in one direction. This is the default mode. Mode: Spherical The Wind Zone only has an effect inside the radius, and has a falloff from the center towards the edge. Radius Wind Zone size (active only if the mode is Spherical). Main The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64885104ff95
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture3D.GetPixels32`.
se it converts the format the texture uses into Color32 . To get pixel data more quickly, use GetPixelData instead. A single call to GetPixels32 is usually faster than multiple calls to GetPixel , especially for large textures. If GetPixels32 fails, Unity throws an exception. GetPixels32 might fail if the arr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fdc7abbc171d
unity_docs
rendering
What is `TerrainTools.TerrainPaintUtility.GetTerrainAlphaMapChecked` in Unity? Explain its purpose and usage.
TerrainPaintUtility.GetTerrainAlphaMapChecked Declaration public static Texture2D GetTerrainAlphaMapChecked ( Terrain terrain , int mapIndex ); Parameters Parameter Description terrain Terrain tile. mapIndex Index to retrieve. Returns Texture2D Alphamap texture at mapIndex. Description Returns ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5053a8aa9e49
unity_docs
scripting
What is `AndroidJNI.GetSByteField` in Unity? Explain its purpose and usage.
AndroidJNI.GetSByteField Declaration public static sbyte GetSByteField (IntPtr obj , IntPtr fieldID ); Description Returns the value of an instance (nonstatic) field of an object. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c73209bc813
unity_docs
physics
What is `RaycastHit.rigidbody` in Unity? Explain its purpose and usage.
RaycastHit.rigidbody public Rigidbody rigidbody ; Description The Rigidbody of the collider that was hit. If the collider is not attached to a rigidbody then it is null . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Apply a force to a clicked rigidbody object. // The force applied...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_65b75411a5d4
unity_docs
scripting
What is `EditorBuildSettings` in Unity? Explain its purpose and usage.
EditorBuildSettings class in UnityEditor / Inherits from: Object Description This class allows you to modify the Editor Build Settings via script. See EditorBuildSettings.scenes for an example of how to use this class. Additional resources: EditorBuildSettingsScene , EditorUserBuildSettings , BuildPlayer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4740ddd0a507
github
scripting
Write a Unity C# script called Free Look Cam
```csharp using System; using UnityEngine; using UnityStandardAssets.CrossPlatformInput; namespace UnityStandardAssets.Cameras { public class FreeLookCam : PivotBasedCameraRig { // This script is designed to be placed on the root object of a camera rig, // comprising 3 gameobjects, eac...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_ed1d4d1546d6
unity_docs
rendering
What is `RenderTexture.bindTextureMS` in Unity? Explain its purpose and usage.
RenderTexture.bindTextureMS public bool bindTextureMS ; Description If true and antiAliasing is greater than 1, the render texture will not be resolved by default. Use this if the render texture needs to be bound as a multisampled texture in a shader.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_033731689d93
unity_docs
networking
What is `Android.AndroidConfiguration.navigation` in Unity? Explain its purpose and usage.
AndroidConfiguration.navigation public Android.AndroidNavigation navigation ; Description Mirrors the Android property navigation . For information about this property, refer to the Android developer documentation on navigation .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_951e5953ec66
unity_docs
animation
What is `Animations.AnimatorStateMachine.RemoveState` in Unity? Explain its purpose and usage.
AnimatorStateMachine.RemoveState Declaration public void RemoveState ( Animations.AnimatorState state ); Parameters Parameter Description state The state to remove. Description Utility function to remove a state from the state machine. If the state is a sub asset of the state machine, it will be deleted....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f572e76965c1
unity_docs
scripting
Show me a Unity C# example demonstrating `Component.tag`.
them. Note: You should not set a tag from the Awake() or OnValidate() method. This is because the order in which components become awake is not deterministic, and therefore can result in unexpected behaviour such as the tag being overwritten when it is awoken. If you try this, Unity will generate a warning reading...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9af9dda4197e
unity_docs
rendering
What is `Rendering.RenderQueueRange.ctor` in Unity? Explain its purpose and usage.
RenderQueueRange Constructor Declaration public RenderQueueRange (int lowerBound , int upperBound ); Parameters Parameter Description lowerBound Inclusive lower bound for the range. upperBound Inclusive upper bound for the range. Description Create a render queue range struct. Additional resources: Scr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5b96ec760e07
github
scripting
Write a Unity C# ScriptableObject for Base Singleton
```csharp using System.Collections; using System.Collections.Generic; using System.Linq; using UnityEngine; using yaSingleton.Helpers; using yaSingleton.Utility; namespace yaSingleton { /// <summary> /// Base class for singletons. Contains method stubs and the Create method. Use this to create custom Singleto...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_3e94c1181097
unity_docs
scripting
What are the parameters of `ContextMenu.ctor` in Unity?
Description Adds the function to the context menu of the component. In the inspector of the attached script. When the user selects the context menu, the function will be executed. This is most useful for automatically setting up Scene data from the script. The function has to be non-static. ```csharp using UnityEngine;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c535edeb5e8b
unity_docs
audio
What is `AudioImporter.ClearSampleSettingOverride` in Unity? Explain its purpose and usage.
AudioImporter.ClearSampleSettingOverride Declaration public bool ClearSampleSettingOverride ( BuildTargetGroup platformGroup ); Declaration public bool ClearSampleSettingOverride (string platform ); Parameters Parameter Description platformGroup The platform for which to clear the overrides. See Build...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_87f528768f9c
unity_docs
scripting
Explain 'AssetBundle caching' in Unity.
Unity’s built-in disk-based caching system prevents redundant downloads by storing AssetBundles downloaded via UnityWebRequestAssetBundle . Unity converts AssetBundles in the cache to LZ4 for optimal performance. If Caching.compressionEnabled is false , AssetBundles are stored uncompressed. Use the Caching class to man...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49e98442cc2e
unity_docs
editor
What is `AssetDatabase.IsAssetImportWorkerProcess` in Unity? Explain its purpose and usage.
AssetDatabase.IsAssetImportWorkerProcess Declaration public static bool IsAssetImportWorkerProcess (); Returns bool true if running in an asset import worker process; false if running in the main Editor process. Description Determines whether the current process is an Asset Import Worker process. This m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18faa183d23a
unity_docs
physics
Give me an overview of the `PreprocessorOverride` class in Unity.
PreprocessorOverride enumeration Description This enum is now obsolete. Unity always uses the Caching Shader Preprocessor. Additional resources: The Caching Shader Preprocessor Properties Property Description UseProjectSettings This enum is now obsolete. Unity always uses the Caching Shader Preprocessor. For...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_04c916975fd1
unity_docs
rendering
Explain 'Model tab Import Settings reference' in Unity.
To open a model’s Import Settings, select the model from the Project window . The Inspector then displays the Import Settings for the selected model. You can also control these settings in your scripts with the ModelImporter class. This section provides information about each of the sections on the Model tab: (A) Scene...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b4c788a35880
unity_docs
rendering
Explain 'Cameras' in Unity.
Resources and approaches for using cameras to view and render a scene in Unity. Page Description Introduction to cameras Learn about how cameras work, and the difference between perspective and orthographic cameras. Control a camera in first person Navigate through the Scene view while you look through a camera. The ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_368ea0656e53
unity_docs
animation
Show me a Unity code example for 'Playables Examples'.
ng. Consult GitHub for more information on the PlayableGraph Visualizer. ## Play a single animation clip on a GameObject This example demonstrates a simple PlayableGraph with a single playable output that is linked to a single playable node. The playable node plays a single animation clip (clip). An AnimationClipPlay...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a0c5b4473b7
unity_docs
performance
What is `Unity.Profiling.ProfilerMarkerDataUnit` in Unity? Explain its purpose and usage.
ProfilerMarkerDataUnit enumeration Description Options for Profiler marker data unit types. Use unit types to define how Unity visualizes a particular value in the Profiler. A unit type represents dimensionality. For example, a unit type for time is represented as seconds, and a unit type for data size is represen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_da258b76d8a3
unity_docs
scripting
Explain 'Platform build path reference' in Unity.
When you build a Player from scripts , or using command-line arguments , you must specify the path for the build location. For certain platforms, this path must also include the build file extension specific to the platform. The following table lists the platforms that require you to include build file extensions: Plat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e7622b3f8355
unity_docs
math
What is `ArrayUtility.Contains` in Unity? Explain its purpose and usage.
ArrayUtility.Contains Declaration public static bool Contains (T[] array , T item ); Returns bool True if item is in array , false otherwise. Description Determines if the array contains the item.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b63d1f681b0
unity_docs
scripting
What are the parameters of `MenuItem.ctor` in Unity?
Description Creates a menu item and invokes the static function that follows it when the menu item is selected. MenuItem is an attribute that precedes a script function. This makes the function appear in the Unity menu system. The menu location is specified by the itemName argument. isValidateFunction is used to make a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b522ed8f0396
unity_docs
scripting
What is `AI.NavMeshAgent.autoRepath` in Unity? Explain its purpose and usage.
NavMeshAgent.autoRepath public bool autoRepath ; Description Should the agent attempt to acquire a new path if the existing path becomes invalid? A new path calculation is also attempted aquired if the agent reaches the end of a partial and stale path.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11a784dd2089
unity_docs
scripting
What is `Search.IPropertyDatabaseView.TryLoad` in Unity? Explain its purpose and usage.
IPropertyDatabaseView.TryLoad Declaration public bool TryLoad (InAttribute) recordKey , out object data ); Parameters Parameter Description recordKey A record key. data The property value. Returns bool True if the record is found and is valid, false otherwise. Description Loads a single property, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c9434f33d85
unity_docs
rendering
What is `Rendering.ShadowDrawingSettings` in Unity? Explain its purpose and usage.
ShadowDrawingSettings struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Settings for ScriptableRenderContext.DrawShadows. This structure describes which shadow light to render ( lightIndex ) with what split settings ( splitData ). Additional resources: ShadowSplitData . Prop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea01343308e3
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerSummaryMetrics.LongestWaitTimeMicroseconds` in Unity? Explain its purpose and usage.
AsyncReadManagerSummaryMetrics.LongestWaitTimeMicroseconds public float LongestWaitTimeMicroseconds ; Description The longest time spent waiting of metrics included in the summary calculation, in microseconds.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ca07b11bdd88
github
scripting
Write a Unity C# MonoBehaviour script called Query Indoor Map Entity Information
```csharp using Wrld; using Wrld.Space; using UnityEngine; using System.Collections; using System.Collections.Generic; using Wrld.Resources.IndoorMaps; using Wrld.Space.Positioners; using System.Linq; public class QueryIndoorMapEntityInformation : MonoBehaviour { private readonly LatLong m_indoorMapLoc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5792546fe466
unity_docs
rendering
What is `Experimental.Rendering.DefaultFormat` in Unity? Explain its purpose and usage.
DefaultFormat enumeration Description Use a default format to create either Textures or RenderTextures from scripts based on platform specific capability. ```csharp using UnityEngine; using UnityEngine.Experimental.Rendering; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_555fa6eb07cd
github
scripting
Write a Unity C# MonoBehaviour script called Component Data Author
```csharp using Unity.Entities; using UnityEngine; namespace HybridEZS { public abstract class ComponentDataAuthor : MonoBehaviour { public abstract void InsertAuthoredComponentToEntity(Entity entity); void Reset() => TryToAddIntoLocalInjector(); void TryToAddIntoLocalInjector() { if (TryGetCo...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_c182a60c53ff
unity_docs
scripting
What are the parameters of `Transform.SetParent` in Unity?
Description Set the parent of the transform. This method is the same as the parent property except that it also lets the Transform keep its local orientation rather than its global orientation. This means for example, if the GameObject was previously next to its parent, setting worldPositionStays to false will move the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e2293e40569
unity_docs
physics
Give me an overview of the `ParticleSystemTriggerEventType` class in Unity.
ParticleSystemTriggerEventType enumeration Description The different types of particle triggers. Properties Property Description Inside Trigger when particles are inside the collision volume. Outside Trigger when particles are outside the collision volume. Enter Trigger when particles enter the collision volu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_43f3d5d9fb1b
unity_docs
xr
Show me a Unity code example for 'Git dependencies'.
formation, refer to Installing from a Git URL . ## Git URLs The Package Manager supports all Git protocols , with the exception of local file paths. To specify a Git URL as a dependency, add the name of the package to add with a Git URL instead of the version number or local file path to the project manifest . For ex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72dd0dfeb151
unity_docs
animation
What is `UIElements.Experimental.ValueAnimation_1.OnCompleted` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ValueAnimation<T0>.OnCompleted Declaration public ValueAnimation<T> OnCompleted ( Unity.Android.Gradle.Manifest.Action callback ); Description Sets a callback invoked when this animation has completed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9a6f6b0ed25
unity_docs
scripting
What is `Rendering.IRenderPipelineGraphicsSettings` in Unity? Explain its purpose and usage.
IRenderPipelineGraphicsSettings interface in UnityEngine.Rendering Description Classes implementing this interface are stored in RenderPipelineGlobalSettings . Use them to store project default data. ```csharp using System; using System.ComponentModel; using UnityEngine; using UnityEngine.Rendering;[ Serializab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a068773823e3
unity_docs
rendering
What is `TextureImporterSettings.flipGreenChannel` in Unity? Explain its purpose and usage.
TextureImporterSettings.flipGreenChannel public bool flipGreenChannel ; Description Indicates whether to invert the green channel values of a normal map. Inverting the green (Y) channel values of a normal map is useful if the normal map uses a different convention to what Unity expects. If the normal map conven...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83e7f61fd32e
unity_docs
scripting
Show me a Unity C# example demonstrating `Color32.ToString`.
String Declaration public string ToString (); Declaration public string ToString (string format ); Declaration public string ToString (string format , IFormatProvider formatProvider ); Parameters Parameter Description format A numeric format string. formatProvider An object that specifies culture...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_859da008fc6b
unity_docs
physics
What is `AI.NavMeshAgent.autoTraverseOffMeshLink` in Unity? Explain its purpose and usage.
NavMeshAgent.autoTraverseOffMeshLink public bool autoTraverseOffMeshLink ; Description Should the agent move across OffMeshLinks automatically? Off-mesh links are used to connect disjoint regions of the NavMesh. Usually, a character should be able to pass through or traverse a link automatically, which will h...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7084b517b881
github
scripting
Write a Unity Editor script for Passthrough Camera Editor Update Manifest
```csharp // Copyright (c) Meta Platforms, Inc. and affiliates. using System; using System.Xml; using Meta.XR.Samples; using UnityEditor; using UnityEditor.Build; using UnityEditor.Build.Reporting; using UnityEngine; namespace PassthroughCameraSamples.Editor { [MetaCodeSample("PassthroughCameraApiSamples-Passthro...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_6668b94aae2d
unity_docs
physics
What are the parameters of `CapsulecastCommand.ctor` in Unity?
Description Creates a CapsulecastCommand. This command is run in the default physics scene. Declaration public CapsulecastCommand ( PhysicsScene physicsScene , Vector3 p1 , Vector3 p2 , float radius , Vector3 direction , QueryParameters queryParameters , float distance ); Parameters Parameter Description physicsScene T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c057bdac9e7
unity_docs
scripting
What are the parameters of `JsonUtility.ToJson` in Unity?
Returns string The object's data in JSON format. Description Generate a JSON representation of the public fields of an object. Internally, this method uses the Unity serializer. The object you pass in and all its fields must meet the requirements for serialization by the Unity serializer. For the full list of these req...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f5c612ba55e0
unity_docs
rendering
In Unity's 'Sample a texture in HLSL', what is 'Create a custom sampler' and how does it work?
To create and use a custom sampler directly in a shader, also known as an inline sampler, follow these steps: Declare a SamplerState object and use its name to set its properties. For example, the following code creates a custom sampler that uses point filtering and the clamp wrapping mode: ``` SamplerState my_point_cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c842cfbcd3b
unity_docs
scripting
What is `Unity.Properties.Property_2.GetAttributes` in Unity? Explain its purpose and usage.
Property<T0,T1>.GetAttributes Declaration public IEnumerable<TAttribute> GetAttributes (); Returns IEnumerable<TAttribute> An IEnumerable_1 for all attributes of the given type. Description Returns all attribute of the given type. Declaration public IEnumerable<Attribute> GetAttributes (); Returns ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c3eea320d2cc
unity_docs
scripting
Give me an overview of the `TagHandle` class in Unity.
TagHandle struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description A handle to one of the tag values that can be applied to a GameObject. If you are checking the tag on a GameObject to see if it matches a particular value, then using a TagHandle instead of the raw tag name can be faster. Addit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6f1f32c79e6b
unity_docs
rendering
Explain 'Upgrade to Unity 2021 LTS' in Unity.
This page lists changes in the Unity 2021 LTS version which might affect existing projects when you upgrade from a 2020 version to 2021 LTS. Note : 2021 LTS is also known as 2021.3. ## Page Outline Render pipelines Device Simulator Environment Lighting Environment lighting: Ambient probe and skybox reflection probe a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a64a9c76c23
unity_docs
physics
What are the parameters of `Collider2D.OnTriggerExit2D` in Unity?
Description Sent when another object leaves a trigger collider attached to this object (2D physics only). Further information about the other collider is reported in the Collider2D parameter passed during the call. Notes: Trigger events will be sent to disabled MonoBehaviours, to allow enabling Behaviours in response t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a00435b57e6f
unity_docs
rendering
In Unity's 'Compute shader Import Settings window reference', what is 'Imported object' and how does it work?
Property Description Kernels Displays the names of the kernels the shader code defines, and which graphics APIs Unity compiles the kernels for. Preprocess only Sets Show compiled code to generate only the preprocessed code instead of the final code. For more information, refer to Shader compilation . Strip #line direct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4211ede35722
unity_docs
ui
In Unity's 'Local folder or tarball paths', what is 'Example of an absolute path in Windows' and how does it work?
Notice that the drive letter immediately follows the file: prefix: ``` { "dependencies": { "my_package_a": "file:C:/Users/my_username/github/my_package_folder", "my_package_b": "file:C:/Users/my_username/Downloads/my_package_tarball.tgz" } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_936c49f6bed4
unity_docs
scripting
What is `MonoBehaviour.OnApplicationQuit` in Unity? Explain its purpose and usage.
MonoBehaviour.OnApplicationQuit() Description Sent to all GameObjects before the application quits. In the Editor, Unity calls OnApplicationQuit when exiting Play mode. It's called on all script components, even if the component is disabled. Platform-specific considerations: iOS applications suspend rather than...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_45d6100bb7c9
unity_docs
scripting
Show me a Unity C# example demonstrating `AI.NavMeshObstacle.velocity`.
NavMeshObstacle.velocity public Vector3 velocity ; Description Velocity at which the obstacle moves around the NavMesh. ```csharp // Name this file (ManualObstacleVelocityUpdater.cs) to match the class name. using System; using UnityEngine; using UnityEngine.AI; /// <summary> /// Update the current GameOb...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32f30aaba5da
unity_docs
scripting
What is `Rendering.CommandBuffer.SetViewMatrix` in Unity? Explain its purpose and usage.
CommandBuffer.SetViewMatrix Declaration public void SetViewMatrix ( Matrix4x4 view ); Parameters Parameter Description view View (world to camera space) matrix. Description Add a command to set the view matrix. The view matrix is the matrix that transforms from world space into camera space. When setting...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2a05cc3e95e
unity_docs
rendering
What is `GUI.SelectionGrid` in Unity? Explain its purpose and usage.
GUI.SelectionGrid Declaration public static int SelectionGrid ( Rect position , int selected , string[] texts , int xCount ); Declaration public static int SelectionGrid ( Rect position , int selected , Texture[] images , int xCount ); Declaration public static int SelectionGrid ( Rect position ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ae75b54ec8b7
unity_docs
audio
In Unity's 'Introduction to transcoding video files', what is 'Video codecs' and how does it work?
You can transcode video files into one of the following video codecs: H.264 H.265 VP8 Transcoded video files use the appropriate audio codec automatically: AAC for videos encoded with H.264 or H.265 Vorbis for videos encoded with VP8 Note : The Video Clip Importer provides only basic transcoding options. Depending on t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16bca24d6302
unity_docs
editor
What is `UIElements.IEventHandler` in Unity? Explain its purpose and usage.
IEventHandler interface in UnityEngine.UIElements Description Interface for class capable of handling events. Public Methods Method Description HandleEvent Handles an event according to its propagation phase and current target, by executing the element's default action or callbacks associated with the ev...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39ea3417d23a
unity_docs
rendering
Give me an overview of the `SkinnedMeshRenderer` class in Unity.
SkinnedMeshRenderer class in UnityEngine / Inherits from: Renderer / Implemented in: UnityEngine.CoreModule Description The Skinned Mesh filter. Properties Property Description bones The bones used to skin the mesh. forceMatrixRecalculationPerRender Forces the Skinned Mesh to recalculate its matricies wh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7139730943be
unity_docs
rendering
What is `TextureImporterSettings.wrapModeU` in Unity? Explain its purpose and usage.
TextureImporterSettings.wrapModeU public TextureWrapMode wrapModeU ; Description Texture U coordinate wrapping mode. Controls wrapping mode along texture U (horizontal) axis. Additional resources: Texture.wrapModeU , wrapMode , texture assets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1850177d1f36
unity_docs
rendering
What is `Shader.GetPropertyFlags` in Unity? Explain its purpose and usage.
Shader.GetPropertyFlags Declaration public Rendering.ShaderPropertyFlags GetPropertyFlags (int propertyIndex ); Parameters Parameter Description propertyIndex The index of the shader property. Description Returns the ShaderPropertyFlags of the shader property at the specified index. If Unity cannot f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bfcf0c3a43ab
unity_docs
rendering
What is `Experimental.GlobalIllumination.DiscLight.color` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. DiscLight.color public Experimental.GlobalIllumination.LinearColor color ; Description The direct light color.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.