id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_e9f07839c6fc
unity_docs
rendering
Show me a Unity code example for 'RenderingLayerMaskField'.
A RenderingLayerMaskField is an Editor-only control that lets users select one or more rendering layers from a list of available HDRP or URP rendering layers defined in Tags and Layers . ## Create a RenderingLayerMaskField You can create a RenderingLayerMaskField with UXML and C#. The following C# example creates a R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80244adad9da
unity_docs
rendering
Show me a Unity C# example demonstrating `RaycastHit.textureCoord2`.
dary uv texture coordinate at the impact point. This can be used for 3D texture painting or drawing bullet marks. If the collider is not a mesh collider, Vector2.zero will be returned. If the mesh contains no secondary uv set, the uv of the primary uv set will be returned. This property can be accessed off the main ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8648c83f9d7
unity_docs
scripting
What is `Search.SearchService.GetProvider` in Unity? Explain its purpose and usage.
SearchService.GetProvider Declaration public static Search.SearchProvider GetProvider (string providerId ); Parameters Parameter Description providerId Unique ID of the search provider. Returns SearchProvider The matching search provider. Description Returns the data of a search provider given its ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ab49545fff91
unity_docs
rendering
In Unity's 'Shader compilation', what is 'Different shader compilers' and how does it work?
Different platforms use different shader compilers for shader program compilation as follows: Platforms that use DirectX use Microsoft’s FXC HLSL compiler. Platforms that use OpenGL (Core & ES) use Microsoft’s FXC HLSL compiler, followed by bytecode translation into GLSL using HLSLcc . Platforms that use Metal use Micr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f6330bdc54ba
unity_docs
rendering
Give me an overview of the `ParticleSystemSubEmitterProperties` class in Unity.
ParticleSystemSubEmitterProperties enumeration Description The properties of sub-emitter particles. Properties Property Description InheritNothing When spawning new particles, do not inherit any properties from the parent particles. InheritEverything When spawning new particles, inherit all available propertie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_743796fd2eb3
unity_docs
scripting
Show me a Unity C# example demonstrating `Event.command`.
Event.command public bool command ; Description Is Command/Windows key held down? (Read Only) On Windows, this returns true if any Windows key is held down. On Mac, this returns true if any Command key is held down. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints Command/Windows...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eadff24b923e
unity_docs
scripting
What is `ParticleSystem.MainModule.cullingMode` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.cullingMode public ParticleSystemCullingMode cullingMode ; Description Configure whether the Particle System will still be simulated each frame, when it is offscreen. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class Exampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c33bcfe7da99
unity_docs
scripting
What is `ModelImporterNormalCalculationMode` in Unity? Explain its purpose and usage.
ModelImporterNormalCalculationMode enumeration Description Normal generation options for ModelImporter . Normals can be calculated by Unity using several methods. They can be either unweighted or weighted by area, angle or both. Additional resources: ModelImporter.normalImportMode. Properties Property Descript...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1e7a7df805f
unity_docs
physics
Give me an overview of the `PlatformEffector2D` class in Unity.
PlatformEffector2D class in UnityEngine / Inherits from: Effector2D / Implemented in: UnityEngine.Physics2DModule Description Applies "platform" behaviour such as one-way collisions etc. When the source Collider2D is a trigger, the effector will apply forces whenever the target Collider2D overlaps the sou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc72c237b0b0
unity_docs
physics
What is `Tilemaps.TilemapCollider2D.useDelaunayMesh` in Unity? Explain its purpose and usage.
TilemapCollider2D.useDelaunayMesh public bool useDelaunayMesh ; Description When the value is true, the Collider uses an additional Delaunay triangulation step to produce the Collider mesh. When the value is false, this additional step does not occur. Using Delaunay triangulation can reduce the number of shapes...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d4f34c255cc
unity_docs
xr
What is `PackageManager.Requests.AddRequest` in Unity? Explain its purpose and usage.
AddRequest class in UnityEditor.PackageManager.Requests / Inherits from: PackageManager.Requests.Request_1 Description Represents an asynchronous request to add a package to the project. The PackageManager Client class returns an AddRequest instance when you call the Client.Add method to add a package to y...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9df4a525cdbe
unity_docs
scripting
Show me a Unity C# example demonstrating `Gizmos.DrawSphere`.
Gizmos.DrawSphere Declaration public static void DrawSphere ( Vector3 center , float radius ); Description Draws a solid sphere with center and radius . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void OnDrawGizmosSelected() { // Draw a yellow spher...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_269e52edf6cc
unity_docs
xr
What are the parameters of `Networking.UnityWebRequest.EscapeURL` in Unity?
Description Escapes characters in a string to ensure they are URL-friendly. Certain text characters have special meanings when present in URLs. If you need to include those characters in URL parameters then you must represent them with escape sequences. It is recommended that you use this function on any text supplied ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ef6af4cb6a1a
unity_docs
rendering
In Unity's '2D Pixel Perfect', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.2d.pixel-perfect@5.1 released 5.1.0, 5.1.1 com.unity.2d.pixel-perfect@5.0 released 5.0.3
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75f004643bd9
unity_docs
physics
What is `Collision.GetContact` in Unity? Explain its purpose and usage.
Collision.GetContact Declaration public ContactPoint GetContact (int index ); Parameters Parameter Description index The index of the contact to retrieve. Returns ContactPoint The contact at the specified index . Description Gets the contact point at the specified index . You can retrieve indivi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f58192302ba
unity_docs
input
What is `Input.imeCompositionMode` in Unity? Explain its purpose and usage.
Input.imeCompositionMode public static IMECompositionMode imeCompositionMode ; Description Controls enabling and disabling of IME input composition. Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the Inpu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55544e22c551
unity_docs
input
What is `Experimental.GraphView.EdgeConnector_1.OnMouseMove` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeConnector<T0>.OnMouseMove Declaration protected void OnMouseMove ( UIElements.MouseMoveEvent e ); Parameters Parameter Description e The event. Description Called on mouse move event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5070600d97e
unity_docs
rendering
Show me a Unity C# example demonstrating `SystemInfo.graphicsShaderLevel`.
ties (Shader Model 4.0 + tessellation) 45 Metal / OpenGL ES 3.1 capabilities (Shader Model 3.5 + compute shaders) 40 Shader Model 4.0 (DX10.0) 35 OpenGL ES 3.0 capabilities (Shader Model 3.0 + integers, texture arrays, instancing) 30 Shader Model 3.0 25 Shader Model 2.5 (DX11 feature level 9.3 feature se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b17b9dac76cd
unity_docs
rendering
Explain 'Draw and configure a trail behind a moving GameObject' in Unity.
To create a Trail Renderer : In the Unity menu bar, go to GameObject > Effects > Trail . Select the Trail Renderer GameObject , and parent it to the GameObject that you want it to generate a trail for. Use the Inspector window to configure the color, width, and other display settings of the trail. Preview the trail in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4d9165e30f2
unity_docs
rendering
What is `Playables.PlayableBehaviour.OnBehaviourPlay` in Unity? Explain its purpose and usage.
PlayableBehaviour.OnBehaviourPlay Declaration public void OnBehaviourPlay ( Playables.Playable playable , Playables.FrameData info ); Parameters Parameter Description playable The Playable that owns the current PlayableBehaviour. info A FrameData structure that contains information about the curren...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1617cd344efa
unity_docs
math
What is `Sprite.textureRectOffset` in Unity? Explain its purpose and usage.
Sprite.textureRectOffset public Vector2 textureRectOffset ; Description Gets the offset of the rectangle this Sprite uses on its Texture to the original Sprite bounds. If Sprite mesh type is FullRect, offset is zero.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21409601f2e4
unity_docs
animation
What is `Tilemaps.Tilemap.SetAnimationFrame` in Unity? Explain its purpose and usage.
Tilemap.SetAnimationFrame Declaration public void SetAnimationFrame ( Vector3Int position , int frame ); Parameters Parameter Description position The grid cell position. frame The animation frame to set to. Description Sets the current animation frame for a Tile at the given position. Use this to set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_065933d8ab27
unity_docs
editor
What is `Device.SystemInfo.SupportsVertexAttributeFormat` in Unity? Explain its purpose and usage.
SystemInfo.SupportsVertexAttributeFormat Declaration public static bool SupportsVertexAttributeFormat ( Rendering.VertexAttributeFormat format , int dimension ); Description This has the same functionality as SystemInfo.SupportsVertexAttributeFormat and also mimics platform-specific behavior in the Unity Ed...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6512d9185e0a
unity_docs
scripting
Show me a Unity C# example demonstrating `PenStatus.Inverted`.
PenStatus.Inverted Description The pen is inverted. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { Event m_Event = Event.current; if (m_Event.type == EventType.MouseDown) { if (m_Event.pointerType == PointerType.Pen) //Check if it's a pen event. { if (m_Event.penStatus == P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d2bee6deac0b
unity_docs
editor
Explain 'iOS environment setup' in Unity.
To create a Unity application for iOS, you first need to set up your Unity project to support iOS. This information is also relevant to the iPadOS, macOS, and tvOS platforms. To support iOS and other Apple operating systems, a Unity project requires: The iOS Build Support module. Xcode or Unity Build Automation . Befor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_592a9055e504
unity_docs
physics
Explain 'Perforce Integration' in Unity.
For more information on Perforce , visit www.perforce.com . ## Setting up Perforce Follow the setup process described in the Version Control documentation. See Perforce documentation if you encounter any problems. Note : If your Perforce workspace has multi-factor authentication enabled you will first need to login t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9238089d949
unity_docs
rendering
What is `ParticleSystem.LimitVelocityOverLifetimeModule.space` in Unity? Explain its purpose and usage.
ParticleSystem.LimitVelocityOverLifetimeModule.space public ParticleSystemSimulationSpace space ; Description Specifies if the velocity limits are in local space (rotated with the transform) or world space. Only applies when separateAxes is set to true. Additional resources: ParticleSystem.LimitVelocityOver...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_704a55eb78e6
unity_docs
scripting
What is `Terrain.activeTerrains` in Unity? Explain its purpose and usage.
Terrain.activeTerrains public static Terrain[] activeTerrains ; Description The active terrains in the Scene. This returns all the active terrains in the scene. A terrain is active when the component that represents it is enabled and the GameObject it is on is active.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_449443e44728
unity_docs
rendering
Explain 'Autodesk Interactive shader in the Built-In Render Pipeline' in Unity.
The Autodesk Interactive shader replicates the Interactive PBS shader available in Autodesk® 3DsMax and Autodesk® Maya, for you to use in Unity. When Unity imports an FBX exported from one of these softwares, it checks whether the FBX includes materials with Interactive PBS shaders. If it does, Unity imports these mate...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6a976aef270
unity_docs
rendering
What are the parameters of `ComputeShader.Dispatch` in Unity?
Description Execute a compute shader. This functions "runs" the compute shader, launching the indicated number of compute shader thread groups in the X, Y and Z dimensions. Within each work group, a number of shader invocations ("threads") are made. The work group size is specified in the compute sh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8ff4dfa63e3
unity_docs
scripting
What is `LowLevel.PlayerLoopSystem` in Unity? Explain its purpose and usage.
PlayerLoopSystem struct in UnityEngine.LowLevel / Implemented in: UnityEngine.CoreModule Description The representation of a single system that updates as part of the Player loop in Unity. A Player loop system represents an engine component or subsystem that updates on each iteration of the Player loop. Player...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20a399d66306
unity_docs
editor
What is `VersionControl.VersionControlObject.OnDeactivate` in Unity? Explain its purpose and usage.
VersionControlObject.OnDeactivate Declaration public void OnDeactivate (); Description Called when your version control system is deactivated. This happens when the user selects a different VCS from Version Control settings window, or if it gets deactivated from script, or when the Editor is closed. Unity calls...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_677cd8905dad
unity_docs
input
What is `Experimental.GraphView.EdgeDragHelper_1.HandleMouseDown` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeDragHelper<T0>.HandleMouseDown Declaration public bool HandleMouseDown ( UIElements.MouseDownEvent evt ); Parameters Parameter Description evt The event. Returns bool True if the drag has been started. False othe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29869fba7ec2
unity_docs
scripting
Show me a Unity C# example demonstrating `Logger.logEnabled`.
Logger.logEnabled public bool logEnabled ; Description To runtime toggle debug logging [ON/OFF]. ```csharp using UnityEngine; using System.Collections;public class MyGameClass : MonoBehaviour { private static ILogger logger = Debug.unityLogger; private static string kTAG = "MyGameTag"; void Start() { logger...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8e0e13b3cdd
unity_docs
rendering
What is `MaterialEditor.GetMaterialPropertyNames` in Unity? Explain its purpose and usage.
MaterialEditor.GetMaterialPropertyNames Declaration public static string[] GetMaterialPropertyNames (Object[] mats ); Parameters Parameter Description mats The selected materials. Returns string[] Returns the material property names. Description Gets the shader property names of the materials you pas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_738f9c3b8c9f
unity_docs
rendering
Explain 'GPU instancing shader reference for the Built-In Render Pipeline' in Unity.
This section contains information about shader additions that relate to GPU instancing. Addition Description #pragma multi_compile_instancing Generates instancing variants. This is required for fragment and vertex shaders . It is optional for Surface Shaders . #pragma instancing_options Specifies options that Unity use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00624e618117
unity_docs
ui
What is `Editor.CreateInspectorGUI` in Unity? Explain its purpose and usage.
Editor.CreateInspectorGUI Declaration public UIElements.VisualElement CreateInspectorGUI (); Description Implement this method to make a custom UIElements inspector. Inside this method, you can create your own custom UIElements inspector for a specific object class. Note: This function has to be overridden i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00870e720461
unity_docs
input
What is `UIElements.TextInputBaseField_1.StringToValue` in Unity? Explain its purpose and usage.
TextInputBaseField<T0>.StringToValue Declaration protected TValueType StringToValue (string str ); Parameters Parameter Description str The string to convert. Returns TValueType A value converted from the string. Description Converts a string to the value of the specified generic type from the subcl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee2692fc1407
unity_docs
scripting
Show me a Unity C# example demonstrating `JsonUtility.FromJsonOverwrite`.
l boxing and unboxing and is not recommended. Instead, use JsonUtility.FromJson for structs as follows: JsonUtility.FromJson<MyStruct>(json); If a field of the object is not present in the JSON representation, that field will be left unchanged. FromJsonOverwrite can be called from background threads. You should...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_405dc202efd6
unity_docs
animation
Explain 'Animation tab' in Unity.
Animation Clips are the smallest building blocks of animation in Unity. They represent an isolated piece of motion, such as RunLeft, Jump, or Crawl, and can be manipulated and combined in various ways to produce lively end results (see Animation State Machines , Animator Controller , or Blend Trees ). You can select An...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f589c032b2e
unity_docs
xr
What is `PrefabUtility.ConvertToPrefabInstance` in Unity? Explain its purpose and usage.
PrefabUtility.ConvertToPrefabInstance Declaration public static void ConvertToPrefabInstance ( GameObject plainGameObject , GameObject prefabAssetRoot , ConvertToPrefabInstanceSettings settings , InteractionMode mode ); Parameters Parameter Description plainGameObject The GameObject that will be co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8df8c24489ff
unity_docs
scripting
What is `UnityEngine.TerrainModule` in Unity? Explain its purpose and usage.
UnityEngine.TerrainModule Description The Terrain module implements Unity's Terrain rendering engine available through the Terrain component. Classes Class Description DetailPrototype Detail prototype used by the Terrain GameObject. PaintContext The context for a paint operation that may span multiple connected...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_722c31c25dc3
github
scripting
Write a Unity C# XR/VR script for Nerf Render Editor
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using RosMessageTypes.NerfTeleoperation; using Unity.Robotics.ROSTCPConnector; using Unity.Robotics.ROSTCPConnector.ROSGeometry; using RosMessageTypes.Geometry; using RosMessageTypes.Std; using RosMessageTypes.Sensor; using TMPro; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_457ec183b3d6
unity_docs
editor
What is `CloudProjectSettingsEventManager` in Unity? Explain its purpose and usage.
CloudProjectSettingsEventManager class in UnityEditor Description Manages the events related to the project state. Static Properties Property Description instance The instance of the Cloud Project Settings event manager. Events Event Description projectRefreshed The event fired when the user the state of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f0b75bd5ffc
unity_docs
scripting
What is `MenuCommand.ctor` in Unity? Explain its purpose and usage.
MenuCommand Constructor Declaration public MenuCommand ( Object inContext , int inUserData ); Description Creates a new MenuCommand object. Context and userData will be initialized to inContext and inUserdata respectively. Declaration public MenuCommand ( Object inContext ); Description Creates a new...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f22c822515c
unity_docs
rendering
Explain 'Preview baked lighting' in Unity.
You can edit a scene and preview changes to lightmaps and lighting without affecting the baked lightmaps. To preview, do the following in a scene that uses lightmapping: In the Scene view View Options toolbar , select Debug Draw Mode . Select a Global Illumination Draw Mode. In the Lighting Visualization overlay, set L...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b54d14605b9
unity_docs
scripting
Give me an overview of the `TerrainDetailMeshWizard` class in Unity.
TerrainDetailMeshWizard class in UnityEditor / Inherits from: TerrainWizard Description Provides methods for displaying the detail mesh wizard. Derived class that manages the detail mesh wizards used for displaying and altering detail mesh data. Note: that this method derives from TerrainWizard. Additional...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4c1f3cd1bbd2
github
scripting
Write a Unity C# UI script for Game View
```csharp using System; using JetBrains.Annotations; using RMC.Mini.View; using RMC.Mini.Samples.Configurator.Mini.Controller; using RMC.Mini.Samples.Configurator.Mini.Model; using RMC.Mini.Samples.Configurator.Mini.Model.Data; using RMC.Mini.Samples.Configurator.Standard.Gameplay; using UnityEngine; using UnityEngine....
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_1ce8e6b6580d
unity_docs
scripting
What is `Experimental.GraphView.Dragger.clampToParentEdges` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Dragger.clampToParentEdges public bool clampToParentEdges ; Description If true, it does not allow the dragged element to exit the parent's edges.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4aafcd6c1683
github
scripting
Write a Unity C# XR/VR script for Multi Cam Capture Object
```csharp // Copyright 2020 The Tilt Brush Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicab...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_14ba9b89ca7c
unity_docs
scripting
In Unity's 'Editor', what is 'Asset Serialization' and how does it work?
Property Description Mode Choose which format to use for storing serialized Assets. This is set to Force Text by default. Unity uses serialization to load and save assets and AssetBundles to and from your computer’s hard drive. To help with version control merges, Unity can store scene files in a text-based format . If...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_af77529976c5
unity_docs
editor
In Unity's 'Entities Graphics', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.entities.graphics@1.5 compatible 1.5.0-exp.1 com.unity.entities.graphics@1.4 released 1.4.18
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0944aca59b19
unity_docs
math
What is `Matrix4x4.GetColumn` in Unity? Explain its purpose and usage.
Matrix4x4.GetColumn Declaration public Vector4 GetColumn (int index ); Description Get a column of the matrix. The i-th column is returned as a Vector4 . i must be from 0 to 3 inclusive. Additional resources: SetColumn .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_868030762deb
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.AddCopyFilesBuildPhase` in Unity?
Returns string Returns the GUID of the new phase. Description Creates a new Copy Files build phase for a given target. If a Copy Files build phase with the same name, dstPath , and subfolderSpec is already configured for the target, the function returns the existing phase. The new phase is placed at the end of the list...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_271b99bd43e1
unity_docs
scripting
Show me a Unity C# example demonstrating `Mathf.PingPong`.
Pong returns a value that increments and decrements between zero and the length. It follows the triangle wave formula where the bottom is set to zero and the peak is set to length . PingPong requires the value t to be a self-incrementing value. For example, Time.time and Time.unscaledTime. The example below shows a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2dad774e1a23
unity_docs
scripting
Give me an overview of the `BoundingSphere` class in Unity.
BoundingSphere struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Describes a single bounding sphere for use by a CullingGroup . Properties Property Description position The position of the center of the BoundingSphere. radius The radius of the BoundingSphere. Constructors Constru...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32f715e554a5
unity_docs
math
What is `AndroidJNI.CallSByteMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallSByteMethod Declaration public static sbyte CallSByteMethod (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 Specificati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8388e26ee65f
unity_docs
scripting
What is `PackageManager.PackageInfo.registry` in Unity? Explain its purpose and usage.
PackageInfo.registry public PackageManager.RegistryInfo registry ; Description The registry where the Package Manager might find this package. This value always returns a registry, even if the package's source is not PackageSource.Registry (such as an embedded package or a Git dependency). In that case, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70d289307c98
unity_docs
ui
What is `Experimental.GraphView.GraphElement.Unselect` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphElement.Unselect Declaration public void Unselect ( UIElements.VisualElement selectionContainer ); Parameters Parameter Description selectionContainer Container in which the GraphElement was selected. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1585416409df
unity_docs
animation
In Unity's 'Animation tab', what is 'Setting error tolerance for key reduction on position and scale curves' and how does it work?
Set the error tolerance percentage to determine whether or not Unity can remove a key on a position or scale curve as a strategy for animation compression . When you set the Anim. Compression property to Keyframe Reduction or Optimal , Unity compares the original curve to what the curve looks like after removing a spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1924baa1fe89
unity_docs
math
What is `Rendering.BatchCullingOutputDrawCommands.proceduralIndirectDrawCommandCount` in Unity? Explain its purpose and usage.
BatchCullingOutputDrawCommands.proceduralIndirectDrawCommandCount public int proceduralIndirectDrawCommandCount ; Description The number of elements in the BatchCullingOutputDrawCommands.proceduralIndirectDrawCommands array. You must set this in the OnPerformCulling callback.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f077be89313e
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObjectUtility.DuplicateGameObject`.
plicates a GameObject within a Scene. The duplicated GameObject will be on the same level in the hierarchy as the original GameObject, and they will share the same parent. If there are any children or components that belong to the original GameObject, the duplicate will have them as well. For duplicating more than one ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4a4fdc21b13
unity_docs
editor
What is `SettingsService.OpenProjectSettings` in Unity? Explain its purpose and usage.
SettingsService.OpenProjectSettings Declaration public static EditorWindow OpenProjectSettings (string settingsPath ); Parameters Parameter Description settingsPath Settings paths of the item to select (for example, 'Project/Player' or 'Project/Quality'). Returns EditorWindow Returns an instance to the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba885682682f
unity_docs
rendering
What is `Rendering.CommandBuffer.DisableShaderKeyword` in Unity? Explain its purpose and usage.
CommandBuffer.DisableShaderKeyword Declaration public void DisableShaderKeyword (string keyword ); Parameters Parameter Description keyword Name of a global keyword to disable. Description Adds a command to disable a global shader keyword with a given name. It is more efficient to use DisableKeyword . Ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2168c03b6b0e
unity_docs
scripting
What is `UIElements.EventBase.StopImmediatePropagation` in Unity? Explain its purpose and usage.
EventBase.StopImmediatePropagation Declaration public void StopImmediatePropagation (); Description Immediately stops the propagation of the event. The event isn't sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d4e59f56c3f3
unity_docs
rendering
Explain 'Textures reference' in Unity.
Explore the properties in Texture Import Settings windows to configure how Unity imports and converts textures. Page Description Texture Import Settings Explore the default settings in the Texture Import window. Default texture Import Settings Explore the settings for a default texture. Normal Map texture Import Settin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f416419cc3b
unity_docs
scripting
What is `PlayerSettings.GetUseDefaultGraphicsAPIs` in Unity? Explain its purpose and usage.
PlayerSettings.GetUseDefaultGraphicsAPIs Declaration public static bool GetUseDefaultGraphicsAPIs ( BuildTarget platform ); Parameters Parameter Description platform Platform to get the flag for. Returns bool Should best available graphics API be used. Description Is a build platform using automati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_917ee0579cf7
unity_docs
scripting
What is `Search.IPropertyDatabaseView.Sync` in Unity? Explain its purpose and usage.
IPropertyDatabaseView.Sync Declaration public void Sync (); Description Synchronizes the views so they have access to the same content. This flushes the internal filestream of the view, so the data is written on disk and available to the other views. When PropertyDatabase.GetView is called with delayedSync ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c7868bf5c49
unity_docs
scripting
Show me a Unity code example for 'FAQ for input and event systems with UI Toolkit'.
can’t be remapped because they’re not exposed through the Event System input modules. ## How can I change what element is focused next when using directional navigation? You can configure directional navigation to have other targets other than the default ones. The following code example allows element A to navigate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6539432af24b
unity_docs
scripting
In Unity's 'Constraint components introduction', what is 'Activating and locking Constraints' and how does it work?
There are two aspects to working with Constraints: activating and locking. You activate a Constraint to allow it to evaluate the position, rotation, or scale of the constrained GameObject. Unity does not evaluate inactive Constraints. You lock a Constraint to allow it to move, rotate, or scale the GameObject. A locked ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cf3f4b99730f
unity_docs
rendering
What is `AssetImporter.GetAtPath` in Unity? Explain its purpose and usage.
AssetImporter.GetAtPath Declaration public static AssetImporter GetAtPath (string path ); Description Retrieves the asset importer for the asset at path . Additional resources: ModelImporter , TextureImporter , AudioImporter . ```csharp using UnityEngine; using UnityEditor; public class GetAtPathExample...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69cfa3631658
unity_docs
editor
What is `UIElements.BaseListView.reorderableItemHandleUssClassName` in Unity? Explain its purpose and usage.
BaseListView.reorderableItemHandleUssClassName public static string reorderableItemHandleUssClassName ; Description The USS class name for drag handle in reorderable animated ListView. Unity adds this USS class to drag handles in the ListView when reorderMode is set to Animated . Any styling applied to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c09b6290526f
unity_docs
scripting
What is `Android.AndroidHardwareType` in Unity? Explain its purpose and usage.
AndroidHardwareType enumeration Description AndroidHardwareType describes the type of Android device on which the app is running. Properties Property Description Generic The Generic category includes all other Android devices.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5f459f944543
github
scripting
Write a Unity C# script called Observable Drop Trigger
```csharp // for uGUI(from 4.6) #if !(UNITY_4_0 || UNITY_4_1 || UNITY_4_2 || UNITY_4_3 || UNITY_4_4 || UNITY_4_5) using System; // require keep for Windows Universal App using UnityEngine; using UnityEngine.EventSystems; namespace UniRx.Triggers { [DisallowMultipleComponent] public class ObservableDropTrigge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f427c8a27c14
unity_docs
scripting
What is `Search.QueryBlock.Apply` in Unity? Explain its purpose and usage.
QueryBlock.Apply Declaration public void Apply (InAttribute) searchProposition ); Parameters Parameter Description searchProposition Selected search proposition. Description This method is invoked when a selected search proposition must be applied to the builder search query.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2e0c233426f0
github
scripting
Write a Unity Editor script for TTS Service Inspector
```csharp /* * Copyright (c) Meta Platforms, Inc. and affiliates. * All rights reserved. * * This source code is licensed under the license found in the * LICENSE file in the root directory of this source tree. */ using System; using Meta.WitAi.TTS.Data; using UnityEditor; using UnityEngine; namespace Meta.Wit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d7bb0c066dd
unity_docs
editor
Show me a Unity C# example demonstrating `Callbacks.RunBeforeAssemblyAttribute`.
s a dependency graph and uses topological sorting to ensure that all dependencies are run in sequence based on their dependencies. If callbacks dependencies are not present in the project then the instruction will be ignored during the generation of the dependency graph. Note: Defining callback dependencies is current...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2478efc137d1
unity_docs
editor
What are the parameters of `SettingsService.OpenProjectSettings` in Unity?
Returns EditorWindow Returns an instance to the Settings window. Description Open the Project Settings window with the specified settings item already selected. ```csharp using UnityEditor; using UnityEngine;class MyCustomWindow : EditorWindow { void OnGUI() { if (GUILayout.Button("Open my custom prefer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9052f64007d2
unity_docs
rendering
What is `Camera.useJitteredProjectionMatrixForTransparentRendering` in Unity? Explain its purpose and usage.
Camera.useJitteredProjectionMatrixForTransparentRendering public bool useJitteredProjectionMatrixForTransparentRendering ; Description Should the jittered matrix be used for transparency rendering? For descriptions of jittered projection rendering see: Camera.nonJitteredProjectionMatrix .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7cec384de664
unity_docs
scripting
What is `ExitGUIException` in Unity? Explain its purpose and usage.
ExitGUIException class in UnityEngine / Implemented in: UnityEngine.IMGUIModule Description An exception that will prevent all subsequent immediate mode GUI functions from evaluating for the remainder of the GUI loop. If you have exception handling in your GUI code, it should not catch this exception type, as...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2d9f20d8772
unity_docs
math
What is `Rendering.SubPassDescriptor.colorOutputs` in Unity? Explain its purpose and usage.
SubPassDescriptor.colorOutputs public Rendering.AttachmentIndexArray colorOutputs ; Description Array of attachment indices to be used as the color render targets in this sub pass. These are specificed as indices into the attachment array passed to CommandBuffer.BeginRenderPass .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18f93b1cede2
unity_docs
xr
What is `XR.MeshVertexAttributes.Colors` in Unity? Explain its purpose and usage.
MeshVertexAttributes.Colors Description Vertex normals Used by XRMeshSubsystem.GenerateMeshAsync to request that colors get generated, or by MeshGenerationResult to indicate colors were written to the Mesh .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_54da57e12d05
github
scripting
Write a Unity C# MonoBehaviour script called AI Action
```csharp using UnityEngine; using System; namespace Goon.AI { public abstract class AIAction : MonoBehaviour { public abstract void Perform(); public abstract bool isComplete(); public abstract void Reset(); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0d61bf5032ff
unity_docs
scripting
In Unity's 'JAR plug-ins', what is 'Import a JAR plug-in' and how does it work?
To import a JAR plug-in (AAR) plug-in into your Unity Project: Copy the.jar file to your Unity Project’s Assets folder. Select the.jar file in Unity and view it in the Inspector . In the Select platforms for plugin section, select Android . Select Apply .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_397278dd6bc7
unity_docs
rendering
What is `Rendering.RenderTargetBlendState.sourceAlphaBlendMode` in Unity? Explain its purpose and usage.
RenderTargetBlendState.sourceAlphaBlendMode public Rendering.BlendMode sourceAlphaBlendMode ; Description Blend factor used for the alpha (A) channel of the source. Additional resources: ShaderLab: Blending .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_096eb4371a50
unity_docs
scripting
What is `SystemInfo.systemMemorySize` in Unity? Explain its purpose and usage.
SystemInfo.systemMemorySize public static int systemMemorySize ; Description Amount of system memory present (Read Only). This is the approximate amount of system memory in megabytes. WebGL : This function will return the current size of the asm.js/WebAssembly heap. Note that when using WebAssembly, the heap si...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0682f2c0d9ab
unity_docs
rendering
What is `ITerrainLayerCustomUI` in Unity? Explain its purpose and usage.
ITerrainLayerCustomUI interface in UnityEditor Description Provides an interface to display a custom TerrainLayer UI in the Terrain Layers inspector. Implement this interface on the ShaderGUI class for your custom terrain shader. This GUI will only be displayed when you select any Terrain Layer in the Paint Tex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b658decb0d73
unity_docs
ui
What are the parameters of `GUI.HorizontalScrollbar` in Unity?
Returns float The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. Description Make a horizontal scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead. ```csharp using UnityEngine; using System.C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_be4c6373861a
unity_docs
rendering
Explain 'Troubleshooting shaders' in Unity.
Solve common issues with shaders . Page Description Error and loading shaders Learn about the special shaders that Unity uses when it can’t use regular shaders. Fixing hitches or stalls Strategies for reducing stalls caused by Unity loading or compiling shaders while a scene is running. Reducing the size or number of s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4140c2fde237
unity_docs
scripting
Show me a Unity C# example demonstrating `PrimitiveType.Sphere`.
PrimitiveType.Sphere Description A sphere primitive. Additional resources: GameObject.CreatePrimitive . ```csharp using UnityEngine; using System.Collections;// Creates a sphere primitivepublic class ExampleClass : MonoBehaviour { void Start() { GameObject sphere = GameObject.CreatePrimitive(PrimitiveType.Sphe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41b07d4eabb1
unity_docs
scripting
What is `UIElements.UxmlAssetAttributeDescription_1` in Unity? Explain its purpose and usage.
UxmlAssetAttributeDescription<T0> class in UnityEngine.UIElements / Inherits from: UIElements.TypedUxmlAttributeDescription_1 / Implemented in: UnityEngine.UIElementsModule Description Describes a UXML Object attribute referencing an asset in the project. In UXML, this is referenced as a string URI. Prop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2579f3903110
unity_docs
rendering
What is `Search.SearchProvider.CreateItem` in Unity? Explain its purpose and usage.
SearchProvider.CreateItem Declaration public Search.SearchItem CreateItem ( Search.SearchContext context , string id , int score , string label , string description , Texture2D thumbnail , object data ); Obsolete Use CreateItem which take a SearchContext. Declaration public Search.SearchItem Cre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74875b631dd7
unity_docs
scripting
What are the parameters of `Handles.ConeHandleCap` in Unity?
Description Draw a cone handle. Pass this into handle functions. On EventType.Layout event, calculates handle distance to mouse and calls HandleUtility.AddControl accordingly. On EventType.Repaint event, draws the handle shape. Cone Handle Cap in the Scene View. Add the following script to your Assets folder as ConeExa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9658f2025d3b_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The View handles user interface and user inputRelates to the Signature: ```csharp public class SceneSystemView: SingletonMonoBehaviour<SceneSystemView>, IView ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_07d83c0545bc
unity_docs
scripting
What is `UIElements.UxmlStringAttributeDescription.GetValueFromBag` in Unity? Explain its purpose and usage.
UxmlStringAttributeDescription.GetValueFromBag Declaration public string GetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. Returns string The value of the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b6b4eb70c6c
unity_docs
animation
What is `Animations.AimConstraint.locked` in Unity? Explain its purpose and usage.
AimConstraint.locked public bool locked ; Description Locks the offset and rotation at rest. In Edit mode, unlocks the constraint to update its offsets. In Play mode, the constraint is always locked.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f2d21bb52fa
unity_docs
scripting
What is `Experimental.GraphView.ContentZoomer.RegisterCallbacksOnTarget` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ContentZoomer.RegisterCallbacksOnTarget Declaration protected void RegisterCallbacksOnTarget (); Description Called to register click event callbacks on the target element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28aef5649e12
unity_docs
rendering
What is `TextureImporter.qualifiesForSpritePacking` in Unity? Explain its purpose and usage.
TextureImporter.qualifiesForSpritePacking public bool qualifiesForSpritePacking ; Description Returns true if this TextureImporter is setup for Sprite packing. If it returns true, texture is imported uncompressed for Sprite packing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd10802fde19
unity_docs
xr
What is `EditorTools.EditorToolContext.GetEditorToolType` in Unity? Explain its purpose and usage.
EditorToolContext.GetEditorToolType Declaration protected Type GetEditorToolType ( Tool tool ); Parameters Parameter Description tool The Tool that needs to be resolved to an EditorTool type. Returns Type An EditorTool type for the requested Tool . Description Defines the EditorTool type fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0a3f56a0ccc
unity_docs
scripting
What is `Rendering.StencilState.ctor` in Unity? Explain its purpose and usage.
StencilState Constructor Declaration public StencilState (bool enabled , byte readMask , byte writeMask , Rendering.CompareFunction compareFunction , Rendering.StencilOp passOperation , Rendering.StencilOp failOperation , Rendering.StencilOp zFailOperation ); Declaration public StencilState (bool ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.