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_2c0543408dbc
unity_docs
physics
What is `Physics.gravity` in Unity? Explain its purpose and usage.
Physics.gravity public static Vector3 gravity ; Description The gravity applied to all rigid bodies in the Scene. Gravity can be turned off for an individual rigidbody using its useGravity property. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ab70f77ef62
unity_docs
editor
What is `DialogOptOutDecisionType.ForThisMachine` in Unity? Explain its purpose and usage.
DialogOptOutDecisionType.ForThisMachine Description The decision to opt out of seeing a dialog box for all time on the user's current machine. This decision type is stored in EditorPrefs . If you want to the let the user change their decision, you can add this to the Project Settings with a SettingsProvider .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4089ed08ad2
unity_docs
animation
Give me an overview of the `MatchTargetWeightMask` class in Unity.
MatchTargetWeightMask struct in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Use this struct to specify the position and rotation weight mask for Animator.MatchTarget . Properties Property Description positionXYZWeight Position XYZ weight. rotationWeight Rotation weight. Construct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_026f95205f5c
unity_docs
editor
What is `BuildTarget` in Unity? Explain its purpose and usage.
BuildTarget enumeration Description Target build platform. Additional resources: BuildPipeline.BuildPlayer , EditorUserBuildSettings.activeBuildTarget , BuildAssetBundlesParameters.targetPlatform . Properties Property Description StandaloneOSX Build a macOS standalone. StandaloneWindows Build a Windows 32-...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc298bc55bd6
unity_docs
animation
What is `Animations.GameObjectRecorder.ctor` in Unity? Explain its purpose and usage.
GameObjectRecorder Constructor Declaration public GameObjectRecorder ( GameObject root ); Parameters Parameter Description root The root GameObject for the animated hierarchy. Description Create a new GameObjectRecorder. Additional resources: GameObjectRecorder .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63f05be701df
unity_docs
scripting
What is `UIElements.ToolbarMenu.Variant` in Unity? Explain its purpose and usage.
Variant enumeration Description Display styles for the menu. Properties Property Description Default Display the menu using the default style. Popup Display the menu using the popup style.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_754d9fcd52dd
unity_docs
scripting
What is `UIElements.Vector2Field` in Unity? Explain its purpose and usage.
Vector2Field class in UnityEngine.UIElements / Inherits from: UIElements.BaseCompositeField_3 / Implemented in: UnityEngine.UIElementsModule Description A Vector2 field. For more information, refer to UXML element Vector2Field . Static Properties Property Description inputUssClassName USS class nam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7b825c19a31
unity_docs
physics
What is `UIElements.ContextualMenuManager` in Unity? Explain its purpose and usage.
ContextualMenuManager class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Use this class to display a contextual menu. Public Methods Method Description DisplayMenu Displays the contextual menu. DisplayMenuIfEventMatches Checks if the event triggers the displa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4b39449d2e6b
unity_docs
rendering
In Unity's 'Shader code blocks in ShaderLab reference', what is 'HLSL' and how does it work?
HLSLPROGRAM and HLSLINCLUDE are compatible with all render pipelines . Signature Function HLSLPROGRAM [source code for shader programs] ENDHLSL Creates a shader program block. Unity adds the HLSL shader program to the pass that includes this shader program block. HLSLINCLUDE [code that you want to share] ENDHLSL Create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09a28d70cff5
unity_docs
scripting
What is `ProvisioningProfileType` in Unity? Explain its purpose and usage.
ProvisioningProfileType enumeration Description The type of the iOS provisioning profile if manual signing is used. Properties Property Description Automatic The provisioning profile type will be determined automatically when building the Xcode project. Development Development provisioning profiles are used to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5202935d7d5
unity_docs
scripting
What is `ParticleSystem.MainModule.startLifetime` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.startLifetime public ParticleSystem.MinMaxCurve startLifetime ; Description The total lifetime in seconds that each new particle has. This value is set on the particle when the Particle System creates it. Assign a value of float.PositiveInfinity to particles to prevent the Particle ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27e7cc1755e0
unity_docs
rendering
What is `LightmapParameters.modellingTolerance` in Unity? Explain its purpose and usage.
LightmapParameters.modellingTolerance public float modellingTolerance ; Description Maximum size of gaps that can be ignored for GI (multiplier on pixel size). Can be used to alleviate issues when objects are close together and the gap between the objects should not be used in the calculation of GI. In some ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e660999ba5d5
unity_docs
scripting
In Unity's 'ColorField', what is 'Create a ColorField' and how does it work?
You can create a ColorField with UI Builder, UXML, or C#. The following C# example creates a ColorField with a default color and enables the alpha channel, eye dropper, and treats the color as an HDR value. ```csharp using UnityEditor.UIElements; ... var colorField = new ColorField(); colorField.value = new Color(0.5f,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1e3e7ae00019
github
scripting
Write a Unity C# UI script for On Restart Unity Event
```csharp using System; using RMC.Mini.View; using RMC.Mini.Samples.RollABall.WithMini.Mini.Controller.Commands; using UnityEngine; using UnityEngine.Events; using UnityEngine.UI; namespace RMC.Mini.Samples.RollABall.WithMini.Mini.View { // Class Attributes ---------------------------------- public class OnRe...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_c0d83a065396
unity_docs
rendering
What is `Shader.GetPropertyTextureDimension` in Unity? Explain its purpose and usage.
Shader.GetPropertyTextureDimension Declaration public Rendering.TextureDimension GetPropertyTextureDimension (int propertyIndex ); Parameters Parameter Description propertyIndex The index of the shader property. Description Returns the TextureDimension of a Texture shader property at the specified i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_216e88fd4526
unity_docs
scripting
What is `SystemInfo.supportsInstancing` in Unity? Explain its purpose and usage.
SystemInfo.supportsInstancing public static bool supportsInstancing ; Description Is GPU draw call instancing supported? (Read Only) Graphics.RenderMeshInstanced , Graphics.DrawProcedural , Graphics.DrawProceduralIndirect , Graphics.DrawMeshInstanced , and their CommandBuffer counterparts use instancing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_710eefde6fe2
unity_docs
editor
Show me a Unity C# example demonstrating `ObjectChangeEvents.changesPublished`.
. The changes appear in the stream in the order that they were applied. Events in the stream do not necessarily map one-to-one to user interactions since user interactions may consist of multiple changes. Note that the stream passed to your callback is a temporary object owned by the engine. Do not Dispose it. Make a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_62b6a2c21675
unity_docs
editor
Explain 'Customize the build pipeline' in Unity.
Unity’s build pipeline transforms your project into Player builds for target platforms. You can customize this process using custom scripts , callbacks, and command-line tools to automate builds and integrate with your development workflow. Topic Description Introduction to customizing the build pipeline Understand Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c614b95471d9
unity_docs
math
What is `SceneManagement.Stage.FindComponentsOfType` in Unity? Explain its purpose and usage.
Stage.FindComponentsOfType Declaration public T[] FindComponentsOfType (); Returns T[] An array of objects found matching the type specified. Description Returns a list of all active loaded objects of the given type.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f97ef4b5af5
unity_docs
scripting
What are the parameters of `GUI.PasswordField` in Unity?
Returns string The edited password. Description Make a text field where the user can enter a password. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public string passwordToEdit = "My Password"; void OnGUI() { passwordToEdit = GUI.PasswordField(new ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e0e010df726
unity_docs
rendering
What is `LightmapsModeLegacy` in Unity? Explain its purpose and usage.
LightmapsModeLegacy enumeration Description Single, dual, or directional lightmaps rendering mode, used only in GIWorkflowMode.Legacy Additional resources: LightmapSettings.lightmapsModeLegacy. Properties Property Description Single Single, traditional lightmap rendering mode. Dual Dual lightmap rendering mod...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a10d01c188ab
unity_docs
ui
What is `UIElements.CollectionViewController.UnbindItem` in Unity? Explain its purpose and usage.
CollectionViewController.UnbindItem Declaration protected void UnbindItem ( UIElements.VisualElement element , int index ); Parameters Parameter Description element The element from that row, created by MakeItem(). index The item index. Description Unbinds a row to an item index.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2b19be9cced
unity_docs
editor
What is `EditorGUILayout.EnumPopup` in Unity? Explain its purpose and usage.
EditorGUILayout.EnumPopup Declaration public static Enum EnumPopup (Enum selected , params GUILayoutOption[] options ); Declaration public static Enum EnumPopup (Enum selected , GUIStyle style , params GUILayoutOption[] options ); Declaration public static Enum EnumPopup (string label , Enum selecte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3934058e35e4
unity_docs
rendering
What is `PlayerSettings.SetPlatformIcons` in Unity? Explain its purpose and usage.
PlayerSettings.SetPlatformIcons Declaration public static void SetPlatformIcons ( Build.NamedBuildTarget buildTarget , PlatformIconKind kind , PlatformIcon[] icons ); Obsolete Use SetPlatformIcons(NamedBuildTarget , PlatformIconKind) instead. Declaration public static void SetPlatformIcons ( BuildTarge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_549eb958fa75
unity_docs
physics
Give me an overview of the `CapsuleCollider2D` class in Unity.
CapsuleCollider2D class in UnityEngine / Inherits from: Collider2D / Implemented in: UnityEngine.Physics2DModule Description A capsule-shaped primitive collider. Capsules are boxes with a semi-circle at each end. Properties Property Description direction The direction that the capsule sides can extend. s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6031b0de26f
unity_docs
performance
Show me a Unity C# example demonstrating `Unity.Profiling.LowLevel.Unsafe.ProfilerUnsafeUtility.BeginSample`.
ing a piece of code marked with a custom name that the markerPtr handle has defined. Code marked with BeginSample and EndSample shows up in the Profiler hierarchy. Always use EndSample to close a started section of the instrumented code. Note: Both BeginSample and EndSample are thread safe and can be used...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0e74ae1ec291
unity_docs
scripting
Explain 'Deploy a QNX project' in Unity.
Unity uses EGL handled by SDL2, which requires SDL to dynamically load libEGL and libGLESv2 from the graphics.conf file . Unity does not parse the conf file but instead uses environment variables to locate these libraries. ## Setup Use the following instructions to deploy QNX. Use one of the methods to locate the gra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efae23aa1ea9
unity_docs
ui
Show me a Unity C# example demonstrating `EditorPrefs.SetFloat`.
EditorPrefs.SetFloat Declaration public static void SetFloat (string key , float value ); Parameters Parameter Description key Name of key to write float into. value Float value to write into the storage. Description Sets the float value of the preference identified by key . ```csharp // Simple script...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d580c03076b5_doc_11
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The resolution in pixels for which the intrinsics are defined Signature: ```csharp public Vector2Int Resolution; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_e758b4cf7b5f
unity_docs
scripting
What is `Build.Content.DependencyType` in Unity? Explain its purpose and usage.
DependencyType enumeration Description Dependency calculation flags to control what is returned, and how it operates. Properties Property Description RecursiveOperation Depencency calculation is recursive. For each new valid reference discovered during calculation, the dependencies of those references will also...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_709c56daceca
unity_docs
scripting
What are the parameters of `Color.Lerp` in Unity?
Description Linearly interpolates between colors a and b by t . t is clamped between 0 and 1. When t is 0 returns a . When t is 1 returns b . The code sample sets the color of a GameObject's material to a value between white and black, based on the amount of time that has elapsed. ```csharp using UnityEngine;public cla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e39e6d00a111
unity_docs
rendering
What is `MaterialEditor.GetPropertyHeight` in Unity? Explain its purpose and usage.
MaterialEditor.GetPropertyHeight Declaration public float GetPropertyHeight ( MaterialProperty prop ); Declaration public float GetPropertyHeight ( MaterialProperty prop , string label ); Description Calculate height needed for the property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39786ecf54bd
unity_docs
physics
What is `Collider2D.ClosestPoint` in Unity? Explain its purpose and usage.
Collider2D.ClosestPoint Declaration public Vector2 ClosestPoint ( Vector2 position ); Parameters Parameter Description position The position from which to find the closest point on this Collider. Returns Vector2 A point on the perimeter of this Collider that is closest to the specified position . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_71fefb44fda9
unity_docs
scripting
What is `Search.SearchContext.AddSearchQueryError` in Unity? Explain its purpose and usage.
SearchContext.AddSearchQueryError Declaration public void AddSearchQueryError ( Search.SearchQueryError error ); Parameters Parameter Description error The new error. Description Adds a new query error on this context.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_79231afaffd6
unity_docs
editor
Show me a Unity code example for 'Enable Unity Editor installation by standard users (Windows)'.
les: Use straight double quotes ("") and not curly quotes (“”). Separate key:value pairs with a comma. Check the syntax of the JSON with a validator. You can use the Get-Content and ConvertFrom-Json cmdlets in the PowerShell, as shown in this example . ## Procedure To enable standard users to install the Unity Editor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_06424502e3b7
unity_docs
scripting
In Unity's 'Selector precedence', what is 'Precedence for selectors in different style sheets' and how does it work?
When an element matches multiple selectors in different style sheets, Unity determines precedence according to the following factors in this order: The type of style sheet: Selectors from user-defined style sheets takes precedence over selectors from default Unity style sheets. Selector specificity: If both selectors a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c4811b8e9db
unity_docs
math
What is `BoundsInt.min` in Unity? Explain its purpose and usage.
BoundsInt.min public Vector3Int min ; Description The minimal point of the box. This point is contained in the box. Sets the minimum value of the BoundsInt . If you enter a minimum value that is greater than the current maximum value, then the entered value becomes the new maximum value and the previous max...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_625ff46ad84c
unity_docs
performance
What is `Unity.Jobs.LowLevel.Unsafe.JobsUtility.ThreadIndex` in Unity? Explain its purpose and usage.
JobsUtility.ThreadIndex public static int ThreadIndex ; Description Gets the index for the current thread when executing a job, otherwise 0. When multiple threads are executing jobs, no two threads have the same index. The range of this property is [0, Unity.Jobs.LowLevel.Unsafe.JobsUtility.ThreadIndexCount) ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9d9ce4fad1df
unity_docs
rendering
Show me a Unity code example for 'Example of a shader that supports GPU Instancing in the Built-In Render Pipeline'.
The following example demonstrates how to create an instanced vertex and fragment shader with different color values for each instance. Unlike the surface shader , when you create the vertex and fragment shader you must use UNITY_SETUP_INSTANCE_ID to manually set up an instance ID. ``` Shader "Custom/SimplestInstancedS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e75f7dbdf84a
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.alignment`.
Particles can face the Camera in two ways: 1) Aligned to the Camera plane, so that all particles are aligned with the same facing direction. 2) Aligned individually to face the eye position, which can be more convincing for particles that approach the Camera in close proximity or for VR environments. Unaligned particl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a1819c5eaea
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormatUtility.IsXRFormat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.IsXRFormat Declaration public static bool IsXRFormat ( Experimental.Rendering.GraphicsFormat format ); Description Returns true if the format is an extended range format. With extended range format, th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_730ab425e13e
unity_docs
scripting
What is `Build.Content.ObjectIdentifier.ToInstanceID` in Unity? Explain its purpose and usage.
ObjectIdentifier.ToInstanceID Declaration public static int ToInstanceID ( Build.Content.ObjectIdentifier objectId ); Description Tries to return the InstanceID that represents this ObjectIdentifier. Returns 0 if the ObjectIdentifier is invalid.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ff9d16b6ca11
unity_docs
animation
What is `Tilemaps.Tilemap.RefreshTile` in Unity? Explain its purpose and usage.
Tilemap.RefreshTile Declaration public void RefreshTile ( Vector3Int position ); Parameters Parameter Description position Position of the Tile on the Tilemap . Description Refreshes a Tile at the given XYZ coordinates of a cell in the Tilemap . The Tilemap will retrieve the rendering data, anima...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2db7057912f
unity_docs
rendering
What is `ParticleSystem.MainModule.startSize3D` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.startSize3D public bool startSize3D ; Description A flag to enable specifying particle size individually for each axis. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : Mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_905adbaf036a
unity_docs
scripting
What is `Rendering.StencilState.compareFunctionBack` in Unity? Explain its purpose and usage.
StencilState.compareFunctionBack public Rendering.CompareFunction compareFunctionBack ; Description The function used to compare the reference value to the current contents of the buffer for back-facing geometry.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cbe7efd9763
unity_docs
rendering
Show me a Unity C# example demonstrating `Material.shaderKeywords`.
ords determine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and how they interact, see Using shader keywords with C# scripts . Note: It is more efficient to use enabledKeywords , which returns an array of LocalKeyword structs. This example p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_99e08a8c3913
unity_docs
ui
What is `Canvas.rootCanvas` in Unity? Explain its purpose and usage.
Canvas.rootCanvas public Canvas rootCanvas ; Description Returns the Canvas closest to root, by checking through each parent and returning the last canvas found. If no other canvas is found then the canvas will return itself. Additional resources: isRootCanvas .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b4724621e102
unity_docs
xr
Show me a Unity code example for 'Scoped registry authentication'.
entication token from npm. This is an example of a typical procedure, but you need to follow the process recommended by the specific package registry provider for your scoped registry. To fetch an authentication token from npm: Install npm locally on your computer. From a terminal, enter the following command to log in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8b71b361934
unity_docs
scripting
What is `AI.NavMeshObstacle.shape` in Unity? Explain its purpose and usage.
NavMeshObstacle.shape public AI.NavMeshObstacleShape shape ; Description The shape of the obstacle. Set or get the shape of the NavMeshObstacle . A newly created NavMeshObstacle has a shape of the NavMeshObstacleShape.Box shape. The obstacle shapes are listed in NavMeshObstacleShape . Note: Wh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f420675ded42
unity_docs
scripting
What is `UIElements.Experimental.StyleValues.marginTop` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StyleValues.marginTop public float marginTop ; Description Space reserved for the top edge of the margin during the layout phase.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1bb32dfa946
unity_docs
math
What is `Quaternion.SetLookRotation` in Unity? Explain its purpose and usage.
Quaternion.SetLookRotation Declaration public void SetLookRotation ( Vector3 view , Vector3 up = Vector3.up); Parameters Parameter Description view The direction to look in. up The vector that defines in which direction up is. Description Creates a rotation with the specified forward and upwards...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b07c1559fea
unity_docs
scripting
What is `Progress.SetDescription` in Unity? Explain its purpose and usage.
Progress.SetDescription Declaration public static void SetDescription (int id , string description ); Parameters Parameter Description id The progress indicator's unique ID. description The progress indicator's new description. Description Sets the progress indicator's description. To clear the descript...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2f519d3930b
unity_docs
editor
What are the parameters of `SceneManagement.EditorSceneManager.CloseScene` in Unity?
Returns bool Returns true if the Scene is closed/removed. Description Close the Scene. If removeScene flag is true, the closed Scene will also be removed from EditorSceneManager. ```csharp using UnityEngine; using System.Collections; using UnityEditor.SceneManagement; using UnityEngine.SceneManagement;public class Exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f1a89416039
unity_docs
scripting
Show me a Unity C# example demonstrating `DecoratorDrawer`.
andle any necessary cleanup operations. The example below comes in two scripts. The first script defines the an example attribute called "ColorSpacer", and then defines a DecoratorDrawer which determines how it should be drawn in the inspector. The second script is an example MonoBehaviour which uses the ColorSpacer at...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_083139adcb16
unity_docs
editor
What are the parameters of `EditorGUILayout.Vector2Field` in Unity?
Returns Vector2 The value entered by the user. Description Make an X & Y field for entering a Vector2 . Measure the distance between 2 points. ```csharp using UnityEditor; using UnityEngine;public class EditorGUILayoutVector2Field : UnityEditor.EditorWindow { float distance = 0f; Vector3 p1; Vector3 p2; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b2b1c5ad01c
unity_docs
editor
What is `Search.IQuerySource` in Unity? Explain its purpose and usage.
IQuerySource interface in UnityEditor.Search Description The source of block is usually the query builder for a given search view. Properties Property Description context Search context of the query source. searchView Search view in which the query block is displayed. Public Methods Method Description App...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85873e21166b
unity_docs
editor
Show me a Unity C# example demonstrating `TooltipAttribute`.
vides information to the user about the range of values for the health variable. The suggested range is provided in the TooltipAttribute string. Note: Unity will only use Tooltips from Fields when displaying them in the Editor. You can add Tooltips to other areas, such as classes, structs, and properties to work wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00611fde8664
unity_docs
audio
What is `AudioSource.GamepadSpeakerSupportsOutputType` in Unity? Explain its purpose and usage.
AudioSource.GamepadSpeakerSupportsOutputType Declaration public static bool GamepadSpeakerSupportsOutputType ( GamepadSpeakerOutputType outputType ); Parameters Parameter Description outputType The desired output type. Returns bool Returns true if the gamepad supports the specified audio output type. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21bbd290017b
unity_docs
rendering
What is `ParticleSystemJobs.IJobParticleSystem.Execute` in Unity? Explain its purpose and usage.
IJobParticleSystem.Execute Declaration public void Execute ( ParticleSystemJobs.ParticleSystemJobData jobData ); Parameters Parameter Description jobData Contains the particle properties. Description Implement this method to access and modify particle properties. You can use the following script to attra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09e17065cbfb
unity_docs
scripting
What is `IMGUI.Controls.JointAngularLimitHandle` in Unity? Explain its purpose and usage.
JointAngularLimitHandle class in UnityEditor.IMGUI.Controls Description A class for a compound handle to edit multiaxial angular motion limits in the Scene view. JointAngularLimitHandle in the Scene View. The shapes rendered by the DrawHandle method assume that angular limits are applied first along the x-axis,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c8237f845bd
unity_docs
animation
What is `Animations.AnimatorControllerLayer.SetOverrideBehaviours` in Unity? Explain its purpose and usage.
AnimatorControllerLayer.SetOverrideBehaviours(AnimatorState,StateMachineBehaviourInfo[]) Parameters Parameter Description state The state which we want to set the behaviour list. behaviours The behaviour list that will be set. Description Sets the override behaviour list for the state on the given layer.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_549d9e43ac75
unity_docs
performance
Show me a Unity C# example demonstrating `Profiling.Profiler.enableAllocationCallstacks`.
ription Enables the recording of callstacks for managed allocations. When enabled, the Unity player saves callstack for each managed allocation sample which is known as GC.Alloc . You can see the callstacks in the Timeline View or in the Object Details pane of the Hierarchy View when selecting the GC.Alloc sample....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e36cfa9b8ce0
unity_docs
math
What is `Quaternion.LerpUnclamped` in Unity? Explain its purpose and usage.
Quaternion.LerpUnclamped Declaration public static Quaternion LerpUnclamped ( Quaternion a , Quaternion b , float t ); Description Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped. This is faster than Slerp but looks worse if the rotations a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cd90e438122c
unity_docs
rendering
Explain 'Introduction to Realtime Global Illumination using Enlighten' in Unity.
Unity uses a middleware solution called Enlighten for Realtime Global Illumination . By default, Realtime Lights contribute only direct lighting to a Scene . If you enable Realtime Global Illumination (Enlighten Realtime Global Illumination) in your Scene, Realtime Lights also contribute indirect lighting to a Scene. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62a96d8c6808
unity_docs
rendering
What is `LightingSettings.filteringAtrousPositionSigmaIndirect` in Unity? Explain its purpose and usage.
LightingSettings.filteringAtrousPositionSigmaIndirect public float filteringAtrousPositionSigmaIndirect ; Description Specifies the radius the Progressive Lightmapper uses to filter the ambient occlusion component in the lightmap when you use the Gaussian filter. (Editor only). The value range is 0 through 5. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69704c7abb6e
unity_docs
physics
What is `Texture.streamingTextureForceLoadAll` in Unity? Explain its purpose and usage.
Texture.streamingTextureForceLoadAll public static bool streamingTextureForceLoadAll ; Description Force streaming Textures to load all mipmap levels. Additional resources: QualitySettings.streamingMipmapsActive , StreamingController , TextureImporter.streamingMipmaps .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86c9c6ede5e2
unity_docs
physics
What are the parameters of `Physics.RaycastAll` in Unity?
Returns RaycastHit[] An array of RaycastHit objects. Note that the order of the results is undefined. Description Casts a ray through the Scene and returns all hits. Note that order of the results is undefined. Additional resources: Raycast . ```csharp using UnityEngine; using System.Collections;public class ExampleCla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fd38e82e152e
unity_docs
xr
In Unity's 'Define exceptions on your web proxy', what is 'Endpoints that Unity applications access' and how does it work?
The simplest solution is to add entire domains for the following resources in your exception list: unity.com unity3d.com plasticscm.com google.com googleapis.com microsoft.com aka.ms If you want to selectively control which subdomains users can access, add items from the following table to your exception list. Notes : ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9a2b92c814eb
unity_docs
editor
In Unity's 'Create a Publisher Portal product draft', what is 'Product and package naming' and how does it work?
When a product has only one package, the product namespace and package namespace are the same, which follows the naming convention of com.publisher.product . When a product has multiple packages, the product namespace follows the naming convention of com.publisher.product (for example com.unity.assetstore ), and the pa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88c1375aa056
unity_docs
editor
What is `SettingsProvider.OnActivate` in Unity? Explain its purpose and usage.
SettingsProvider.OnActivate Declaration public void OnActivate (string searchContext , UIElements.VisualElement rootElement ); Parameters Parameter Description searchContext Search context in the search box on the Settings window. rootElement Root of the UIElements tree. If you add to this root, the Set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8218bfe60c3a
unity_docs
performance
In Unity's 'Introduction to NativeContainer', what is 'Read and write access' and how does it work?
By default, when a job has access to a NativeContainer instance, it has both read and write access. This configuration can slow performance. This is because the job system doesn’t allow you to schedule a job that has write access to a NativeContainer instance at the same time as another job that’s writing to it. Howeve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c0a2b25b602
unity_docs
scripting
What is `Windows.Speech.DictationRecognizer.DictationComplete` in Unity? Explain its purpose and usage.
DictationRecognizer.DictationComplete Parameters Parameter Description value Delegate that is to be invoked on DictationComplete event. Description Event that is triggered when the recognizer session completes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55aba7b9db60
unity_docs
ui
Show me a Unity C# example demonstrating `AssetImporters.AssetImporterEditor.OnApplyRevertGUI`.
AssetImporterEditor.OnApplyRevertGUI Declaration protected bool OnApplyRevertGUI (); Returns bool Returns true if the new settings were successfully applied. Description Process the 'Apply' and 'Revert' buttons. This is called by ApplyRevertGUI to place and handle the 'Apply' and 'Revert' buttons. ```csh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64029f11fc4a
unity_docs
input
What is `UIElements.Experimental.PointerMoveLinkTagEvent` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PointerMoveLinkTagEvent class in UnityEngine.UIElements.Experimental / Inherits from: UIElements.PointerEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description This event is sent when a pointer changes state...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c466819b6907
unity_docs
rendering
In Unity's 'Web template variables', what is 'Conditional directives' and how does it work?
Conditional directives #if , #else , and #endif control whether Unity includes a specific portion of the preprocessed file in the output file, or discards it for the current build. Code that starts with an #if directive and ends with an #endif directive is called a conditional group. Conditional groups can also include...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ddde9a31ee3
unity_docs
editor
Show me a Unity C# example demonstrating `GenericMenu.AddSeparator`.
GenericMenu.AddSeparator Declaration public void AddSeparator (string path ); Parameters Parameter Description path The path to the submenu, if adding a separator to a submenu. When adding a separator to the top level of a menu, use an empty string as the path. Description Add a seperator item to the menu....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9bb8806e86b
unity_docs
physics
What is `IMGUI.Controls.MultiColumnHeader.SetSorting` in Unity? Explain its purpose and usage.
MultiColumnHeader.SetSorting Declaration public void SetSorting (int columnIndex , bool sortAscending ); Parameters Parameter Description columnIndex Column to sort. sortAscending Sorting order for the column specified. Description Sets the primary sorting column and its sorting order. This function se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70c622c33eec
unity_docs
scripting
What is `CreateAssetObjectEventArgs.scene` in Unity? Explain its purpose and usage.
CreateAssetObjectEventArgs.scene public SceneManagement.Scene scene ; Description The Scene that contains the new asset. This is usually an invalid scene unless the asset is explicitly associated in a scene (e.g. RenderSettings ).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ad52b1aecd78
unity_docs
rendering
In Unity's 'Respond to events with custom controls', what is 'Implement behaviors' and how does it work?
In general, to implement behaviors from your element, use a HandleEventBubbleUp method override. Given that the BubbleUp is the default propagation phase for callbacks, you can move any code from callbacks to a HandleEventBubbleUp method without any concerns about changing the timing of code execution. The benefits of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d1ca5be2ba8
unity_docs
scripting
What is `IMGUI.Controls.TreeView.columnIndexForTreeFoldouts` in Unity? Explain its purpose and usage.
TreeView.columnIndexForTreeFoldouts protected int columnIndexForTreeFoldouts ; Description When using a MultiColumnHeader this value should be set to the column index in which the foldout arrows should appear. The default value is 0, so by default the foldouts are shown in the first column.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_faf1b80781fd
unity_docs
scripting
What is `EditorGUI.InspectorTitlebar` in Unity? Explain its purpose and usage.
EditorGUI.InspectorTitlebar Declaration public static bool InspectorTitlebar ( Rect position , bool foldout , Object targetObj , bool expandable ); Declaration public static bool InspectorTitlebar ( Rect position , bool foldout , Object[] targetObjs , bool expandable ); Parameters Parameter Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_abf22c303e40
unity_docs
scripting
Explain 'Frame Debugger' in Unity.
Resources for using the Frame Debugger to check and debug rendering issues. Page Description Introduction to the Frame Debugger Understand how the Frame Debugger lets you step through each rendering event and display the graphical state of the scene . Debug a frame Open the Frame Debugger window and debug a frame. Chec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e48739db6f66
unity_docs
input
What is `UIElements.TextInputBaseField_1.ValueToString` in Unity? Explain its purpose and usage.
TextInputBaseField<T0>.ValueToString Declaration protected string ValueToString (TValueType value ); Parameters Parameter Description value The value to convert. Returns string A string representing the value. Description Converts a value of the specified generic type from the subclass to a string r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4ab636d9b8c
unity_docs
scripting
What is `UIElements.TabView.activeTabChanged` in Unity? Explain its purpose and usage.
TabView.activeTabChanged Description Called when the active tab is reassigned. This callback receives two tabs, the first being the previously selected tab and the second being the newly selected tab.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7f002249523
unity_docs
editor
What is `EditorApplication.playModeStateChanged` in Unity? Explain its purpose and usage.
EditorApplication.playModeStateChanged Description Event that is raised whenever the Editor's play mode state changes. Add an event handler to this event to receive a notification that the play mode state has changed, as well as information about the state it has changed into. The following example script logs the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e9f8559126e
unity_docs
scripting
What are the parameters of `Handles.DrawDottedLine` in Unity?
Description Draw a dotted line from p1 to p2 . Draw Line in the Scene View. ```csharp // Draw lines to the connected game objects that a script has. // If the target object doesn't have any game objects attached // then it draws a line from the object to (0, 0, 0).using UnityEditor; using UnityEngine;[CustomEditor(type...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a269f30910c
unity_docs
scripting
Show me a Unity C# example demonstrating `AndroidJavaRunnable`.
xy object is created every time it is passed as an argument to Java. This means that passing a variable of AndroidJavaRunnable type to Java multiple times results in a new Java object each time with different hash code values. It also means that calling equals() on the Java object created as a representation of an An...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d64b5090b61f
unity_docs
scripting
In Unity's 'Define a data source for runtime binding', what is 'Integrate versioning and change tracking' and how does it work?
To enhance performance, you can integrate versioning and change tracking into a binding data source. By default, the binding system continuously polls the data source and updates the UI on every modification, without knowing if anything has actually changed since the last update. While this approach is convenient for s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d8069e479358
unity_docs
physics
What is `EditorApplication.updateMainWindowTitle` in Unity? Explain its purpose and usage.
EditorApplication.updateMainWindowTitle Parameters Parameter Description value Title description. Description Register a custom callback to specify how the Unity Editor title can be generated. Unity will trigger this callback when a new scene is loaded , when Unity starts or when EditorApplication.UpdateMainWi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_754869ac4e25
unity_docs
rendering
What is `Rendering.RayTracingGeometryInstanceConfig.vertexBuffer` in Unity? Explain its purpose and usage.
RayTracingGeometryInstanceConfig.vertexBuffer public GraphicsBuffer vertexBuffer ; Description The vertex buffer that Unity uses to define the ray tracing geometry instance. Define the vertex buffer format by specifiying a list of vertex attributes in vertexAttributes array. You can use a common vertex buf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14d7cb79d4bc
unity_docs
scripting
What is `PrefabUtility.GetPrefabAssetPathOfNearestInstanceRoot` in Unity? Explain its purpose and usage.
PrefabUtility.GetPrefabAssetPathOfNearestInstanceRoot Declaration public static string GetPrefabAssetPathOfNearestInstanceRoot ( Object instanceComponentOrGameObject ); Parameters Parameter Description instanceComponentOrGameObject An object in the Prefab instance to get the asset path of. Returns string ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9cf077f68ad2
unity_docs
editor
What is `EditorUserBuildSettings.overrideMaxTextureSize` in Unity? Explain its purpose and usage.
EditorUserBuildSettings.overrideMaxTextureSize public static int overrideMaxTextureSize ; Description The override for the maximum texture size when importing assets. This setting lets you override the maximum texture size in pixels that Unity uses when it imports assets. This is mostly useful for local develop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_07d0798190fa
unity_docs
rendering
In Unity's 'Model tab Import Settings reference', what is 'Geometry' and how does it work?
Property Description Keep Quads Prevents Unity from converting polygons that have four vertices to triangles. For example, if you’re using tessellation shaders , you might want to enable this option because tessellating quads can be more efficient than tessellating polygons. Unity can import any type of polygon (triang...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c860e9be5e52
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.ScriptableRenderContext.ExecuteCommandBuffer`.
ns during ScriptableRenderContext.Submit . Make sure that you call ExecuteCommandBuffer before other ScriptableRenderContext methods (such as DrawRenderers, DrawShadows) if your draw calls depend on a state of the pipeline that you specify in a CommandBuffer. The code sample below illustrates a case when commands are ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_034c058966a7
unity_docs
scripting
Show me a Unity C# example demonstrating `Unity.Collections.LowLevel.Unsafe.NativeContainerSupportsDeallocateOnJobCompletionAttribute`.
omatically deallocate with DeallocateOnJobCompletionAttribute . The native container must contain the following fields: A field named m_Buffer of a pointer type. A field named m_AllocatorLabel of type Allocator . The job system uses the values of these fields to automatically deallocate the native container ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_dcd025c62afb_doc_15
github
scripting
What does `UpdateDictionaryErrors` do in this Unity script? Explain its purpose and signature.
Draws error feedback relating to the ordered dictionary. Signature: ```csharp protected virtual void UpdateDictionaryErrors() ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_7bd9e1209e5d
unity_docs
animation
Give me an overview of the `ClipAnimationInfoCurve` class in Unity.
ClipAnimationInfoCurve struct in UnityEditor Description Stores a curve and its name that will be used to create additional curves during the import process. Properties Property Description curve The animation curve. name The name of the animation curve.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_985db26cf573
unity_docs
editor
What is `EditorGUILayout.TextArea` in Unity? Explain its purpose and usage.
EditorGUILayout.TextArea Declaration public static string TextArea (string text , params GUILayoutOption[] options ); Declaration public static string TextArea (string text , GUIStyle style , params GUILayoutOption[] options ); Parameters Parameter Description text The text to edit. style Optiona...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5bd12142be49
unity_docs
math
What is `Vector4.ToString` in Unity? Explain its purpose and usage.
Vector4.ToString Declaration public string ToString (); Declaration public string ToString (string format ); Declaration public string ToString (string format , IFormatProvider formatProvider ); Parameters Parameter Description format A numeric format string. formatProvider An object that specifi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cd236cf981fe
unity_docs
editor
Explain 'AI Navigation' in Unity.
com.unity.ai.navigation ## Description The AI Navigation package contains high-level components that allow you to use navmeshes to incorporate navigation and pathfinding in your game. With this package installed you can build and use navmeshes at runtime and at edit time, create dynamic obstacles, and use links to al...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.