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_ecd5c022875f
unity_docs
scripting
What is `Device.Application.IsPlaying` in Unity? Explain its purpose and usage.
Application.IsPlaying Declaration public static bool IsPlaying ( Object obj ); Description This has the same functionality as Application.IsPlaying . At the moment, the Device Simulator doesn't support simulation of this method.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_025cf7b680fe
unity_docs
scripting
What is `ArticulationBody.AddTorque` in Unity? Explain its purpose and usage.
ArticulationBody.AddTorque Declaration public void AddTorque ( Vector3 torque , ForceMode mode = ForceMode.Force); Parameters Parameter Description torque The torque to apply. mode The type of torque to apply. Description Add torque to the articulation body. You can only apply a torque to an activ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_40c7bce0568d
unity_docs
editor
What is `SceneManagement.EditorSceneManager.NewScene` in Unity? Explain its purpose and usage.
EditorSceneManager.NewScene Declaration public static SceneManagement.Scene NewScene ( SceneManagement.NewSceneSetup setup , SceneManagement.NewSceneMode mode = NewSceneMode.Single); Parameters Parameter Description setup Whether the new Scene should use the default set of GameObjects. mode Whether ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13b2ae82553b
unity_docs
scripting
Explain 'Create a Video Player component' in Unity.
Create a Video Player component to play videos in your scene . There are a few ways to create a Video Player component in Unity. Choose from one of the following methods: Create a Video Player from the menu or hierarchy Add the component to an existing GameObject Drag a video clip into the scene Use C# scripting to add...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_79a54a765f3e
unity_docs
rendering
Explain 'Troubleshooting cameras' in Unity.
Solve common issues with cameras , such as flickering lights and shadows. ## Symptoms A ‘tear’ across the screen, where the top and bottom halves don’t match up. ## Cause Updates in Unity aren’t synchronized with updates of the display device, so Unity might send a new frame while the display device is still render...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bfd26f01cbe7
unity_docs
rendering
What is `WebCamTexture.Play` in Unity? Explain its purpose and usage.
WebCamTexture.Play Declaration public void Play (); Description Starts the camera. Call Application.RequestUserAuthorization before creating a WebCamTexture. ```csharp // Starts the default camera and assigns the texture to the current renderer using UnityEngine; using System.Collections;public class Example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44ba96957e33
unity_docs
audio
What are the parameters of `Handheld.PlayFullScreenMovie` in Unity?
Description Plays a full-screen movie. The Player streams the movie directly from device storage. It's recommended to provide the movie as a separate file, not as a usual asset. Create a folder named StreamingAssets in the Assets folder of your Unity project to store your movie files. Unity automatically copies content...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_022b77202457
unity_docs
animation
What is `AnimationState.normalizedTime` in Unity? Explain its purpose and usage.
AnimationState.normalizedTime public float normalizedTime ; Description Normalized time of the State. The normalized time is a progression ratio. The integer part is the number of times the State has looped. The fractional part is a percentage (0-1) that represents the progress of the current loop. For example,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23004b985b9d
unity_docs
physics
What is `Joint.breakForce` in Unity? Explain its purpose and usage.
Joint.breakForce public float breakForce ; Description The force that needs to be applied for this joint to break. The force might come from collisions with other objects, forces applied with Rigidbody.AddTorque or from other joints. The break force can be set to Mathf.Infinity to render the joint unbreakab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3df2a589fa74
unity_docs
scripting
What is `RuntimeInitializeLoadType.AfterSceneLoad` in Unity? Explain its purpose and usage.
RuntimeInitializeLoadType.AfterSceneLoad Description Callback invoked when the first scene's objects are loaded into memory and after Awake has been called. At this point active objects can be found with UnityEngine.Object.FindObjectsByType. Before this point the first Scene's objects are considered inactive rega...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_68ad43f4dc6d
unity_docs
rendering
What is `Texture2DArray.GetPixels32` in Unity? Explain its purpose and usage.
Texture2DArray.GetPixels32 Declaration public Color32[] GetPixels32 (int arrayElement , int miplevel ); Declaration public Color32[] GetPixels32 (int arrayElement ); Parameters Parameter Description arrayElement The array slice to read pixel data from. miplevel The mipmap level to get. The range is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a0bf0bda62d
unity_docs
scripting
What is `Mesh.ctor` in Unity? Explain its purpose and usage.
Mesh Constructor Declaration public Mesh (); Description Creates an empty Mesh. ```csharp // Create a new Mesh and assign it to the Mesh filter using UnityEngine;public class ExampleClass : MonoBehaviour { void Start() { Mesh mesh = new Mesh(); GetComponent<MeshFilter>().mesh = mesh; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_419433b41042
unity_docs
rendering
In Unity's 'Mesh asset Inspector window reference', what is 'Mesh preview' and how does it work?
This part of the Inspector allows you to preview the appearance of a mesh and explore the mesh data in a visual way. You can use the following properties in the UI to configure the view: Property Description View mode Provides different ways of visualizing the mesh. For more information, refer to View mode dropdown . W...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29d427b490ce
unity_docs
editor
What are the parameters of `EditorGUILayout.IntField` in Unity?
Returns int The value entered by the user. Description Make a text field for entering integers. Clone the Selected object a number of times. ```csharp // Editor Script that clones the selected GameObject a number of times.using UnityEditor; using UnityEngine;public class IntFieldExample : EditorWindow { static int ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bedaf617a9bc
unity_docs
audio
What is `Networking.DownloadHandler` in Unity? Explain its purpose and usage.
DownloadHandler class in UnityEngine.Networking / Implemented in: UnityEngine.UnityWebRequestModule Description Manage and process HTTP response body data received from a remote server. DownloadHandler objects are helper objects. When attached to a UnityWebRequest , they define how to handle HTTP response body...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3c1b57db7a8
unity_docs
editor
What is `Debug.isDebugBuild` in Unity? Explain its purpose and usage.
Debug.isDebugBuild public static bool isDebugBuild ; Description In the Build Settings dialog there is a check box called "Development Build". If it is checked isDebugBuild will be true. In the editor isDebugBuild always returns true. It is recommended to remove all calls to Debug.Log when deploying a game...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d63d7efe90f
unity_docs
scripting
What is `PlayerPrefs.Save` in Unity? Explain its purpose and usage.
PlayerPrefs.Save Declaration public static void Save (); Description Saves all modified preferences. Unity saves preferences automatically during OnApplicationQuit(). On the Universal Windows Platform, Unity writes preferences during application suspend. For information on the storage location, see PlayerPrefs...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42be0555de75
unity_docs
ui
What is `EditorGUIUtility.fieldWidth` in Unity? Explain its purpose and usage.
EditorGUIUtility.fieldWidth public static float fieldWidth ; Description The minimum width in pixels reserved for the fields of Editor GUI controls. Most Editor GUI controls consist of a label as well as the control field itself. The minimum width of the field is controlled by the fieldWidth value. Fields often...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d6c3220a133
unity_docs
rendering
What is `IHVImageFormatImporter.ignoreMipmapLimit` in Unity? Explain its purpose and usage.
IHVImageFormatImporter.ignoreMipmapLimit public bool ignoreMipmapLimit ; Description Enable if the texture should ignore any texture mipmap limit settings set in the Project Settings. For additional information, see Texture2D.ignoreMipmapLimit .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9c2d10144f7
unity_docs
physics
What is `JointMotor` in Unity? Explain its purpose and usage.
JointMotor struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description The JointMotor is used to motorize a joint. For example the HingeJoint can be told to rotate at a given speed and force. The joint will then attempt to reach the velocity with the given maximum force. Additional resource...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c8963bf248d
unity_docs
rendering
In Unity's 'Control material properties in the Inspector window', what is 'Enable the default custom editor' and how does it work?
This example code demonstrates the syntax for specifying a default custom editor for a shader asset using the CustomEditor block, and then specifying two additional custom editors for specific Render Pipeline Assets using the CustomEditorForRenderPipeline block. ``` Shader "Examples/UsesCustomEditor" { // The Unity Ed...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a340d47390d
unity_docs
scripting
What is `AwaitableCompletionSource.TrySetException` in Unity? Explain its purpose and usage.
AwaitableCompletionSource.TrySetException Declaration public bool TrySetException (Exception exception ); Parameters Parameter Description exception Exception to raise in the continuation. Returns bool Indicates if the completion was successfully raised. Description Raise completion with an exception...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0068e3b5d460
unity_docs
scripting
Show me a Unity C# example demonstrating `RenderingLayerMask.value`.
RenderingLayerMask.value public uint value ; Description Converts a layer mask value to an integer value. ```csharp using UnityEngine; using UnityEngine.Rendering;public class Example : MonoBehaviour { // Set the rendering layer mask for MeshRenderer RenderingLayerMask mask = 1 << 10; void Start() { GetComp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50ed85ecec41
unity_docs
math
Show me a Unity C# example demonstrating `Search.QueryEngine_1.AddFiltersFromAttribute`.
method attribute TFilterAttribute. Allows you to register a filter with a specific type. <TFilterAttribute>: The type of the attribute defined for your custom filters. <TTransformerAttribute>: The type of the attribute defined for your custom parameter transformers. For more information about the custom attributes, se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2e7e5c7a2022
unity_docs
ui
Explain 'Conditionally including assemblies' in Unity.
You can use preprocessor symbols to control whether an assembly is compiled and included in builds of your application (including Play mode in the Editor). You can specify which symbols must be defined for an assembly to be used with the Define Constraints list in the Assembly Definition options: Select the Assembly De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_81fbd782f624
unity_docs
editor
Show me a Unity C# example demonstrating `FileUtil.GetUniqueTempPathInProject`.
e Temp folder within your current project. The returned path is relative to the project folder. The returned path is of a form Temp/UnityTempFile- uniqueID , where uniqueID is guaranteed to be unique over space and time. You can use it to create temporary files/folders and be sure that you are not overriding somebo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e40f6aa667b4
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody.solverVelocityIterations`.
sion contacts are resolved. Overrides Physics.defaultSolverVelocityIterations . Must be positive. Increasing this value will result in higher accuracy of the resulting exit velocity after a Rigidbody bounce. If you are experiencing issues with jointed Rigidbodies or Ragdolls moving too much after collisions you can t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a4cd5ca12a3
unity_docs
rendering
What are the parameters of `Mesh.GetBlendShapeBuffer` in Unity?
Returns GraphicsBuffer The blend shape vertex data as a GraphicsBuffer . Description Retrieves a GraphicsBuffer that provides direct read and write access to GPU blend shape vertex data. The buffer that this function returns is called the blend shape buffer. It contains blend shape vertices, which the GPU uses to defor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f176e40ed910
unity_docs
math
What is `AI.NavMeshAgent.Move` in Unity? Explain its purpose and usage.
NavMeshAgent.Move Declaration public void Move ( Vector3 offset ); Parameters Parameter Description offset The relative movement vector. Description Apply relative movement to current position. If the agent has a path it will be adjusted.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46212ca39df2
unity_docs
rendering
Show me a Unity C# example demonstrating `TrailRenderer.widthCurve`.
TrailRenderer.widthCurve public AnimationCurve widthCurve ; Description Set the curve describing the width of the trail at various points along its length. This property is multiplied by TrailRenderer.widthMultiplier to get the final width of the trail. ```csharp using UnityEngine; using System.Collection...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_03b5b32fe1e6
unity_docs
rendering
Explain 'Creating a renderer with the BatchRendererGroup API in URP' in Unity.
This section of the documentation explains how to use BatchRendererGroup (BRG) to create a renderer. Topic Description Initialize a BatchRendererGroup object Explains how to initialize a BatchRendererGroup object with a minimal OnPerformCulling callback. Register meshes and materials Explains how to register meshes and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_649b8eb252e6
unity_docs
physics
What is `Collider2D.CompositeOperation.Difference` in Unity? Explain its purpose and usage.
Collider2D.CompositeOperation.Difference Description Indicates a composite operation that composes geometry using a Boolean NOT operation. This composite operation will result in a region where this operation geometry region which overlaps is not included. Additional resources: Collider2D.compositeOperation and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf2678f59319
unity_docs
rendering
What is `ParticleSystem.MinMaxGradient.Evaluate` in Unity? Explain its purpose and usage.
ParticleSystem.MinMaxGradient.Evaluate Declaration public Color Evaluate (float time ); Declaration public Color Evaluate (float time , float lerpFactor ); Parameters Parameter Description time Normalized time (in the range 0 - 1, where 1 represents 100%) at which to evaluate the gradient. This is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7729f5783c3
unity_docs
rendering
What is `WebCamTexture.GetPixel` in Unity? Explain its purpose and usage.
WebCamTexture.GetPixel Declaration public Color GetPixel (int x , int y ); Parameters Parameter Description x The x coordinate of the pixel to get. The range is 0 through the (texture width - 1). y The y coordinate of the pixel to get. The range is 0 through the (texture height - 1). Returns Color...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b54d1c9d0495
unity_docs
scripting
In Unity's 'Introduction to the camera view', what is 'The shape of the viewed region' and how does it work?
Both perspective and orthographic cameras have a limit on how far they can “see” from their current position. The limit is defined by a plane that is perpendicular to the camera’s forward (Z) direction. This is known as the far clipping plane since objects at a greater distance from the camera are “clipped” (ie, exclud...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8c43afcc7f53_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Returned by currentStopTime if he stopwatch was not started yet. Signature: ```csharp public const float INACTIVE_STOP_TIME = -1.0f; ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e3264d8b534
unity_docs
xr
What is `WSA.Tile.hasUserConsent` in Unity? Explain its purpose and usage.
Tile.hasUserConsent public bool hasUserConsent ; Description Whether secondary tile was approved (pinned to start screen) or rejected by user. false mean that a request to create secondary tile is still visible on screen.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e0a1aaf2026
unity_docs
ui
What are the parameters of `UIElements.MeshWriteData.SetAllVertices` in Unity?
Description Fills the values of the allocated vertices with values copied directly from an array. When this method is called, it is not possible to use SetNextVertex to fill the allocated vertices array. When this method is called, it is not possible to use SetNextVertex to fill the vertices. ```csharp public class My...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7597c92bb20d
unity_docs
editor
What is `Unity.Profiling.Editor.ProfilerModuleMetadataAttribute.DisplayName` in Unity? Explain its purpose and usage.
ProfilerModuleMetadataAttribute.DisplayName public string DisplayName ; Description The attributed Profiler module’s display name. The attributed Profiler module’s display name as a string. Read-only. ```csharp using System; using Unity.Profiling; using Unity.Profiling.Editor;[Serializable] [ProfilerModuleMeta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bcaef78e5f2
unity_docs
physics
What is `PhysicsVisualizationSettings.inertiaTensorScale` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.inertiaTensorScale public static float inertiaTensorScale ; Description The scale by which the inertia tensor lines are multiplied. This is useful when the inertia tensor is big and does not fit in the screen. The proportions of the inertia tensor remain unaffected.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_07494ce615f3
github
scripting
Write a Unity C# XR/VR script for XRHUD
```csharp using UnityEngine; using UnityEngine.UI; using TMPro; namespace TapLive.UI { /// <summary> /// XR Heads-up display controller /// Manages persistent UI elements visible to the user /// </summary> public class XRHUD : MonoBehaviour { [Header("UI Elements")] public TextM...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d939cc84de88
unity_docs
ui
What is `UIElements.ToggleButtonGroupState.GetActiveOptions` in Unity? Explain its purpose and usage.
ToggleButtonGroupState.GetActiveOptions Declaration public Span<int> GetActiveOptions (Span<int> activeOptionsIndices ); Parameters Parameter Description activeOptionsIndices A Span of type integers with the allocated size to hold the number of active indices. Description Retrieves a Span of integers cont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_422ddb4d5add
unity_docs
rendering
What is `DefaultLightingExplorerExtension.GetObjectsForLightingExplorer` in Unity? Explain its purpose and usage.
DefaultLightingExplorerExtension.GetObjectsForLightingExplorer Declaration protected static IEnumerable<T> GetObjectsForLightingExplorer (); Returns IEnumerable<T> Returns and array of T type Objects. Description Returns T type Objects to be shown in the Light Explorer.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0cdbb8033e15
unity_docs
rendering
In Unity's 'Dedicated Server Player settings', what is 'Configuration' and how does it work?
Property Description Scripting Backend Choose the scripting backend you want to use. The scripting backend determines how Unity compiles and executes C# code in your Project. Mono : Compiles C# code into .NET Common Intermediate Language (CIL) and executes that CIL using a Common Language Runtime. For more information,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e5f3ef3ea290
unity_docs
scripting
What is `Playables.PlayableOutputExtensions` in Unity? Explain its purpose and usage.
PlayableOutputExtensions class in UnityEngine.Playables / Implemented in: UnityEngine.CoreModule Description Extensions for all the types that implements IPlayableOutput . Extension methods are static methods that can be called as if they were instance methods on the extended type. ```csharp using UnityEngine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_285982edc7d0
unity_docs
scripting
What is `Video.VideoPlayer.frameRate` in Unity? Explain its purpose and usage.
VideoPlayer.frameRate public float frameRate ; Description The frame rate of the clip or URL in frames/second. (Read Only) For URL sources, this is only set once the source preparation is completed. See VideoPlayer.Prepare . This property is most accurate after the video does a complete playthrough. Note: On...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_19f3cb019ec3
unity_docs
math
Show me a Unity C# example demonstrating `Ray.ctor`.
Ray Constructor Declaration public Ray ( Vector3 origin , Vector3 direction ); Description Creates a ray starting at origin along direction . ```csharp using UnityEngine;public class ExampleClass : MonoBehaviour { void Start() { // Create a ray from the transform position along the transform's z-axis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_43e239231d3e
unity_docs
rendering
Explain 'Optimize your Web build' in Unity.
It’s important to optimize your Web build because Web-based applications perform best when you have a small build. A small build means there’s less data to download during initialization, which reduces load times. Slow load times can result in poor user experience and a high bounce rate. To optimize your Web build for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c76c967b8536
unity_docs
performance
In Unity's 'Burst compilation', what is 'Compiling with Burst' and how does it work?
Code is Burst compiled if the following conditions are met: The code is Burst-compatible . Burst compilation is enabled, either through Burst AOT Settings for Player builds or through the Burst menu for Unity Editor code. The code is explicitly marked with the [BurstCompile] attribute or is referenced from code that is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b566627a9b95
unity_docs
scripting
What is `AI.NavMeshAgent.avoidancePriority` in Unity? Explain its purpose and usage.
NavMeshAgent.avoidancePriority public int avoidancePriority ; Description The avoidance priority level. When the agent is performing avoidance, agents of lower priority are ignored. The valid range is from 0 to 99 where: Most important = 0. Least important = 99. Default = 50.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c34d024bce81
unity_docs
scripting
In Unity's 'Place Light Probes with the Editor', what is 'Placing Light Probes' and how does it work?
To move, add or remove Light Probes in a Light Probe Group, do the following: Select the Light Probe Group in the Hierarchy window or the Scene view. In the Scene view , in the Tools overlay , select the Edit Light Probe Group tool. When editing a Light Probe Group, you can manipulate individual Light Probes in a simil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_01f575a0cfa4
unity_docs
rendering
Explain 'Normal maps' in Unity.
Resources for using normal map textures to add surface detail such as bumps, grooves, and scratches that catch the light. Page Description Introduction to surface normals Learn about surface normals, which are the perpendicular direction that point away from the surface. Introduction to normal maps Learn about how norm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_977bf2ec16a1
unity_docs
physics
Show me a Unity C# example demonstrating `Collision.gameObject`.
Collision.gameObject public GameObject gameObject ; Description The GameObject whose collider you are colliding with. (Read Only). This is the GameObject that is colliding with your GameObject. Access this to check properties of the colliding GameObject, for example, the GameObject’s name and tag. ```cshar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a584eaa3cd9
unity_docs
rendering
What are the parameters of `CubemapArray.GetPixels32` in Unity?
Returns Color32[] An array that contains the pixel colors. Description Gets the pixel color data for a mipmap level of a face of a slice as Color32 structs. This method gets pixel data from the texture in CPU memory. Texture.isReadable must be true . The array contains the pixels row by row, starting at the bottom left...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ffface0fcd51
unity_docs
xr
What is `XR.XRDisplaySubsystem.XRRenderPass.renderTargetDesc` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.XRRenderPass.renderTargetDesc public RenderTextureDescriptor renderTargetDesc ; Description Descriptor that can be passed to RenderTexture.GetTemporary to create temporary textures that match the XR Display render target.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04294e1b1dff
unity_docs
scripting
What is `Toolbars.EditorToolbarButton` in Unity? Explain its purpose and usage.
EditorToolbarButton class in UnityEditor.Toolbars / Inherits from: UIElements.ToolbarButton Description A clickable button used with EditorToolbarElementAttribute . Properties Property Description icon The icon associated with the element. text The text associated with the element. Constructors Construct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_069d29ab27b1
unity_docs
rendering
Give me an overview of the `SkinQuality` class in Unity.
SkinQuality enumeration Description The maximum number of bones affecting a single vertex. Additional resources: SkinnedMeshRenderer.quality , QualitySettings.skinWeights . Properties Property Description Auto Chooses the number of bones from the number current QualitySettings. (Default) Bone1 Use only 1 bo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_643aa478652c
unity_docs
input
What is `Experimental.GraphView.TokenNode.input` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. TokenNode.input public Experimental.GraphView.Port input ; Description The input Port of the TokenNode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_262c044a8700
unity_docs
editor
What is `EditorGUIUtility.hierarchyMode` in Unity? Explain its purpose and usage.
EditorGUIUtility.hierarchyMode public static bool hierarchyMode ; Description Is the Editor GUI in hierarchy mode? In hierarchy mode, EditorGUI.Foldout controls are positioned with the foldout triangle to the left of the specified Rect for the control, rather than being inside the Rect. This way, the label ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_39a6c0b8b457
unity_docs
scripting
Explain 'LayerMaskField' in Unity.
A LayerMaskField allows the users to select one or more layers from a list of available layers . Note : To align a LayerMaskField with other fields in an Inspector window, simply apply the.unity-base-field__aligned USS class to it. For more information, refer to BaseField . ## Create a LayerMaskField You can create a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8187a7782594
unity_docs
rendering
What is `ShaderData.GetSerializedSubshader` in Unity? Explain its purpose and usage.
ShaderData.GetSerializedSubshader Declaration public ShaderData.Subshader GetSerializedSubshader (int index ); Parameters Parameter Description index The index of the serialized subshader. Returns Subshader The associated serialized subshader or null if none exists. Description Obtains the serializ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6e9b7a4d7e3a
github
scripting
Write a Unity C# script called Console Commands
```csharp using UnityEngine; namespace InGame_Console.InGame_Console_System.Scripts.Predefined_Commands { internal class ConsoleCommands { static O2_IGConsole console => Object.FindAnyObjectByType<O2_IGConsole>(); [ConsoleCommand("/TestConsole.RandomLog")] static void RandomLo...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_76d127046010
unity_docs
physics
Show me a Unity code example for 'Enable conservative rasterization in a shader'.
g , collision detection on the GPU, or visibility detection. Conservative rasterization means that the GPU generates more fragments on triangle edges; this leads to more fragment shader invocations, which can lead to increased GPU frame times. Check for hardware support using the SystemInfo.supportsConservativeRaster A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bc27e0777bad
unity_docs
rendering
Show me a Unity code example for 'Visualizing vertex data shader examples in the Built-In Render Pipeline'.
ferent ways of visualizing vertex data. For information on writing shaders, see Writing shaders . ## Visualizing UVs The following example shader visualizes the first set of UVs of a mesh . This shader is useful for debugging the coordinates. The code defines a struct called appdata as its vertex shader input. This s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24e2b03cba80
unity_docs
ui
What is `IMGUI.Controls.TreeView.DragAndDropArgs` in Unity? Explain its purpose and usage.
DragAndDropArgs struct in UnityEditor.IMGUI.Controls Description Method arguments for the HandleDragAndDrop virtual method. Properties Property Description dragAndDropPosition When dragging items the current drag can have the following 3 positions relative to the items: Upon an item, Between two items or Out...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7528f79a6bed_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A base class for MonoBehaviours that can beinstantiatedor addedto a with ten arguments passed to the function of the created instance.Instances of classes inheriting from receive the arguments via the method where they can be assigned to member fields or properties. Type of the first argument received in the functi...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_aa8674baabe2
unity_docs
rendering
What is `Rendering.RenderPipelineAsset.defaultSpeedTree8Shader` in Unity? Explain its purpose and usage.
RenderPipelineAsset.defaultSpeedTree8Shader public Shader defaultSpeedTree8Shader ; Description Return the default SpeedTree v8 Shader for this pipeline. This shader will be used during the import process of SpeedTree v8 assets. If null is returned, the default "Nature/SpeedTree8" will be used.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_304b5fe3d9a3
unity_docs
rendering
What is `Camera.Render` in Unity? Explain its purpose and usage.
Camera.Render Declaration public void Render (); Description Render the camera manually. This will render the camera. It will use the camera's clear flags, target texture and all other settings. The camera will send OnPreCull , OnPreRender and OnPostRender to any scripts attached, and render any eventual ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b1cef6a01ed
unity_docs
audio
What is `AudioSource.maxDistance` in Unity? Explain its purpose and usage.
AudioSource.maxDistance public float maxDistance ; Description The distance where sound either becomes inaudible or stops attenuation, depending on the rolloff mode. AudioRolloffMode.Linear : For the linear rolloff mode, the maxDistance is the point where the volume reaches zero and the sound becomes inaudib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80638ee8b9c8
unity_docs
rendering
What is `PlayerSettings.enable360StereoCapture` in Unity? Explain its purpose and usage.
PlayerSettings.enable360StereoCapture public static bool enable360StereoCapture ; Description Enable 360 Stereo Capture support on the current build target. When enabled, the standalone player includes shader variants with 360 stereo capture support (currently only on Windows/OSX). The 360 stereo capture shade...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27f27f485666
unity_docs
scripting
What is `UIElements.INotifyValueChangedExtensions.RegisterValueChangedCallback` in Unity? Explain its purpose and usage.
INotifyValueChangedExtensions.RegisterValueChangedCallback Declaration public static bool RegisterValueChangedCallback (INotifyValueChanged<T> control , EventCallback<ChangeEvent<T>> callback ); Description Registers this callback to receive ChangeEvent_1 when the value is changed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e10b8d5ae2f9
unity_docs
rendering
What is `GraphicsBuffer.LockBufferForWrite` in Unity? Explain its purpose and usage.
GraphicsBuffer.LockBufferForWrite Declaration public NativeArray<T> LockBufferForWrite (int bufferStartIndex , int count ); Parameters Parameter Description bufferStartIndex The index of an element where the write operation begins. count Maximum number of elements which will be written Returns NativeArr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_54fa39f6de35
unity_docs
rendering
In Unity's 'Optimize shaders', what is 'Avoid repeated calculations' and how does it work?
To avoid shaders repeating calculations, do the following for example: Move calculations from the fragment shader to the vertex shader , so they run only for every vertex, not every fragment. Do calculations in a C# script instead, then use the calculated value in the shader. Avoid unnecessary calculations. For example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdeb9a517829
unity_docs
math
What are the parameters of `Rendering.SphericalHarmonicsL2.Evaluate` in Unity?
Description Evaluates the spherical harmonics for each given direction. The directions and results arrays must have the same size. ```csharp using System.Collections; using UnityEngine;public class ExampleClass : MonoBehaviour { void Start() { UnityEngine.Rendering.SphericalHarmonicsL2 sh2; Ligh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_993a6bf7bf3b
unity_docs
scripting
What is `VideoClipImporter.GetResizeHeight` in Unity? Explain its purpose and usage.
VideoClipImporter.GetResizeHeight Declaration public int GetResizeHeight ( VideoResizeMode mode ); Parameters Parameter Description mode Mode for which the height is queried. Returns int Height for the specified resize mode. Description Get the resulting height of the resize operation for the specif...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_998e1c65ad77
unity_docs
physics
Show me a Unity code example for 'Image'.
an image You must use either UXML or C# code to add an Image element in your UI and provide the image source to the --unity-image USS custom property. You can set the image scale mode with the --unity-image-size USS custom property. You can also set the image tint color with the --unity-image-tint-color USS custom pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_238bb309fb3f
unity_docs
rendering
In Unity's 'Console window reference', what is 'Console window interface' and how does it work?
To open the Console, from Unity’s main menu go to Window > General > Console . A . The Console toolbar has options for controlling how to display messages, and for searching and filtering messages. B . The Console window menu has options for opening Log files , controlling how much of each message is visible in the lis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1564a7fd62d6
unity_docs
rendering
What is `TextureImporterSettings.mipmapFadeDistanceEnd` in Unity? Explain its purpose and usage.
TextureImporterSettings.mipmapFadeDistanceEnd public int mipmapFadeDistanceEnd ; Description Mip level where texture is faded out to gray completely. Additional resources: mipmapEnabled , fadeOut , mipmapFadeDistanceStart .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e3cac623cb4
unity_docs
scripting
What is `Events.UnityEventTools.AddBoolPersistentListener` in Unity? Explain its purpose and usage.
UnityEventTools.AddBoolPersistentListener Declaration public static void AddBoolPersistentListener ( Events.UnityEventBase unityEvent , UnityAction<bool> call , bool argument ); Parameters Parameter Description unityEvent Event to modify. call Function to call. argument Argument to use when invoking. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37ec43cd7e81
unity_docs
editor
What are the parameters of `QualitySettings.TryExcludePlatformAt` in Unity?
Returns bool True if no errors were found. Description [Editor Only] Excludes a platform for the given Quality Level. ```csharp public void ExcludeQualityLevelForPlatform(int qualityLevelToExclude, BuildTarget platformToExclude) { var activeBuildTargetGroup = BuildPipeline.GetBuildTargetGroup(platformToExclude); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2701b6b58c00
unity_docs
physics
What is `Rigidbody.useGravity` in Unity? Explain its purpose and usage.
Rigidbody.useGravity public bool useGravity ; Description Controls whether gravity affects this rigidbody. If set to false the rigidbody will behave as in outer space. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public Collider coll; void Start() { coll...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3362efe499b
unity_docs
editor
What is `Device.SystemInfo.usesLoadStoreActions` in Unity? Explain its purpose and usage.
SystemInfo.usesLoadStoreActions public static bool usesLoadStoreActions ; Description This has the same functionality as SystemInfo.usesLoadStoreActions and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b0854e11e59
unity_docs
rendering
Show me a Unity C# example demonstrating `Cubemap.GetPixels`.
l data more quickly, use GetPixelData instead. A single call to GetPixels is usually faster than multiple calls to GetPixel , especially for large textures. If GetPixels fails, Unity throws an exception. GetPixels might fail if the array contains too much data. Use GetPixelData instead for very large texture...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8af0ebb5179
unity_docs
scripting
What is `BodyDof` in Unity? Explain its purpose and usage.
BodyDof enumeration Description Enumeration of all the muscles in the body. These muscles are a sub-part of a human part. Additional resources: HumanPartDof . Properties Property Description SpineFrontBack The spine front-back muscle. SpineLeftRight The spine left-right muscle. SpineRollLeftRight The spine ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d303b82e763
unity_docs
editor
What is `EditorGUI.TextArea` in Unity? Explain its purpose and usage.
EditorGUI.TextArea Declaration public static string TextArea ( Rect position , string text , GUIStyle style = EditorStyles.textField); Parameters Parameter Description position Rectangle on the screen to use for the text field. text The text to edit. style Optional GUIStyle . Returns string Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd72b61a7180
unity_docs
physics
What is `AssetModificationProcessor` in Unity? Explain its purpose and usage.
AssetModificationProcessor class in UnityEditor Description AssetModificationProcessor lets you hook into saving of serialized assets and scenes which are edited inside Unity. This lets you prevent writing of assets by Unity for integration with VCS solutions like Perforce which require locking of files. This ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15926369bc50
unity_docs
math
What is `ModifiableContactPair.GetPoint` in Unity? Explain its purpose and usage.
ModifiableContactPair.GetPoint Declaration public Vector3 GetPoint (int i ); Parameters Parameter Description i Index of the contact point. Returns Vector3 The location of a contact point. Description Get the location of a particular contact point in this contact pair. The returned value is in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9fe8dc08ddff
unity_docs
scripting
What is `SystemLanguage.SerboCroatian` in Unity? Explain its purpose and usage.
SystemLanguage.SerboCroatian Description Serbo-Croatian. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Serbo-Croatian language if (Application.systemLanguage == SystemLanguage.SerboCroatian) { //Outputs into consol...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2fdf20f34ae5
unity_docs
performance
Explain 'App thinning' in Unity.
App thinning is an optimization process that lets you create applications that use most device features while occupying minimum disk space. For more information, refer to What is app thinning? (Apple). You can implement the following two major components for app thinning with Unity: Topic Description On-demand resource...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_840e563b44bf
unity_docs
scripting
What is `PlayerLoop.PostLateUpdate` in Unity? Explain its purpose and usage.
PostLateUpdate struct in UnityEngine.PlayerLoop / Implemented in: UnityEngine.CoreModule Description Update phase in the native player loop. This is the C# representation of an update phase in the native player loop. It can only be used to identify the update phase in native.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_179b8c70fc5e
unity_docs
input
In Unity's 'TextField', what is 'Set a placeholder text' and how does it work?
You can set a placeholder text for the element. You can also hide the placeholder text on focus. Note : The placeholder text won’t display if you set a value for the element. To unset a value in UI Builder, right-click the Value field in the element’s Inspector tab and select Unset . In C#, use the placeholder and the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1855f0ceb2ea
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.Profiling.ProfilerMarker`.
nce marker used for profiling arbitrary code blocks. Use ProfilerMarker to mark up script code blocks for the Profiler. The information produced by markers is displayed in the CPU Profiler and can be also captured with Recorder . During development (in Editor and Development Players) this can help to get perform...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_48c8993dba65
unity_docs
scripting
What is `ParticleSystem.ColorOverLifetimeModule.enabled` in Unity? Explain its purpose and usage.
ParticleSystem.ColorOverLifetimeModule.enabled public bool enabled ; Description Specifies whether the ColorOverLifetimeModule is enabled or disabled. Additional resources: ParticleSystem.colorOverLifetime . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d55266ba4384
unity_docs
scripting
What is `Undo.RegisterCreatedObjectUndo` in Unity? Explain its purpose and usage.
Undo.RegisterCreatedObjectUndo Declaration public static void RegisterCreatedObjectUndo ( Object objectToUndo , string name ); Parameters Parameter Description objectToUndo The newly created object. This object is destroyed when the undo operation is performed. When the value is a GameObject, Unity registe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6cc9c4a824e
unity_docs
rendering
What is `CubemapArray.GetPixels` in Unity? Explain its purpose and usage.
CubemapArray.GetPixels Declaration public Color[] GetPixels ( CubemapFace face , int arrayElement , int miplevel ); Declaration public Color[] GetPixels ( CubemapFace face , int arrayElement ); Parameters Parameter Description face The CubemapFace to read from. miplevel The mipmap level to get...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1db42c4b10a7
unity_docs
scripting
What is `iOSAppInBackgroundBehavior` in Unity? Explain its purpose and usage.
iOSAppInBackgroundBehavior enumeration Description Application behavior when entering background. Properties Property Description Custom Custom background behavior, see iOSBackgroundMode for specific background modes. Suspend Application should suspend execution when entering background.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2768666b09c
unity_docs
editor
What is `Progress.Options` in Unity? Explain its purpose and usage.
Options enumeration Description Options that define how a progress indicator behaves. Properties Property Description None A progress indicator that starts with no other options activated. This is the default. Sticky A sticky progress indicator displays progress information even after the task is complete. The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9820ef19136d
unity_docs
editor
Give me an overview of the `CustomPropertyDrawer` class in Unity.
CustomPropertyDrawer class in UnityEditor Description Tells a custom PropertyDrawer or DecoratorDrawer which run-time Serializable class or PropertyAttribute it's a drawer for. When you make a custom PropertyDrawer or DecoratorDrawer , you need put this attribute on the drawer class. If the drawer is for...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e56a0a0183da
unity_docs
rendering
What is `Rendering.CullingResults.visibleReflectionProbes` in Unity? Explain its purpose and usage.
CullingResults.visibleReflectionProbes public NativeArray<VisibleReflectionProbe> visibleReflectionProbes ; Description Array of visible reflection probes. Additional resources: VisibleReflectionProbe , visibleLights .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b2f0c4e8031
unity_docs
physics
Give me an overview of the `ParticleSystemGravitySource` class in Unity.
ParticleSystemGravitySource enumeration Description Options for which physics system to use the gravity setting from. Properties Property Description Physics3D Use gravity from the 3D physics system. Physics2D Use gravity from the 2D physics system.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.