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_98fd7e7d9283
unity_docs
rendering
What is `Search.SearchItemOptions.RightToLeft` in Unity? Explain its purpose and usage.
SearchItemOptions.RightToLeft Description If the description is longer than the search view, keeps the last characters. ``` private static SearchItem SearchLogEntry(SearchContext context, SearchProvider provider, LogEntry logEntry) { if (!SearchUtils.MatchSearchGroups(context, logEntry.msgLowerCased, true)) retur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_049b4190839b
unity_docs
rendering
What is `Windows.WebCam.CameraParameters.cameraResolutionHeight` in Unity? Explain its purpose and usage.
CameraParameters.cameraResolutionHeight public int cameraResolutionHeight ; Description A valid height resolution for use with the web camera. This value must be set to a valid height resolution supported by the intended capture mode. For example, when using this with PhotoCapture, you will want to query Photo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b362e5049aa
unity_docs
performance
What is `AndroidJNI` in Unity? Explain its purpose and usage.
AndroidJNI class in UnityEngine / Implemented in: UnityEngine.AndroidJNIModule Description 'Raw' JNI interface to Android Java VM from Unity scripting (C#). Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note. Static Methods Method Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a5889bb29b1c_doc_26
github
scripting
What does `GetCellIndex` do in this Unity script? Explain its purpose and signature.
Gets the index to the GameObjectBrush::ref::BrushCell based on the position of the BrushCell.X Position of the BrushCell.Y Position of the BrushCell.Z Position of the BrushCell. Signature: ```csharp public int GetCellIndex(int x, int y, int z) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_3998f3622155
unity_docs
rendering
Explain 'Default texture Import Settings window reference' in Unity.
The Default texture type is the most common texture type and provides access to most of the properties for texture importing. With this texture type, you can also change the Texture Shape . For more information about the Texture Importer window, refer to texture type . Property Description sRGB (Color Texture) Indicate...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c819a46e2c09
unity_docs
scripting
What is `Undo.RecordObject` in Unity? Explain its purpose and usage.
Undo.RecordObject Declaration public static void RecordObject ( Object objectToUndo , string name ); Parameters Parameter Description objectToUndo The reference to the object that you will be modifying. name The title of the action to appear in the undo history (i.e. visible in the undo menu). Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21f08f00d260
unity_docs
scripting
What is `UIElements.EventInterestOptions` in Unity? Explain its purpose and usage.
EventInterestOptions enumeration Description Options used as arguments for EventInterestAttribute when the affected method treats events in a general, non type-specific manner. Properties Property Description Inherit Use the Inherit option when only the events needed by the base class are required. For ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a44942d0605
unity_docs
scripting
What is `GL.TRIANGLES` in Unity? Explain its purpose and usage.
GL.TRIANGLES public static int TRIANGLES ; Description Mode for Begin : draw triangles. Draws triangles using each set of 3 vertices passed. If you pass 3 vertices, one triangle is drawn, where each vertex becomes one corner of the triangle. If you pass 6 vertices, 2 triangles will be drawn. To set up the scre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44ab44839adf
unity_docs
rendering
What is `Rendering.RayTracingAccelerationStructure.RemoveVFXInstances` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.RemoveVFXInstances Declaration public void RemoveVFXInstances ( Renderer targetRenderer ); Parameters Parameter Description targetRenderer The VFXRenderer whose instances will be removed. Description Remove the ray tracing instances associated with a VFXRenderer from the Ra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ace0cb8307e
unity_docs
scripting
What is `Unity.Properties.ISetPropertyVisitor.Visit` in Unity? Explain its purpose and usage.
ISetPropertyVisitor.Visit Declaration public void Visit (Property<TContainer,TSet> property , ref TContainer container , ref TSet set ); Parameters Parameter Description property The property being visited. container The container being visited. set The hash set value. Description Implement this met...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_247b7cce94cb
unity_docs
math
Explain 'USS transform' in Unity.
The transform properties apply a 2D transformation to a visual element . You can use them to rotate, scale, or move a visual element. If you change the layout of an element, Unity recalculates the layout of other elements in the same hierarchy. This recalculation might reduce an animation’s frame rate. Applying transfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60615b40c169
unity_docs
physics
What is `ImportAssetOptions.DontDownloadFromCacheServer` in Unity? Explain its purpose and usage.
ImportAssetOptions.DontDownloadFromCacheServer Description Force a full reimport but don't download the assets from the cache server. Additional resources: AssetDatabase.ImportAsset , AssetDatabase.Refresh .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e3c0595d4c87
unity_docs
animation
In Unity's 'Playables Examples', what is 'PlayableGraph Visualizer' and how does it work?
The examples on this page use the PlayableGraph Visualizer to illustrate the trees and nodes created by the Playables API. The PlayableGraph Visualizer is a tool available through GitHub. Note : The PlayableGraph Visualizer is a discontinued experimental package that may not work with your version of Unity. To use the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e4a6ef6c98ae
unity_docs
scripting
What is `UIElements.StylePropertyName.operator_ne` in Unity? Explain its purpose and usage.
StylePropertyName.operator != public static bool operator != ( UIElements.StylePropertyName lhs , UIElements.StylePropertyName rhs ); Parameters Parameter Description lhs First StylePropertyName. rhs Second StylePropertyName. Returns bool True if the StylePropertyNames are not equal. False otherwis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0f29b27ca936
unity_docs
ui
In Unity's 'AudioGroup Inspector', what is 'Inspector Header' and how does it work?
At the top of the AudioGroup Inspector there is the name of the AudioGroup, along with the gear dropdown common to all Object Inspectors. The gear menu contains the following functionality: Copy all effect settings to all snapshots : Use this setting to copy all the effect parameter, volume and pitch settings of this A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6aeac274c741
unity_docs
rendering
Explain 'Display or hide an overlay' in Unity.
To customize your workspace, choose which overlays display in the Scene view. If you want to save your overlay configuration, refer to Create and manage overlay configurations . ## Display or hide an overlay To display or hide an overlay in the Scene view : In the Scene view, press the ` key to display the Overlays m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0ddfb965d35
unity_docs
rendering
What is `SceneViewCameraWindow.ctor` in Unity? Explain its purpose and usage.
SceneViewCameraWindow Constructor Declaration public SceneViewCameraWindow ( SceneView sceneView ); Parameters Parameter Description sceneView The SceneView inspected by the SceneViewCameraWindow window. Description Creates an instance of the SceneViewCameraWindow window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a0710f55cea
unity_docs
scripting
Give me an overview of the `StateMachineBehaviour` class in Unity.
StateMachineBehaviour class in UnityEngine / Inherits from: ScriptableObject / Implemented in: UnityEngine.AnimationModule Description StateMachineBehaviour is a component that can be added to a state machine state. It's the base class any script on a state must derive from. State machines can have up to thre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a64384312039
unity_docs
animation
What is `Animations.ParentConstraint.GetSources` in Unity? Explain its purpose and usage.
ParentConstraint.GetSources Declaration public void GetSources (List<ConstraintSource> sources ); Parameters Parameter Description sources The list of sources filled by the component. Description Gets the list of sources. Throws ArgumentNullException, if the list of sources is null.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_863857223e77
unity_docs
scripting
What is `UIElements.UQueryState_1.AtIndex` in Unity? Explain its purpose and usage.
UQueryState<T0>.AtIndex Declaration public T AtIndex (int index ); Parameters Parameter Description index The index of the matched element. Returns T The match element at the specified index. Description Selects the nth element matching all the criteria, or null if not enough elements were found.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bc1ed185faf4
unity_docs
rendering
In Unity's 'Declare shader keywords', what is 'Declare sets of keywords' and how does it work?
The keywords in a single #pragma statement are together called a set. For example, to declare a set of three keywords: ``` #pragma shader_feature REFLECTION_TYPE1 REFLECTION_TYPE2 REFLECTION_TYPE3 ``` You can declare multiple sets of keywords in a single shader. For example, to create two sets: ``` #pragma shader_featu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d978c1215c44
unity_docs
math
What is `Shader.GetGlobalVectorArray` in Unity? Explain its purpose and usage.
Shader.GetGlobalVectorArray Declaration public static Vector4[] GetGlobalVectorArray (string name ); Declaration public static Vector4[] GetGlobalVectorArray (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_804a842152e2
unity_docs
animation
Explain 'Extracting animation clips' in Unity.
An animated character typically has a number of different movements that are activated in the game in different circumstances, called Animation Clips . For example, we might have separate animation clips for walking, running, jumping, throwing, and dying. Depending on how the artist set up the animation in the 3D model...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_203c8085c68f
unity_docs
rendering
In Unity's 'Custom Editor block in ShaderLab reference', what is 'Render pipeline compatibility' and how does it work?
Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline ShaderLab: CustomEditor block Yes Yes Yes Yes ShaderLab: CustomEditorForRenderPipeline block Yes Yes Yes No
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_484cbcf43460
github
scripting
Write a Unity C# MonoBehaviour script called Mono Pool
```csharp using UnityEngine; namespace Pool.Runtime { /// <summary> /// A pool that manages MonoBehaviour-based objects, providing methods to create, retrieve, return, and destroy them. /// </summary> /// <typeparam name="T">The type of MonoBehaviour that is poolable and implements the <see cref="IPoo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90550fcc965d
unity_docs
scripting
What is `WebGLExceptionSupport` in Unity? Explain its purpose and usage.
WebGLExceptionSupport enumeration Description Options for Exception support in WebGL. Properties Property Description None Disable exception support. ExplicitlyThrownExceptionsOnly Enable throw support. FullWithoutStacktrace Enable exception support for all exceptions, without stack trace information. FullWi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38dc827e9a61
unity_docs
editor
What is `Device.SystemInfo.graphicsMemorySize` in Unity? Explain its purpose and usage.
SystemInfo.graphicsMemorySize public static int graphicsMemorySize ; Description This has the same functionality as SystemInfo.graphicsMemorySize and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d234a9b3d48e
unity_docs
ui
Show me a Unity code example for 'Web template build configuration and interaction'.
Configure and interact with Web builds using Web templates. For information about template variables, JavaScript macros, and conditional directives, refer to Web template variables . ## Build configuration The configuration object contains the build configuration, which consists of code and data URLs, product name, c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09e279a97c8a
unity_docs
scripting
Show me a Unity C# example demonstrating `Physics.ContactModifyEvent`.
API is available off the main thread. Additionally, an event handler can be invoked multiple times per frame, because the physics system distributes all contacts among threads, and only sends a particular amount of contacts per call. Note: to get contact pairs that have been generated by the CCD solver, subscribe to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f3766ba499e
unity_docs
ui
What is `PropertyDrawer` in Unity? Explain its purpose and usage.
PropertyDrawer class in UnityEditor / Inherits from: GUIDrawer Description Base class to derive custom property drawers from. Use this to create custom drawers for your own Serializable classes or for script variables with custom PropertyAttribute s. PropertyDrawers have two uses: Customize the GUI of every i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_07cb898b9b70
unity_docs
rendering
What is `ParticleSystemBakeTextureOptions` in Unity? Explain its purpose and usage.
ParticleSystemBakeTextureOptions enumeration Description Configure how a Particle System is baked into a texture. Properties Property Description BakeRotationAndScale Bake the Transform rotation and scale into the texture. BakePosition Bake the Transform position into the texture. PerVertex Bake each vertex o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9325bdd82dc
unity_docs
physics
What is `ParticleSystem.Particle.velocity` in Unity? Explain its purpose and usage.
ParticleSystem.Particle.velocity public Vector3 velocity ; Description The velocity of the particle, measured in units per second. This velocity is used for effects that are based on physics. Examples of features that use this type of velocity are the Force module, Gravity, and Start Speed. The system stores...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_075bda149f01
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.VirtualTexturing.Streaming.RequestRegion`.
on should be called regularly (preferably every frame) to indicate the continued interest in this data. When this function is no longer called the requested area may be evicted from memory or only be available at a lower resolution. See Streaming.RequestRegion for an example using this function. The following example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14632e8c9e46
unity_docs
rendering
What is `GraphicsBuffer.Target.Append` in Unity? Explain its purpose and usage.
GraphicsBuffer.Target.Append Description GraphicsBuffer can be used as an append-consume buffer. Allows a buffer to be treated like a stack in compute shaders. Maps to AppendStructuredBuffer<T> or ConsumeStructuredBuffer<T> in HLSL. When you construct a GraphicsBuffer of this type, the value of stride must ma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b45c80cfd7a2
unity_docs
xr
What is `Unity.IO.LowLevel.Unsafe.ReadStatus` in Unity? Explain its purpose and usage.
ReadStatus enumeration Description The state of an asynchronous file request. These enumerations represent the raw underlying states of an asynchronous file request. When submitted, all requests enter the ReadStatus.InProgress state while they are pending execution or in progress. On completion, the state change...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0dfb2c8996c7
unity_docs
editor
What is `EditorApplication.modifierKeysChanged` in Unity? Explain its purpose and usage.
EditorApplication.modifierKeysChanged public static EditorApplication.CallbackFunction modifierKeysChanged ; Description Delegate for changed keyboard modifier keys. Add your functions to this delegate to get a callback whenever the keyboard modifier keys have changed. Additional resources: CallbackFunction ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e142536fcb2
unity_docs
scripting
What is `HashUnsafeUtilities.ComputeHash128` in Unity? Explain its purpose and usage.
HashUnsafeUtilities.ComputeHash128 Declaration public static void ComputeHash128 (void* data , ulong dataSize , ulong* hash1 , ulong* hash2 ); Declaration public static void ComputeHash128 (void* data , ulong dataSize , Hash128* hash ); Parameters Parameter Description data Pointer to the data to h...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50cececbdf19
unity_docs
scripting
What is `Mesh.MarkDynamic` in Unity? Explain its purpose and usage.
Mesh.MarkDynamic Declaration public void MarkDynamic (); Description Optimize mesh for frequent updates. Call this before assigning vertices to get better performance when continually updating the Mesh. Internally, this makes the Mesh use "dynamic buffers" in the underlying graphics API, which are more efficie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9d2857288a14_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Defines the position of a passthrough camera relative to the headset Signature: ```csharp public enum PassthroughCameraEye ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_f2b28e8683bf
unity_docs
scripting
What are the parameters of `Rendering.CommandBuffer.SetViewMatrix` in Unity?
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 both view and projection matrices, it is more efficient to use SetViewProjectionMatrices . Note: The camera space in Unity matches OpenGL convention, so the negative z-axis is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2241ae7e15d3
unity_docs
scripting
What is `Application.installerName` in Unity? Explain its purpose and usage.
Application.installerName public static string installerName ; Description Returns the name of the store or package that installed the application (Read Only). iOS : Returns Apple Store . Android : Returns the package name of the app that installed the application (for example, com.android.vending for Google...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0a53ba95e0db
github
scripting
Write a Unity C# MonoBehaviour script called Die Utils
```csharp using System; using System.Collections; using System.Collections.Generic; using UnityEngine; public class DieUtils : MonoBehaviour { [SerializeField] private Transform[] dieSides; [SerializeField] private GameObject hitParticle; [SerializeField] private GameObject beamParticle; private stati...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_0b1dc65ee79a
unity_docs
scripting
What is `UIElements.DetachFromPanelEvent` in Unity? Explain its purpose and usage.
DetachFromPanelEvent class in UnityEngine.UIElements / Inherits from: UIElements.PanelChangedEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Event sent just before an element is detached from its parent, if the parent is the descendant of a panel. Don't modify the parent of the elem...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1f6dc63200f
unity_docs
rendering
What is `RenderTextureCreationFlags.AutoGenerateMips` in Unity? Explain its purpose and usage.
RenderTextureCreationFlags.AutoGenerateMips Description Determines whether or not mipmaps are automatically generated when the RenderTexture is modified. This flag is set by default, and has no effect if the RenderTextureCreationFlags.MipMap flag is not also set. See RenderTexture.autoGenerateMips for more detai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_621fa8be2e29
unity_docs
physics
What is `Experimental.Licensing.LicensingUtility.UpdateLicense` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LicensingUtility.UpdateLicense Declaration public static bool UpdateLicense (); Returns bool True if successful; false otherwise. Description Triggers an update to all available license types found on this machine.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d7dbe897a18
unity_docs
rendering
What is `Build.Content.WriteManagerParameters` in Unity? Explain its purpose and usage.
WriteManagerParameters struct in UnityEditor.Build.Content Description Defines the write parameters for the ContentBuildInterface.WriteGameManagersSerializedFile function. Properties Property Description globalUsage The global lighting information to use when writing the serialized file. referenceMap The se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4eefea26d4c2
unity_docs
rendering
What is `LightTransport.InputExtraction.BakeInput` in Unity? Explain its purpose and usage.
BakeInput class in UnityEngine.LightTransport Description Container for scene data to be used for light transport calculations. An opaque data structure containing all scene information needed for light baking calculations, including geometry, materials, lights, and probe positions. This object is created by Inp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d82f6a884831
unity_docs
math
What is `AndroidJNI.CallLongMethodUnsafe` in Unity? Explain its purpose and usage.
AndroidJNI.CallLongMethodUnsafe Declaration public static long CallLongMethodUnsafe (IntPtr obj , IntPtr methodID , jvalue* args ); Description Calls a Java instance method defined by methodID , optionally passing an array of arguments ( args ) to the method. Additional resources: Java Native Interface Spe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8c21f425961f_doc_8
github
scripting
What does `GetTimeElapsedSinceSetActive` do in this Unity script? Explain its purpose and signature.
Get the amount of time that has passed since this state was set to active.Time elapsed in seconds Signature: ```csharp public float GetTimeElapsedSinceSetActive() ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_142d125fcf14
unity_docs
rendering
Show me a Unity C# example demonstrating `Cubemap.SetPixel`.
Alpha8 ARGB32 ARGB4444 BGRA32 R16 R16_SIGNED R8 R8_SIGNED RFloat RG16 RG16_SIGNED RG32 RG32_SIGNED RGB24 RGB24_SIGNED RGB48 RGB48_SIGNED RGB565 RGB9e5Float RGBA32 RGBA32_SIGNED RGBA4444 RGBA64 RGBA64_SIGNED RGBAFloat RGBAHalf RGFloat RGHalf RHalf For all other formats, Unity ignores SetPix...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7b7f831610c
unity_docs
animation
What is `UIElements.Experimental.ValueAnimation_1.Stop` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ValueAnimation<T0>.Stop Declaration public void Stop (); Description Stops this animation. If set, the onAnimationCompleted callback will be called.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61dbefcc6f72
unity_docs
ui
What is `UIElements.VisualElement.transform` in Unity? Explain its purpose and usage.
VisualElement.transform public UIElements.ITransform transform ; Description Returns a transform object for this VisualElement. ITransform The transform object implements changes to the VisualElement object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d25d649c5ceb
unity_docs
physics
Explain 'Interaction between collider types' in Unity.
The following collision matrix table describe which event messages Unity generates based on the configuration of each collider in a collision pair: Collider types Static collider Dynamic collider Kinematic collider Static trigger collider Dynamic trigger collider Kinematic trigger collider Static collider No collision ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_73d318f0f26a
unity_docs
editor
What is `ConsoleWindowUtility` in Unity? Explain its purpose and usage.
ConsoleWindowUtility class in UnityEditor Description Console Window Utility class. Static Methods Method Description GetConsoleLogCounts Retrieve the current counts of messages in the Console Window. Events Event Description consoleLogsChanged Unity raises this event when logs are added or cleared in the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b1d60fbf839
unity_docs
animation
What is `ParticleSystem.MinMaxCurve.curve` in Unity? Explain its purpose and usage.
ParticleSystem.MinMaxCurve.curve public AnimationCurve curve ; Description Set the curve. You should set the values between 0 and 1. Use the curve multiplier to define the overall range of the curve. Useful when ParticleSystem.MinMaxCurve.mode is set to ParticleSystemCurveMode.Curve .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aca14be27898
unity_docs
rendering
What is `LightTransport.IProbeIntegrator.Prepare` in Unity? Explain its purpose and usage.
IProbeIntegrator.Prepare Declaration public void Prepare ( LightTransport.IDeviceContext context , LightTransport.IWorld world , BufferSlice<Vector3> positions , float pushoff , int bounceCount ); Parameters Parameter Description context Device context for computation and memory operations. world Wo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc89bca6f024
unity_docs
scripting
What is `Search.QueryEngine_1.ctor` in Unity? Explain its purpose and usage.
QueryEngine<T0> Constructor Declaration public QueryEngine<T0> (); Declaration public QueryEngine<T0> (bool validateFilters ); Declaration public QueryEngine<T0> ( Search.QueryValidationOptions validationOptions ); Parameters Parameter Description validateFilters Indicates if the engine must valida...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_03734275835d
unity_docs
rendering
Explain 'Lens flares' in Unity.
Resources and techniques for creating lens flares lighting effects, which can add atmosphere to your scene . Topic Description Introduction to lens flare effects Understand how Unity manages lens flares, which simulate the effect of lights refracting inside a camera lens. Lens flares in URP Resources and techniques for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8c7a3fbf774d
unity_docs
physics
In Unity's 'Profiler modules introduction', what is 'Custom Profiler modules' and how does it work?
You can add your own Profiler modules to the Profiler window to capture and visualize specific performance data in your application. You can either use the Profiler Module Editor or use scripts to automatically create and populate modules. The following image of a customized Profiler window contains: A : A custom Profi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_15fa75eb0694
unity_docs
scripting
Show me a Unity code example for 'Windows Player: IL2CPP Scripting Backend'.
ate Windows option in the Platform settings section of the Inspector: Because the functions are linked together with generated C++ code, there is no separate DLL to _P/Invoke into. Due to this, you can use the “__Internal” keyword in place of the DLL name, which makes it the C++ linker’s responsibility to resolve the f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b71d02be2dc
unity_docs
animation
What is `AnimatorOverrideController.ApplyOverrides` in Unity? Explain its purpose and usage.
AnimatorOverrideController.ApplyOverrides Declaration public void ApplyOverrides (IList<KeyValuePair<AnimationClip,AnimationClip>> overrides ); Parameters Parameter Description overrides Overrides list to apply. Description Applies the list of overrides on this Animator Override Controller. This function ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e02ec567eb38
unity_docs
physics
In Unity's 'Android symbols', what is 'Types of symbol files' and how does it work?
Unity uses debugSymbolLevel property of Gradle to generate symbol files. There are two types of symbol files: Public: A small file that contains a symbol table section. For more information, refer to Public symbols . Debugging: Contains everything that a public symbol file contains along with full debugging information...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7f22ea4b83a
unity_docs
performance
What is `Profiling.CustomSampler.Begin` in Unity? Explain its purpose and usage.
CustomSampler.Begin Declaration public void Begin (); Declaration public void Begin ( Object targetObject ); Description Begin profiling a piece of code with a custom label defined by this instance of CustomSampler . This will show up in the Profiler hierarchy. ```csharp using UnityEngine; using UnityEn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0ead97f36110
unity_docs
physics
In Unity's 'Configuring garbage collection', what is 'Using the GarbageCollector API' and how does it work?
You can use the APIs in the GarbageCollector class to manually control the garbage collector, or disable it completely. You can use the following APIs to control the garbage collector: GarbageCollector.Mode.Disabled : Setting GarbageCollector.GCMode to this fully disables the garbage collector. Using System.GC.Collect ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_344053d4fd2e
unity_docs
rendering
Explain 'Particle rotation' in Unity.
Understand how the Particle System can change a particle’s rotation based on its speed or lifetime. ## Rotation by speed The Rotation by Speed module can change a particle’s rotation based on its speed in distance units per second. This module can be used when the particles represent solid objects moving over the gro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be7743972b65
unity_docs
xr
What is `RenderTexture.ctor` in Unity? Explain its purpose and usage.
RenderTexture.RenderTexture Constructor Declaration public RenderTexture ( RenderTexture textureToCopy ); Declaration public RenderTexture ( RenderTextureDescriptor desc ); Declaration public RenderTexture (int width , int height , int depth , RenderTextureFormat format = RenderTextureFormat.Defa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0a3e8f2f2d24
unity_docs
physics
Explain 'Get started with runtime binding' in Unity.
Version : 6000.0+ Want to learn how to create runtime data binding? Use this example to get started. This example creates a data source asset and uses UI Builder to bind the data source to a UI. To set a runtime binding in UI Builder: Define the data source and the data source path in the Inspector panel of the UI cont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b8549f0474e
unity_docs
scripting
What is `UIElements.UxmlSerializedData.Deserialize` in Unity? Explain its purpose and usage.
UxmlSerializedData.Deserialize Declaration public void Deserialize (object obj ); Parameters Parameter Description obj The element to have the serialized data applied to. Description Applies serialized field values to a compatible visual element. This is used by the code generator when a custom contro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2b58a5f2403c
unity_docs
rendering
In Unity's 'Splash Image Player settings', what is 'Logos' and how does it work?
Settings to customize the logos in your splash screen. Setting Description Show Unity Logo Enabled by default. Disable this option to remove the Unity logo from the splash screen. Draw Mode Select the order in which the logos appear on the splash screen. This setting is available only when Show Unity Logo is enabled. U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_18c829ebab44
unity_docs
physics
Explain 'Link XML formatting reference' in Unity.
This reference provides information on the correct formatting of link.xml files, including valid XML elements and attributes and usage examples. ## Supported XML elements The following XML elements are supported in link.xml files: Element Description <linker></linker> Must be used in all link.xml files as the outermo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7172ec5c599f
unity_docs
ui
In Unity's 'Customize the GUI for your audio plug-in', what is '3. Bind your GUI parameters to your audio plug-in parameters' and how does it work?
You need to define how the parameters in your plug-in relate to your GUI customizations. The OnGUI(IAudioEffectPlugin plugin) boolean function receives a handle to the native plug-in and then uses it to read and write parameters the native plug-in has defined. To bind your parameters: Find the OnGUI(IAudioEffectPlugin ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86ef2d54df4f
unity_docs
rendering
What is `Rendering.BatchDrawCommandProcedural.lightmapIndex` in Unity? Explain its purpose and usage.
BatchDrawCommandProcedural.lightmapIndex public ushort lightmapIndex ; Description The index of the baked lightmap used in this draw command. If lightmap texture arrays are enabled, this value is always -1 (0xFFFF). Additional resources: Renderer.lightmapIndex .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4a1e04725075_doc_8
github
scripting
What does `GetSerializedPropertyRecursive` do in this Unity script? Explain its purpose and signature.
Get all based on with inherited objs Signature: ```csharp private List<SerializedProperty> GetSerializedPropertyRecursive(SerializedProperty property, Func<SerializedProperty, bool> validateFunc) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_788b5190344d
unity_docs
scripting
In Unity's 'Create USS variables', what is 'Differences from CSS variables' and how does it work?
Variables work mostly the same way in USS as they do in CSS. For detailed information about CSS variables, see the MDN documentation . However, USS doesn’t support some of the functionalites of CSS: USS doesn’t support the var() function inside of other functions, such as shown below: ``` background-color: rgb(var(--re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49eadd02b1f3
unity_docs
editor
What is `Device.Screen.autorotateToPortraitUpsideDown` in Unity? Explain its purpose and usage.
Screen.autorotateToPortraitUpsideDown public static bool autorotateToPortraitUpsideDown ; Description This has the same functionality as Screen.autorotateToPortraitUpsideDown and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a066d11845d
unity_docs
editor
Give me an overview of the `XboxBuildSubtarget` class in Unity.
XboxBuildSubtarget enumeration Description Target Xbox build type. Additional resources: EditorUserBuildSettings.xboxBuildSubtarget. Properties Property Description Development Development player. Master Master player (submission-proof). Debug Debug player (for building with source code).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd5d887fb626
unity_docs
scripting
What is `Playables.PlayableOutputExtensions.PushNotification` in Unity? Explain its purpose and usage.
PlayableOutputExtensions.PushNotification Declaration public static void PushNotification (U output , Playables.Playable origin , Playables.INotification notification , object context ); Parameters Parameter Description output The output sending the notification. origin The originating playable of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86684145d484
unity_docs
ui
What is `UIElements.MouseEventBase_1` in Unity? Explain its purpose and usage.
MouseEventBase<T0> class in UnityEngine.UIElements / Inherits from: UIElements.EventBase_1 / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IMouseEvent Description The base class for mouse events. Properties Property Description actionKey Returns true if the platform-specific act...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c5d3cc8d0512
unity_docs
rendering
Explain 'DOTS Instancing shader macros reference for URP' in Unity.
Unity provides the following access macros: Access macro Description UNITY_ACCESS_DOTS_INSTANCED_PROP(PropertyType, PropertyName) Returns the value loaded from unity_DOTSInstanceData . Refer to Declare DOTS Instancing properties in a custom shader for more information. Shaders that Unity provides use this version for D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bde1798c7179
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetricsFilters.ctor` in Unity? Explain its purpose and usage.
AsyncReadManagerMetricsFilters Constructor Declaration public AsyncReadManagerMetricsFilters (); Declaration public AsyncReadManagerMetricsFilters (ulong typeID ); Declaration public AsyncReadManagerMetricsFilters ( Unity.IO.LowLevel.Unsafe.ProcessingState state ); Declaration public AsyncReadManagerM...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8163d5a4ffba
unity_docs
scripting
Give me an overview of the `UnityAPICompatibilityVersionAttribute` class in Unity.
UnityAPICompatibilityVersionAttribute class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Declares an assembly to be compatible (API wise) with a specific Unity API. Used by internal tools to avoid processing the assembly in order to decide whether assemblies may be using old Unity API. Pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb6cf6734f4f
unity_docs
rendering
What is `LightTransport.IntegrationContext.Dispose` in Unity? Explain its purpose and usage.
IntegrationContext.Dispose Declaration public void Dispose (); Description Perform a dispose operation. Releases all resources associated with the integration context, including native memory, cached data structures, and GPU resources. This method should be called when the context is no longer needed to prevent...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee35bc5213c0
unity_docs
scripting
What is `Progress.GetStepLabel` in Unity? Explain its purpose and usage.
Progress.GetStepLabel Declaration public static string GetStepLabel (int id ); Parameters Parameter Description id The progress indicator's unique ID. Returns string The step label. Description Gets the label that displays a progress indicator's steps. Additional resources: Progress.SetStepLabel , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cf773cdd12ca
unity_docs
scripting
Show me a Unity code example for 'C# compiler and language version reference'.
Windows platforms and requires Allow ‘unsafe’ Code to be enabled in the Player Settings . To enable it, go to: Project Settings > Player . Expand the Other Settings panel, navigate to the Script Compilation section. For more information on C#’s unsafe context, refer to Microsoft’s unsafe (C# Reference) documentation or...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_367193865b02
unity_docs
animation
What is `Animations.NotKeyableAttribute.ctor` in Unity? Explain its purpose and usage.
NotKeyableAttribute Constructor Declaration public NotKeyableAttribute (); Description Use this attribute in a script to mark a property as non-animatable. A non-animatable property cannot have key animation (not keyable). It does not appear as animatable in the Animation window and it cannot be animated in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8646cb4fabb
unity_docs
input
What is `TouchPhase.Began` in Unity? Explain its purpose and usage.
TouchPhase.Began Description A finger touched the screen. ```csharp //Attach this script to an empty GameObject //Create some UI Text by going to Create>UI>Text. //Drag this GameObject into the Text field of your GameObject’s Inspector window.using UnityEngine; using System.Collections; using UnityEngine.UI;public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03fae441e134
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GetAllCategories`.
meDataView.GetAllCategories Declaration public void GetAllCategories (List<ProfilerCategoryInfo> categoryInfoList ); Parameters Parameter Description categoryInfoList List filled with ProfilerCategoryInfo. Description Gets all the available Profiler Categories for the current profiling session. Use to ret...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acf822b10205
unity_docs
scripting
What is `iOS.Device.SetNoBackupFlag` in Unity? Explain its purpose and usage.
Device.SetNoBackupFlag Declaration public static void SetNoBackupFlag (string path ); Description Set file flag to be excluded from iCloud/iTunes backup. This uses NSURLIsExcludedFromBackupKey . Note that you should set this property each time you save a file.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0543d81089aa
unity_docs
scripting
In Unity's 'EnumField', what is 'Example' and how does it work?
The following UXML example creates an EnumField: ``` <UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <EnumField label="UXML Field" name="the-uxml-field" include-obsolete-values="false"/> </UXML> ``` The following C# example illustrates some of the customizable functionalities of the EnumField:...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b541d6aa57cb
unity_docs
rendering
In Unity's 'Respond to events with custom controls', what is 'Stop event propagation' and how does it work?
When handling an event inside a callback or a virtual method override, you can stop further event propagation by calling one of the StopPropagation methods on the event. For example, a parent panel might stop propagation during the trickle-down phase to prevent its children from receiving events. You can’t prevent the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17c563e56190
unity_docs
math
What is `Tilemaps.Tilemap.AddTileFlags` in Unity? Explain its purpose and usage.
Tilemap.AddTileFlags Declaration public void AddTileFlags ( Vector3Int position , Tilemaps.TileFlags flags ); Parameters Parameter Description position Position of the Tile on the Tilemap . flags TileFlags to add (with bitwise or) onto the flags provided by Tile . TileBase . Description Adds the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_65dfd3451d22
unity_docs
editor
Explain 'Linux IL2CPP cross-compiler' in Unity.
The Linux IL2CPP cross-compiler is a set of sysroot and toolchain packages that allow you to build Linux IL2CPP Players on any Standalone platform without needing to use the Linux Unity Editor or rely on Mono. If you meet the prerequisites, Unity automatically installs these packages for you when you choose the Linux b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cf555dac6aa
unity_docs
editor
Show me a Unity C# example demonstrating `VideoCodec`.
dec . 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 consider the video codec when it imports a video, make sure to enable the Transcoding property in the video clip’s Inspector window. For more inform...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9d0ec61521a
unity_docs
rendering
What is `Rendering.RenderQueue.Overlay` in Unity? Explain its purpose and usage.
RenderQueue.Overlay Description This render queue is meant for overlay effects. Anything rendered last should go here (e.g. lens flares). Additional resources: Material.renderQueue , Shader.renderQueue , subshader tags .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4872969f4a9
unity_docs
rendering
What is `Font.RequestCharactersInTexture` in Unity? Explain its purpose and usage.
Font.RequestCharactersInTexture Declaration public void RequestCharactersInTexture (string characters , int size = 0, FontStyle style = FontStyle.Normal); Parameters Parameter Description characters The characters which are needed to be in the font texture. size The size of the requested characters (...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c6d1bc74a27
unity_docs
rendering
What is `HideFlags.HideAndDontSave` in Unity? Explain its purpose and usage.
HideFlags.HideAndDontSave Description The GameObject is not shown in the Hierarchy, not saved to the Scene, and not unloaded by Resources.UnloadUnusedAssets . This is most commonly used for GameObjects which are created by a script and are purely under the script's control. ```csharp using UnityEngine; using Syst...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04a65e81907b
unity_docs
xr
What are the parameters of `Networking.UnityWebRequest.UnEscapeURL` in Unity?
Description Converts URL-friendly escape sequences back to normal text. Certain text characters have special meanings when present in URLs. If you need to include those characters in URL parameters then you must represent them with escape sequences. This function takes a string containing these escape sequences and con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e5752c6c078
unity_docs
math
What are the parameters of `Tilemaps.Tilemap.GetTilesBlockNonAlloc` in Unity?
Returns int Returns the number of Tiles retrieved, including null entries. Description Retrieves an array of Tiles with the given bounds. This is meant for more a performant way to get Tiles as a batch, when compared to calling GetTile for every single position. If the size of the arrays passed in as parameters are les...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4fa65f304ccb
unity_docs
rendering
In Unity's 'Shader code blocks in ShaderLab reference', what is 'CG' and how does it work?
CGPROGRAM and CGINCLUDE are compatible only with the Built-In Render Pipeline. For most uses, use HLSLPROGRAM and HLSLINCLUDE instead, unless you write surface shaders . If you use CGPROGRAM , Unity includes several of Unity’s built-in shader include files by default, enabling you to use built-in variables and function...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64e31ff83402
unity_docs
ui
Show me a Unity C# example demonstrating `EditorWindow.hasUnsavedChanges`.
t also use EditorWindow.saveChangesMessage , and override the EditorWindow.SaveChanges and/or EditorWindow.DiscardChanges methods. When hasUnsavedChanges is enabled, the title bar and docked tabs update to indicate that the user needs to save their work. If the user closes the window without saving, a message box...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.