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_ae42d13e398d
unity_docs
physics
What is `Rigidbody.ResetInertiaTensor` in Unity? Explain its purpose and usage.
Rigidbody.ResetInertiaTensor Declaration public void ResetInertiaTensor (); Description Reset the inertia tensor value and rotation. Computes the inertia tensor, and the inertia tensor rotation from the colliders attached to this rigidbody and stores it. After calling this function, the inertia tensor and tens...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8c61e5a8edb
unity_docs
physics
Give me an overview of the `ArticulationReducedSpace` class in Unity.
ArticulationReducedSpace struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description Coordinates in reduced space. The length of the internal array is equal to the amount of degrees of freedom (DoF). Properties Property Description dofCount The number of degrees of freedom of a body. this...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b11d3acc2b8
unity_docs
performance
What is `Unity.IO.LowLevel.Unsafe.FileHandle.JobHandle` in Unity? Explain its purpose and usage.
FileHandle.JobHandle public Unity.Jobs.JobHandle JobHandle ; Description The JobHandle of the asynchronous file open operation begun by the call to AsyncReadManager.OpenFileAsync that returned this FileHandle instance. This JobHandle completes when the file is open and ready to be read.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc4582e710bf
unity_docs
scripting
What is `PlayerSettings.SplashScreen.drawMode` in Unity? Explain its purpose and usage.
PlayerSettings.SplashScreen.drawMode public static PlayerSettings.SplashScreen.DrawMode drawMode ; Description Determines how the Unity logo should be drawn, if it is enabled. If no Unity logo exists in [logos] then the draw mode defaults to DrawMode.UnityLogoBelow .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d938649ffeca
unity_docs
editor
Explain 'Collect performance data about the Unity Editor' in Unity.
Profile the Unity Editor process to understand the performance of the Editor itself or how the Editor process affects your application in Play mode. To profile the Editor: Open the Profiler ( Window > Analysis > Profiler ) Select the Target Selection dropdown, next to Record Select Edit When Editor profiling is enabled...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7813b9e21a1b
unity_docs
animation
Explain 'Animate a GameObject' in Unity.
There are two methods you can use to animate GameObjects in the Animation window: Record mode and Preview mode . Record mode (Also referred to as auto-key mode) In record mode, Unity automatically adds keyframes at the location of the playback head when you move, rotate, or modify an animatable property on your animate...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a4917caee1a
unity_docs
scripting
What is `AI.NavMeshAgent.CompleteOffMeshLink` in Unity? Explain its purpose and usage.
NavMeshAgent.CompleteOffMeshLink Declaration public void CompleteOffMeshLink (); Description Completes the movement on the current OffMeshLink. The agent will move to the closest valid navmesh position on the other end of the current OffMeshLink. CompleteOffMeshLink has no effect unless the agent is on an OffMe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08b61978faff
unity_docs
performance
What are the parameters of `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.SetNestedContainer` in Unity?
Description Sets the nested container flag on an AtomicSafetyHandle. The job system doesn't support nested containers which are containers where the individual elements inside the container are themselves containers), because it can't configure the AtomicSafetyHandle instances stored inside the container's elements in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ddf22de4eab4
unity_docs
physics
What is `UnityEngine.ClothModule` in Unity? Explain its purpose and usage.
UnityEngine.ClothModule Description The Cloth module implements cloth physics simulation through the Cloth component. Classes Class Description Cloth The Cloth class provides an interface to cloth simulation physics. Structs Struct Description ClothSkinningCoefficient The ClothSkinningCoefficient struct is u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfbf77675782
unity_docs
scripting
Show me a Unity C# example demonstrating `PrimitiveType.Cube`.
PrimitiveType.Cube Description A cube primitive. Additional resources: GameObject.CreatePrimitive . ```csharp using UnityEngine; using System.Collections;// Creates a cube primitivepublic class ExampleClass : MonoBehaviour { void Start() { GameObject cube = GameObject.CreatePrimitive(PrimitiveType.Cube); } } ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_261434fea0f4
unity_docs
editor
What is `EditorApplication.LockReloadAssemblies` in Unity? Explain its purpose and usage.
EditorApplication.LockReloadAssemblies Declaration public static void LockReloadAssemblies (); Description Prevents loading of assemblies when it is inconvenient. For example during drag operations you might want to prevent assembly reloading to not lose state during the drag. Each LockReloadAssemblies must be ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5367236460b
unity_docs
ui
What is `UIElements.IDebugPanelChangeReceiver.OnVisualElementChange` in Unity? Explain its purpose and usage.
IDebugPanelChangeReceiver.OnVisualElementChange Declaration public void OnVisualElementChange ( UIElements.VisualElement element , UIElements.VersionChangeType changeType ); Parameters Parameter Description element The element that changed. changeType A string that contains the comma-separated value o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5d7e3832e08
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector4.Index_operator`.
Vector4.this[int] public float this[int] ; Description Access the x, y, z, w components using [0], [1], [2], [3] respectively. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Vector4 p = new Vector4(); p[3] = 5; // the same as p.w = 5 } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bc64aa7067f7
unity_docs
rendering
What is `Unity.Android.Gradle.Bundle` in Unity? Explain its purpose and usage.
Bundle class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the bundle element in a gradle file. For more information about the element, see Android's documentation: Bundle Properties Property Description Abi The C# definition of the abi property....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5bee4f891c3f
unity_docs
rendering
What is `Search.SearchItem` in Unity? Explain its purpose and usage.
SearchItem class in UnityEditor.Search Description Search items are returned by the search provider to show to the user after a search is performed. The search item holds all the data that is used to sort and present the search results. Some members of a SearchItem can be specified in an asynchronous callback (see...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4736231cf586
unity_docs
rendering
In Unity's 'Global cache', what is 'Location' and how does it work?
By default, Unity stores the global cache in a root directory that depends on the operating system (and the user account type on Windows): Operating system Default root directory Example Windows (user account) %LOCALAPPDATA%\Unity\cache\upm C:\Users\yourname\AppData\Local\Unity\cache\upm Windows ( system user account )...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74aabe632b10
unity_docs
physics
What is `LowLevelPhysics.BoxGeometry.ctor` in Unity? Explain its purpose and usage.
BoxGeometry Constructor Declaration public BoxGeometry ( Vector3 halfExtents ); Parameters Parameter Description halfExtents The distance from the center of the box to the edge on each axis. Description Create a box shape with the provided parameters.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0b688cb191a
unity_docs
rendering
What is `TextureFormat.RGB24` in Unity? Explain its purpose and usage.
TextureFormat.RGB24 Description Three channel (RGB) texture format, 8-bits unsigned integer per channel. Note that there are almost no GPUs that support this format natively, so at texture load time it is converted into an RGBA32 format. RGB24 is thus only useful for some game build size savings. Additional resou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e46b54b85292
unity_docs
xr
Explain 'Create an XR project' in Unity.
To create an XR project, you can use an XR template from the Unity Hub or start with a non-XR project. Create a new XR project Start from a non-XR project ## XR templates The quickest way to create a new XR project is with one of the XR templates in the Unity Hub. Projects you create with these templates are already ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a705852fff5
unity_docs
scripting
What is `Animations.TransformSceneHandle` in Unity? Explain its purpose and usage.
TransformSceneHandle struct in UnityEngine.Animations / Implemented in: UnityEngine.AnimationModule Description Handle to read position, rotation and scale of an object in the Scene. TransformSceneHandle are read-only. A TransformSceneHandle is a safe handle on a TransformAccess . The Animator used to create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_497aea9caeba
unity_docs
ui
In Unity's 'Allow or deny Vulkan API usage', what is 'Default minimum specifications' and how does it work?
Unity automatically applies the following minimum specifications for Vulkan API support based on the GPU vendor. Devices that don’t meet these specifications don’t use Vulkan API when running Unity applications and fall back to the default graphics API configured in the Player settings. You can override these using the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e023903798d
unity_docs
rendering
What is `ParticleSystemForceField.vectorField` in Unity? Explain its purpose and usage.
ParticleSystemForceField.vectorField public Texture3D vectorField ; Description Apply forces to particles within the volume of the Force Field, by using a 3D texture containing vector field data. Additional resources: ParticleSystemForceField .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c031d69f6ac2
unity_docs
scripting
Give me an overview of the `CameraEditor` class in Unity.
CameraEditor class in UnityEditor / Inherits from: Editor Description Unity Camera Editor. This is the Unity Camera Editor class. If you want to write your own custom Camera Editor you can extend this class and override the OnInspectorGUI function. Public Methods Method Description OnDestroy See ScriptableO...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a7e0466ab810
unity_docs
math
Show me a Unity code example for 'Debug generated C++ code'.
fields structures follow the format of <ClassName>_t#number_StaticFields , where the first part of the structure name is the same as the declaring type. Example static fields structures: StringBuilder_t26_StaticFields Thing_t24_StaticFields ## C++ comments Preceding each class or method definition, C++ automatically ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15d8ac717231
unity_docs
animation
What is `Animations.AnimatorController.FindStateMachineBehaviourContext` in Unity? Explain its purpose and usage.
AnimatorController.FindStateMachineBehaviourContext Declaration public static StateMachineBehaviourContext[] FindStateMachineBehaviourContext ( StateMachineBehaviour behaviour ); Parameters Parameter Description behaviour The State Machine Behaviour to get context for. Returns StateMachineBehaviourContext...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_036aa19188bf
unity_docs
scripting
What is `Scripting.GarbageCollector.GCMode` in Unity? Explain its purpose and usage.
GarbageCollector.GCMode public static Scripting.GarbageCollector.Mode GCMode ; Description Set and get global garbage collector operation mode. Setting the global operation mode changes the garbage collector behaviour for the entire application. Not supported on the WebGL platform and in the Editor. It is rec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_553d7f468861
unity_docs
scripting
What is `RenderingLayerMask.value` in Unity? Explain its purpose and usage.
RenderingLayerMask.value public uint value ; Description Converts a layer mask value to an integer value. ```csharp using UnityEngine; using UnityEngine.Rendering;public class Example : MonoBehaviour { // Set the rendering layer mask for MeshRenderer RenderingLayerMask mask = 1 << 10; void Start() { GetComp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5034a816f3c5
unity_docs
input
In Unity's 'Hash128Field', what is 'Inherited UXML attributes' and how does it work?
This element inherits the following attributes from its base class: Name Type Description auto-correction boolean Determines if the touch screen keyboard auto correction is turned on or off. binding-path string Path of the target property to be bound. emoji-fallback-support boolean Specifies the order in which the syst...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3273b0f2e2a2
unity_docs
scripting
What is `Time.fixedUnscaledTimeAsDouble` in Unity? Explain its purpose and usage.
Time.fixedUnscaledTimeAsDouble public static double fixedUnscaledTimeAsDouble ; Description The double precision timeScale-independent time at the beginning of the last FixedUpdate (Read Only). This is the time in seconds since the start of the game. Returns the same value if called multiple times in a single...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_89ee67fc3ff1
unity_docs
scripting
What is `ModelImporter.indexFormat` in Unity? Explain its purpose and usage.
ModelImporter.indexFormat public ModelImporterIndexFormat indexFormat ; Description Format of the imported mesh index buffer data. Index buffer can either be 16 bit (supports up to 65535 vertices in a mesh), or 32 bit (supports up to 4 billion vertices). Default behavior is ModelImporterIndexFormat.Auto , wh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ac6f9db5d041
unity_docs
physics
In Unity's 'Prepare a Mesh for Mesh colliders', what is 'Allow read and write access to a Mesh' and how does it work?
There are particular configurations and optimizations that require a Mesh to be read/write enabled. For details on what “read/write” means in this context, refer to documentation on the Mesh API property Mesh.isReadable . A Mesh must be read/write enabled if any of the following circumstances are true: The attached Mes...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cee119af9e44
unity_docs
scripting
What is `Unity.Collections.Allocator.Temp` in Unity? Explain its purpose and usage.
Allocator.Temp Description Use a temporary allocation. The fastest allocation. Use it for allocations with a lifespan of one frame or fewer. You can't use Temp to pass allocations to NativeContainer instances stored in a job's member field.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdcb9c131dbc
unity_docs
xr
What is `Networking.UnityWebRequest.certificateHandler` in Unity? Explain its purpose and usage.
UnityWebRequest.certificateHandler public Networking.CertificateHandler certificateHandler ; Description Holds a reference to a CertificateHandler object, which manages certificate validation for this UnityWebRequest . Setting this property to null makes the platform use the default certificate validatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_807d78e344fc
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.FrameDataView.GetCounterValueAsInt`.
FrameDataView.GetCounterValueAsInt Declaration public int GetCounterValueAsInt (int markerId ); Parameters Parameter Description markerId Marker identifier. Returns int Returns the counter value as int . Description Gets the last value of a counter marker in the frame as an int data type'. Use to r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31044b685df7
unity_docs
scripting
What is `ScriptableWizard` in Unity? Explain its purpose and usage.
ScriptableWizard class in UnityEditor / Inherits from: EditorWindow Description Derive from this class to create an editor wizard. Editor wizards are typically opened using a menu item. ```csharp // Creates a simple wizard that lets you create a Light GameObject // or if the user clicks in "Apply", it will set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a72137654db4
unity_docs
scripting
What are the parameters of `Rendering.CommandBuffer.RequestAsyncReadbackIntoNativeSlice` in Unity?
Description Adds an asynchonous GPU readback request command to the command buffer. Additional resources: AsyncGPUReadback.RequestIntoNativeSlice . Declaration public void RequestAsyncReadbackIntoNativeSlice (ref NativeSlice<T> output , ComputeBuffer src , Action<AsyncGPUReadbackRequest> callback ); Declaration public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b3b10f5f46a
unity_docs
rendering
What is `RenderTextureFormat.DefaultHDR` in Unity? Explain its purpose and usage.
RenderTextureFormat.DefaultHDR Description Default HDR color render texture format: will be chosen accordingly to Frame Buffer format and Platform. Typically this is ARGBHalf format. Additional resources: RenderTexture class, SystemInfo.SupportsRenderTextureFormat .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1d4abf2781db
unity_docs
editor
Show me a Unity C# example demonstrating `FileUtil.CopyFileOrDirectoryFollowSymlinks`.
ctoryFollowSymlinks (string source , string dest ); Description Copies the file or directory. Copies from the path suppplied as the source parameter to the path supplied as the dest parameter. In presence of symbolic links (macOS only), the actual files to which symbolic links point to are copied, not the sy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c86986c7213f
unity_docs
rendering
What is `ParticleSystemRenderer.mesh` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.mesh public Mesh mesh ; Description The Mesh that the particle uses instead of a billboarded Texture. Additional resources: ParticleSystemRenderer.renderMode . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b93d5e67c512
unity_docs
editor
Show me a Unity C# example demonstrating `GenericMenu.AddItem`.
UIContent to add as a menu item. on Specifies whether to show the item is currently activated (i.e. a tick next to the item in the menu). func The function to call when the menu item is selected. userData The data to pass to the function called when the item is selected. Description Add an item to the menu. Ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbb80aa8a0b0
unity_docs
rendering
What is `ReflectionProbe.defaultTexture` in Unity? Explain its purpose and usage.
ReflectionProbe.defaultTexture public static Texture defaultTexture ; Description The surface texture of the default reflection probe that captures the environment contribution. Read only. Unity maps this texture onto the surface of the default reflection probe. When you generate lighting for a scene, Unity ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd4171da9a9e
unity_docs
xr
What is `Android.Permission.HasUserAuthorizedPermission` in Unity? Explain its purpose and usage.
Permission.HasUserAuthorizedPermission Declaration public static bool HasUserAuthorizedPermission (string permission ); Parameters Parameter Description permission A string representing the permission to request. For permissions which Unity has not predefined, you can provide Android's in-built permission st...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_01efe16bd374
unity_docs
rendering
Show me a Unity C# example demonstrating `ShaderKeywordFilter.ApplyRulesIfTagsEqualAttribute`.
ts from: ShaderKeywordFilter.TagConstraintAttribute Description Enable or disable shader keyword filter attributes based on shader tags. If you use this attribute, Unity enables filter attributes if the shader compilation context contains matching tags. The following example builds only variants including the F...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_72ceebc3961a
unity_docs
ui
In Unity's 'Migrate from uGUI to UI Toolkit', what is 'UI hierarchy' and how does it work?
Both uGUI and UI Toolkit build and maintain the UI inside a hierarchy tree structure. In uGUI, all elements in this hierarchy are visible as individual GameObjects in the hierarchy view panel. In UI Toolkit, visual elements are organized into a visual tree . The visual tree isn’t visible in the panel. To view and debug...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f9308607f4e
unity_docs
scripting
What is `Pool.ObjectPool_1.ctor` in Unity? Explain its purpose and usage.
ObjectPool<T0> Constructor Declaration public ObjectPool<T0> (Func<T> createFunc , Action<T> actionOnGet , Action<T> actionOnRelease , Action<T> actionOnDestroy , bool collectionCheck , int defaultCapacity , int maxSize ); Parameters Parameter Description createFunc Method called to create a new instan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d54623dc32ec
unity_docs
scripting
What is `HandleUtility.AddControl` in Unity? Explain its purpose and usage.
HandleUtility.AddControl Declaration public static void AddControl (int controlId , float distance ); Parameters Parameter Description controlId The ID that is recorded as the nearest control if the mouse cursor is near the handle. distance The distance from the mouse cursor to the handle. Description R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c1828d1ff4b5_doc_0
github
scripting
What does `BeforeParallelUpdate` do in this Unity script? Explain its purpose and signature.
This method is called before parallel update, you can put in Unity's api inside this method Signature: ```csharp protected virtual void BeforeParallelUpdate(int frameIndex) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_edcec3017baf
unity_docs
physics
Give me an overview of the `Handheld` class in Unity.
Handheld class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Interface into functionality unique to handheld devices. This class is available on Android and iOS. Static Methods Method Description GetActivityIndicatorStyle Gets the current activity indicator style. PlayFullScreenMovie ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0b513d4cc2d4
unity_docs
scripting
In Unity's 'Bind to nested properties', what is 'Create the UXML and the Inspector UI' and how does it work?
Create a UXML file with a BindableElement. Set the BindableElement’s binding-path to the health property and set each child element’s binding-path of the BindableElement to the armor and life properties of health . In the bind-nested-properties folder, create a folder named Editor . In the Editor folder, create a USS f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dd14f7a745f7
unity_docs
rendering
Explain 'Types of mesh data compression' in Unity.
Unity provides two ways of compressing meshes. They work differently, and affect different aspects of performance: Vertex Compression is a setting that affects every mesh in your project. It allows you to use lower precision data formats in your meshes. This reduces the size of mesh data in memory, slightly reduces fil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5d2292ad126f
unity_docs
scripting
Explain 'Place Light components' in Unity.
Lights are easy to use in Unity - you need to create a light of the desired type (for example, from the menu GameObject > Light > Point Light ) and place it where you want it in the scene. If you enable scene view lighting (the “lightbulb” button on the toolbar) then you can see a preview of how the lighting will look ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_13ad935efefc
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.QueryEngine_1.GetOperator`.
op ); Parameters Parameter Description op The operator identifier. Returns QueryFilterOperator The global QueryFilterOperator . Description Get a custom operator added on the QueryEngine . This method returns a QueryFilterOperator that was added on the QueryEngine . If the operator does not exist, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7aed191a64b3
unity_docs
rendering
What are the parameters of `TextureMipmapLimitGroups.CreateGroup` in Unity?
Description (Editor Only) Attempts to create a texture mipmap limit group with the indicated groupName . This operation fails and throws an exception if groupName is null/empty or a texture mipmap limit group with the same name already exists. If no other group with the same name exists, Unity creates the new group acr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b2efb5729c3
unity_docs
scripting
What is `AI.NavMeshAgent.CalculatePath` in Unity? Explain its purpose and usage.
NavMeshAgent.CalculatePath Declaration public bool CalculatePath ( Vector3 targetPosition , AI.NavMeshPath path ); Parameters Parameter Description targetPosition The final position of the path requested. path The resulting path. Returns bool True if either a complete or partial path is found. Fals...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c2deb781120
unity_docs
physics
What is `IMGUI.Controls.JointAngularLimitHandle.yMotion` in Unity? Explain its purpose and usage.
JointAngularLimitHandle.yMotion public ConfigurableJointMotion yMotion ; Description Returns or specifies how angular motion is limited about the y-axis. Defaults to ConfigurableJointMotion.Limited . Additional resources: yMin , yMax , yRange .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_597b1f9be293
unity_docs
scripting
What is `Unity.Profiling.IgnoredByDeepProfilerAttribute` in Unity? Explain its purpose and usage.
IgnoredByDeepProfilerAttribute class in Unity.Profiling / Implemented in: UnityEngine.CoreModule Description IgnoredByDeepProfilerAttribute prevents Unity Profiler from capturing method calls. When you capture data with Unity Profiler in Deep Profiler mode, Unity registers entrance and exit to each function. In...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fba25c7f9f40
unity_docs
scripting
What is `Experimental.GraphView.Scope.ContainsElement` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Scope.ContainsElement Declaration public bool ContainsElement ( Experimental.GraphView.GraphElement element ); Parameters Parameter Description element The element. Returns bool Returns true if the Scope contains the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f590dbc7546b
unity_docs
scripting
What are the parameters of `SceneManagement.SceneManager.LoadScene` in Unity?
Description Loads the Scene by its name or index in Build Settings. Note: In most cases, to avoid pauses or performance hiccups while loading, you should use the asynchronous version of this command which is: LoadSceneAsync . When using SceneManager.LoadScene , the scene loads in the next frame, that is it does...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_54b9118012b8
unity_docs
scripting
What is `Rendering.GraphicsSettings.Subscribe` in Unity? Explain its purpose and usage.
GraphicsSettings.Subscribe Declaration public static void Subscribe (Action<TChild,string> callback ); Parameters Parameter Description callback The callback to execute when a property in the asset is modified. Description Subscribe to changes of properties in the IRenderPipelineGraphicsSettings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_152bb5f960df
unity_docs
networking
What is `Networking.PlayerConnection.IConnectionState.connectionName` in Unity? Explain its purpose and usage.
IConnectionState.connectionName public string connectionName ; Description The name of the connected target. This could be "Editor", a URL, an IP address or the broadcasted name of the connected target.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e5bd5eab2c7c
unity_docs
scripting
What is `AndroidJNI.SetShortField` in Unity? Explain its purpose and usage.
AndroidJNI.SetShortField Declaration public static void SetShortField (IntPtr obj , IntPtr fieldID , short val ); Description Sets the value of an instance field of the specified 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_ae9381640a92
unity_docs
rendering
What is `Canvas.vertexColorAlwaysGammaSpace` in Unity? Explain its purpose and usage.
Canvas.vertexColorAlwaysGammaSpace public bool vertexColorAlwaysGammaSpace ; Description Should the Canvas vertex color always be in gamma space before passing to the UI shaders in linear color space work flow. Keeping the Canvas vertex color in gamma space will allow the gamma to linear conversion to happen i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae6e1455e3ac
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.LightsModule.intensityMultiplier`.
ParticleSystem.LightsModule.intensityMultiplier public float intensityMultiplier ; Description Intensity multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall intensity multiplier. Additional resources: ParticleSystem.LightsModule.intensit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_981240e5e5ff
unity_docs
rendering
Show me a Unity code example for 'Tessellation Surface Shader examples in the Built-In Render Pipeline'.
of creating Shader objects in URP, see Shader Graph . No For a streamlined way of creating Shader objects in HDRP, see Shader Graph . No Yes ## Fixed amount of tessellation If your model’s faces are roughly the same size on screen, add a fixed amount of tesselation to the Mesh (the same tessellation level over the wh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8481db27fb41
unity_docs
rendering
In Unity's 'Create a Profiler module detail panel', what is 'Connect a custom module details panel to a Profiler module' and how does it work?
To display a custom module details panel, you need to instantiate the module details panel controller when you select your Profiler module. To do this, override CreateDetailsViewController to create and draw a new module details panel controller. Unity then invokes this method when it displays your module’s details pan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0e563557b39
unity_docs
scripting
What is `Vector3.left` in Unity? Explain its purpose and usage.
Vector3.left public static Vector3 left ; Description Shorthand for writing Vector3(-1, 0, 0) . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { transform.position += Vector3.left * Time.deltaTime; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9d76af25360
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.B8G8R8_SRGB` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.B8G8R8_SRGB Description A three-component, 24-bit unsigned normalized format that has an 8-bit B component stored with sRGB nonlinear encoding in byte 0, an 8-bit G component stored with sRGB nonlinear encoding in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3666b8d93e8d
unity_docs
physics
Give me an overview of the `CircleCollider2D` class in Unity.
CircleCollider2D class in UnityEngine / Inherits from: Collider2D / Implemented in: UnityEngine.Physics2DModule Description Collider for 2D physics representing an circle. Additional resources: BoxCollider class, PolygonCollider2D class. Properties Property Description radius Radius of the circle. In...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_92cbce0d817d
unity_docs
rendering
What is `Rendering.BatchDrawCommandProceduralIndirect.lightmapIndex` in Unity? Explain its purpose and usage.
BatchDrawCommandProceduralIndirect.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.
local_sr_e48cf07d4e7e
unity_docs
math
What is `AndroidJNI.CallIntMethodUnsafe` in Unity? Explain its purpose and usage.
AndroidJNI.CallIntMethodUnsafe Declaration public static int CallIntMethodUnsafe (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 Specif...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86eb3d0ce7fb
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.UnlockIsValid`.
Provider.UnlockIsValid Declaration public static bool UnlockIsValid ( VersionControl.AssetList assets ); Declaration public static bool UnlockIsValid ( VersionControl.Asset asset ); Parameters Parameter Description assets The asset list to test. asset The asset to test. Description Returns true if...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_04906daeb98f
unity_docs
editor
In Unity's 'Use C# code to enable optimization settings', what is 'Create a C# script to optimize your Web build' and how does it work?
To use code to enable most of these optimizations at once in your Unity project settings : Create an Assets/Editor folder if you don’t already have one. Create an empty C# script in the Editor folder. Paste the following code into the script: ```csharp using UnityEditor; using UnityEditor.Build; using UnityEngine; pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e3a9b9741fbd
unity_docs
rendering
In Unity's 'RenderingLayerMaskField', what is 'Inherited UXML attributes' and how does it work?
This element inherits the following attributes from its base class: Name Type Description binding-path string Path of the target property to be bound. focusable boolean If false, this prevents the element from being focused. The element can only be focused if its canGrabFocus property is true. label string The string r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bdfa664421e7
unity_docs
physics
Explain 'Character Joint component reference' in Unity.
A Character Joint is an extended ball-socket joint that allows you to limit the joint on each axis. Character Joints are useful for ragdoll effects. For information about setting up a ragdoll, refer to Ragdoll Wizard . Note: For Character Joints made with the Ragdoll wizard, the twist axis corresponds with the limb’s l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78b7207a124e
unity_docs
rendering
What is `Material.SetVector` in Unity? Explain its purpose and usage.
Material.SetVector Declaration public void SetVector (string name , Vector4 value ); Declaration public void SetVector (int nameID , Vector4 value ); Parameters Parameter Description nameID Property name ID, use Shader.PropertyToID to get it. name Property name, e.g. "_WaveAndDistance". valu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63e32e8a449a
unity_docs
input
What is `XR.TrackingOriginModeFlags.Device` in Unity? Explain its purpose and usage.
TrackingOriginModeFlags.Device Description XRInputSubsystem tracks all InputDevice s in reference to the first known location of a specific InputDevice when set to TrackingOriginModeFlags.Device. For mobile AR applications, the InputDevice is the mobile device the application is running on. For head-mounted d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15bdf0f2037f
unity_docs
xr
What is `XR.XRSettings.useOcclusionMesh` in Unity? Explain its purpose and usage.
XRSettings.useOcclusionMesh public static bool useOcclusionMesh ; Description Specifies whether or not the occlusion mesh should be used when rendering. Enabled by default. The occlusion mesh prevents GPU work from happening on portions of the eye texture that won't be visible in the HMD. Disabling this will le...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f70667e6279a
unity_docs
scripting
Give me an overview of the `ColorUsageAttribute` class in Unity.
ColorUsageAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Attribute used to configure the usage of the ColorField and Color Picker for a color. Use this attribute on a Color to configure the Color Field and Color Picker to show/hide the al...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b842e2c9aac
unity_docs
rendering
What is `Experimental.Rendering.GraphicsStateCollection.qualityLevelName` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsStateCollection.qualityLevelName public string qualityLevelName ; Description The quality level the collection is intended to be used with. Different quality levels will result in a different set of shader variants a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb1365a36cdd
unity_docs
animation
What is `Animations.TransformStreamHandle.GetLocalPosition` in Unity? Explain its purpose and usage.
TransformStreamHandle.GetLocalPosition Declaration public Vector3 GetLocalPosition ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that holds the animated values. Returns Vector3 The position of the transform relative to the parent. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2329a7941cc1_doc_13
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The states that we are currently modeling.If you want to add more states, add them here! Signature: ```csharp public enum ControllerStates ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_d896fa0493f7
unity_docs
animation
What is `Animator.pivotWeight` in Unity? Explain its purpose and usage.
Animator.pivotWeight public float pivotWeight ; Description Gets the pivot weight. The pivot is the most stable point between the left and right foot of the avatar. For a value of 0, the left foot is the most stable point. For a value of 1, the right foot is the most stable point.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1ea24b235ff
unity_docs
rendering
What is `LightingSettings.prioritizeView` in Unity? Explain its purpose and usage.
LightingSettings.prioritizeView public bool prioritizeView ; Description Whether the Progressive Lightmapper prioritizes baking visible texels within the frustum of the Scene view. (Editor only). When this is set to true , the Progressive Lightmapper prioritizes baking texels within the Scene View. When set t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a732f1afc984
unity_docs
scripting
Give me an overview of the `RangeInt` class in Unity.
RangeInt struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Describes an integer range. Properties Property Description end The end index of the range (not inclusive). length The length of the range. start The starting index of the range, where 0 is the first position, 1 is the seco...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f8820ded7901
unity_docs
ui
In Unity's 'Conditionally including assemblies', what is 'Defining symbols based on Unity and project package versions' and how does it work?
If you need to compile different code in an assembly according to whether a project uses specific versions of Unity or of a package, you can add entries to the Version Defines list. This list specifies rules for when a symbol should be defined. For version numbers, you can specify a logical expression that evaluates to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_47213de6f458
unity_docs
rendering
Explain 'GPU texture format fundamentals' in Unity.
The Unity Editor can import texture source files with a number of common formats, such as JPEG or PNG. However, GPUs do not use these formats at runtime; instead, they use different, specialized formats that are optimized for memory usage and speed of sampling operations. You can configure the texture compression forma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a8d7187aeb8d
unity_docs
rendering
Explain 'Self-Illuminated Shader Family' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces these shaders . The Self-Illuminated shaders will emit light only onto themselves based on an attached alpha channel. They do not require any Lights to shine on them to emit this light. Any vertex lights or pixel lights will simply add more light on top of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b5dd46de5f20
unity_docs
scripting
Explain 'Supported data types for Java/Kotlin and C# code' in Unity.
When accessing Java/Kotlin code from a C# script in Unity, you can pass certain data types. The following table outlines the data types you can send between Java/Kotlin code and C# script, and the ones that you cannot. Supported data types Unsupported data types byte, int, short, long float, double bool char string Arr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8eb0e7c19477
unity_docs
scripting
What is `VersionControl.Asset.metaPath` in Unity? Explain its purpose and usage.
Asset.metaPath public string metaPath ; Description Gets the path of the meta file for this Asset relative to the project root. If the Asset is a meta file, the path to the meta file is returned.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08ba129dc83e
unity_docs
editor
What is `AssetDatabase.GetAssetBundleDependencies` in Unity? Explain its purpose and usage.
AssetDatabase.GetAssetBundleDependencies Declaration public static string[] GetAssetBundleDependencies (string assetBundleName , bool recursive ); Parameters Parameter Description assetBundleName The name of the AssetBundle for which dependencies are required. recursive If false, returns only AssetBundles...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d83afe393209
unity_docs
physics
Show me a Unity C# example demonstrating `Physics.IgnoreLayerCollision`.
layer1 and any collider in layer2 . Note that IgnoreLayerCollision will reset the trigger state of affected colliders, so you might receive OnTriggerExit and OnTriggerEnter messages in response to calling this. You can set the default values for your project for any layer combinations in the Physics inspector. Addit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eec89157a384
unity_docs
ui
What is `Overlays.OverlayCanvas.Add` in Unity? Explain its purpose and usage.
OverlayCanvas.Add(Overlay,bool) Parameters Parameter Description overlay The Overlay to add. show True to display the Overlay immediately, false to add without displaying. Description Add an Overlay to this canvas. Added Overlays will be displayed in the associated EditorWindow until they are removed. In...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_231d24c1c807
unity_docs
scripting
What is `GizmoInfo` in Unity? Explain its purpose and usage.
GizmoInfo class in UnityEditor Description GizmoInfo contains information about the Scene View gizmo and icon for a component type. See GizmoUtility for an example. Properties Property Description gizmoEnabled Toggle gizmo visibility in the Scene View for components of this type. hasGizmo Defines whether a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fbce0c054532
unity_docs
rendering
What are the parameters of `GL.Begin` in Unity?
Description Begin drawing 3D primitives. In OpenGL this matches glBegin ; on other graphics APIs the same functionality is emulated. Between GL.Begin and GL.End it is valid to call GL.Vertex , GL.Color , GL.TexCoord and other immediate mode drawing functions. You should be careful about culling when drawing primitives ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c7aa0a804b0
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.NativeContainerIsReadOnlyAttribute` in Unity? Explain its purpose and usage.
NativeContainerIsReadOnlyAttribute class in Unity.Collections.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Marks a native container type as read only. Use this attribute when defining a read-only interface to the data stored in a native container. Providing a read-only interface to a nat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc9bf8160279
unity_docs
editor
What are the parameters of `EditorGUI.Foldout` in Unity?
Returns bool The foldout state selected by the user. If true, you should render sub-objects. Description Makes a label with a foldout arrow to the left of it. This is useful for creating tree or folder like structures where child objects are only shown if the parent is folded out. Foldout in an Editor Window. ```csharp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6453d80d60f8
unity_docs
scripting
Explain 'Creating scripts' in Unity.
Scripts allow you to customize and extend the capabilities of your applicaton with C# code. With scripts that derive from Unity’s built-in MonoBehaviour class you can create your own custom Components to control the behavior of GameObjects . With scripts that derive from ScriptableObject you can store large amounts of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_18518dc69896
unity_docs
scripting
Explain 'Per-pixel and per-vertex lights in the Built-In Render Pipeline' in Unity.
If you use the default Forward rendering path , Unity sets each realtime Light component as one of the following types: Per-pixel light Per-vertex light Spherical harmonics (SH) per-vertex light For more information, refer to Per-pixel and per-vertex lights . The Built-In Render Pipeline renders each GameObject once fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3d3af0fa8f1e
unity_docs
rendering
In Unity's 'Navigating the Profiler window', what is 'Customizing metric views' and how does it work?
Hide or display metrics in a module’s chart, or reorder the metrics, to identify the causes of spikes, or make more prominent metrics visible. To customize the metrics displayed in a chart: Click the colored square next to the metric’s label in its module to hide or display the metric. Click and drag the handle icon (═...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_475bed44ccbb
unity_docs
editor
What is `VersionControl.IIconOverlayExtension` in Unity? Explain its purpose and usage.
IIconOverlayExtension interface in UnityEditor.VersionControl Description Version control system extension that allows drawing icon overlays. Additional resources: VersionControlObject . Public Methods Method Description DrawOverlay Draws icon overlay.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.