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_cb249b9ee1aa
unity_docs
scripting
In Unity's 'Add a custom Web template', what is 'Create a custom template' and how does it work?
The easiest way to create a custom Web template is to copy a built-in template folder then modify it to meet your needs. Each template folder contains an index.html file along with any other resources the page needs, such as images or stylesheets. To create a custom template: Copy the built-in Default or Minimal templa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b3a193c055ef
unity_docs
scripting
Show me a Unity code example for 'EnumField'.
An EnumField lets users select a value from an enumeration. Note : To align an EnumField 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 an EnumField You can create an EnumField with UI Builder, UXML, and C#. As...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6822f9b5e667
unity_docs
performance
Explain 'Set up your JavaScript plug-in' in Unity.
You can call functions from your JavaScript plug-ins in your Unity projects. Unity supports two JavaScript plug-in file types that let you add JavaScript code to your Unity project:.jslib.jspre Note : Unity currently supports ECMAScript 5 (ES5) syntax in .jslib and .jspre files. ES6 syntax isn’t yet supported. If you w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f53581f49fb4
unity_docs
scripting
In Unity's 'Create a list view runtime UI', what is 'Create the main UI Document' and how does it work?
Create the main view UI Document and a USS file to style the visual elements . Add two visual elements as containers in the UI Document: one that contains the list of character names and another that contains the selected character’s details. Create a project in Unity with any template. In the Project window , create a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_cf41fd5ba932_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Whether to use the specified head transform or controller transform to direct the XR Origin's movement for the left hand. Signature: ```csharp public MovementDirection leftHandMovementDirection ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_e79cf13be46b
unity_docs
scripting
What is `Search.SearchUtils.GetMainAssetInstanceID` in Unity? Explain its purpose and usage.
SearchUtils.GetMainAssetInstanceID Declaration public static int GetMainAssetInstanceID (string assetPath ); Parameters Parameter Description assetPath Asset path. Returns int Instance ID. Description Returns an asset instance ID. This function try not to load the asset if possible.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb9197c92748
unity_docs
scripting
Give me an overview of the `SerializedPropertyNumericType` class in Unity.
SerializedPropertyNumericType enumeration Description Returns the precise type for Integer or Floating point properties. Additional resources: SerializedProperty.numericType , SerializedProperty.intValue , SerializedProperty.uintValue , SerializedProperty.longValue , SerializedProperty.ulongValue , Serialize...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1724f442d80c_doc_7
github
scripting
What does `ConvertUnitsAndChangeBasis` do in this Unity script? Explain its purpose and signature.
Applies change-of-basis conversions and distance conversions to a GeometryPool. Signature: ```csharp public static void ConvertUnitsAndChangeBasis(GeometryPool pool, SceneStatePayload payload) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d5f4ac9168b0
unity_docs
scripting
What is `AndroidJNI.SetDoubleField` in Unity? Explain its purpose and usage.
AndroidJNI.SetDoubleField Declaration public static void SetDoubleField (IntPtr obj , IntPtr fieldID , double val ); Description Sets the value of an instance field of the specified object. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b704104646d7
unity_docs
networking
What is `Android.AndroidScreenLayoutSize.Small` in Unity? Explain its purpose and usage.
AndroidScreenLayoutSize.Small Description Mirrors the Android property value SCREENLAYOUT_SIZE_SMALL . For information about the property value, refer to the Android developer documentation on SCREENLAYOUT_SIZE_SMALL .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ad45f66e81ef
unity_docs
scripting
What is `Experimental.GraphView.ContentDragger.CalculatePosition` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ContentDragger.CalculatePosition Declaration protected Rect CalculatePosition (float x , float y , float width , float height ); Parameters Parameter Description x New x position. y New y position. width Element ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1dbd9480b482
unity_docs
editor
What is `Callbacks.DidReloadScripts` in Unity? Explain its purpose and usage.
DidReloadScripts class in UnityEditor.Callbacks / Inherits from: CallbackOrderAttribute Description Add this attribute to a method to get a notification after scripts have been reloaded. DidReloadScripts has an option to provide an order index. This lets you change the order in which the callback is invoked. (B...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_413b3b77be12
unity_docs
rendering
What is `Rendering.CullingResults.ComputeSpotShadowMatricesAndCullingPrimitives` in Unity? Explain its purpose and usage.
CullingResults.ComputeSpotShadowMatricesAndCullingPrimitives Declaration public bool ComputeSpotShadowMatricesAndCullingPrimitives (int activeLightIndex , out Matrix4x4 viewMatrix , out Matrix4x4 projMatrix , out Rendering.ShadowSplitData shadowSplitData ); Parameters Parameter Description activeLigh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bfa990b6e257
unity_docs
rendering
What is `Rendering.SupportedRenderingFeatures.LightmapMixedBakeModes` in Unity? Explain its purpose and usage.
LightmapMixedBakeModes enumeration Description Same as MixedLightingMode for baking, but is used to determine what is supported by the pipeline. Properties Property Description None No mode is supported. IndirectOnly Same as MixedLightingMode.IndirectOnly but determines if it is supported by the pipeline. S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fbf0b9142ec3
unity_docs
rendering
What is `Rendering.CullingResults.SetReflectionProbeIndexMap` in Unity? Explain its purpose and usage.
CullingResults.SetReflectionProbeIndexMap Declaration public void SetReflectionProbeIndexMap (NativeArray<int> lightIndexMap ); Parameters Parameter Description lightIndexMap Array with reflection probe indices that map from VisibleReflectionProbe to internal per-object reflection probe lists. Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2bdd06f3b691
unity_docs
rendering
Give me an overview of the `RenderingPath` class in Unity.
RenderingPath enumeration Description Rendering path of a Camera . Properties Property Description UsePlayerSettings Use Player Settings. VertexLit Vertex Lit. Forward Forward Rendering. DeferredShading Deferred Shading.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9925a48a699
unity_docs
math
What is `HumanPoseHandler.GetInternalAvatarPose` in Unity? Explain its purpose and usage.
HumanPoseHandler.GetInternalAvatarPose Declaration public void GetInternalAvatarPose (NativeArray<float> avatarPose ); Parameters Parameter Description avatarPose The output avatar pose. The avatar pose is expressed as an array of floats. The floats represent the translation and rotation of the joints as loc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8dc848d10e5a
unity_docs
animation
What is `Animations.LookAtConstraint.RemoveSource` in Unity? Explain its purpose and usage.
LookAtConstraint.RemoveSource Declaration public void RemoveSource (int index ); Parameters Parameter Description index The index of the source to remove. Description Removes a source from the component. Throws InvalidOperationException, if the list of sources is empty. Throws ArgumentOutOfRangeException,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2be6b4d6ba5d
unity_docs
rendering
Show me a Unity code example for 'Introduction to AssetBundles'.
s compilation has been made conditional with an #if directive and the associated symbol isn’t defined at AssetBundle build time, then Unity doesn’t include that field in the AssetBundle. For example, in the following code snippet the always field is unconditionally included in the AssetBundle, but the experimental fiel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bdd8ccf03b4
unity_docs
math
What is `ShaderUtil.GetShaderMessages` in Unity? Explain its purpose and usage.
ShaderUtil.GetShaderMessages Declaration public static ShaderMessage[] GetShaderMessages ( Shader s , Rendering.ShaderCompilerPlatform platform ); Declaration public static ShaderMessage[] GetShaderMessages ( Shader s ); Parameters Parameter Description s The Shader instance to check for messages...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93b4f2a2619f
unity_docs
rendering
What is `CustomRenderTexture.Initialize` in Unity? Explain its purpose and usage.
CustomRenderTexture.Initialize Declaration public void Initialize (); Description Initializes the Custom Render Texture at the start of the next frame. Unity calls /Initialise()/ before / CustomRenderTexture.Update /. You can use /initialize()/ to reset a Custom Render Texture or to execute two passes after ea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b69cd55bbab
unity_docs
rendering
What is `Rendering.ScriptableRenderContext.BeginScopedRenderPass` in Unity? Explain its purpose and usage.
ScriptableRenderContext.BeginScopedRenderPass Declaration public Rendering.ScopedRenderPass BeginScopedRenderPass (int width , int height , int samples , NativeArray<AttachmentDescriptor> attachments , int depthAttachmentIndex ); Parameters Parameter Description width The width of the render pass surfa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0de564fbfd1e
unity_docs
scripting
What are the parameters of `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.GetCurrentSummaryMetrics` in Unity?
Returns AsyncReadManagerSummaryMetrics A summary of the current metrics data. Description Gets a summary of the metrics collected for AsyncReadManager read operations since you started data collection or last cleared the metrics data. The returned AsyncReadManagerSummaryMetrics object provides overall statistics about ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9d0bf7c39e63
unity_docs
physics
In Unity's 'Character Joint component reference', what is 'Properties' and how does it work?
Property: Function: Edit Angular Limits Adds a visual gizmo to the Scene view that helps you edit joint angular limits. To use this gizmo, set the Angular X, Y, Z Motion to Limited and then handles appear for you to drag and adjust the joint’s rotational space. Connected Body Optional reference to the Rigidbody that th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_781c5c73f48a
unity_docs
editor
What are the parameters of `AssetDatabase.LoadAssetAtPath` in Unity?
Returns Object Returns the first asset object of type type at given path assetPath . Description Returns the first asset object of type type at given path assetPath . Some asset files may contain multiple objects. (such as a Maya file which may contain multiple Meshes and GameObjects). All paths are relative to the pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d01a4a5101b4
unity_docs
ui
What is `GUIStyle.fixedWidth` in Unity? Explain its purpose and usage.
GUIStyle.fixedWidth public float fixedWidth ; Description If non-0, any GUI elements rendered with this style will have the width specified here. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints the value of fixedWidth. void OnGUI() { Debug.Log(GUI.skin.button.fixedWidth); } } `...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eab177880fad
unity_docs
editor
What is `EditorWindow.OnHierarchyChange` in Unity? Explain its purpose and usage.
EditorWindow.OnHierarchyChange() Description Handler for message that is sent when an object or group of objects in the hierarchy changes. Actions that trigger this message include creating, renaming, reparenting, or destroying objects in the current hierarchy, as well as loading, unloading, renaming, or reordering...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3000552cdcd
unity_docs
rendering
What is `MaterialPropertyBlock.SetBuffer` in Unity? Explain its purpose and usage.
MaterialPropertyBlock.SetBuffer Declaration public void SetBuffer (string name , ComputeBuffer value ); Declaration public void SetBuffer (int nameID , ComputeBuffer value ); Declaration public void SetBuffer (string name , GraphicsBuffer value ); Declaration public void SetBuffer (int nameI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d2784b5a56c4_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Use this component with a HandGrabAPI so it uses the Raw pinch detectorinstead of the standard Pinch and Palm finger APIS. Specially useful forControllersAsHands since it uses the same value as the trigger presses. Signature: ```csharp public class FingerRawPinchInjector : MonoBehaviour ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_451bb4c1474f
unity_docs
scripting
Show me a Unity C# example demonstrating `Color.b`.
Color.b public float b ; Description Blue component of the color. The value ranges from 0 to 1. ```csharp //Attach this script to a GameObject with a Renderer attached to it //Use the sliders in Play Mode to change the Color of the GameObject's Materialusing UnityEngine;public class Example : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2cfc0dfa7335
unity_docs
physics
Show me a Unity code example for 'Configure a Web Canvas size'.
e automatic size synchronization. To do so, in the index.html file of the Web template, set the Unity Instance configuration variable to false: matchWebGLToCanvasSize=false . When this is set, Unity leaves the render target size of the canvas as-is but you can always configure the size, if required. For example, to cha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_97e53f9fcc07_doc_5
github
scripting
What does `IsInstantiated` do in this Unity script? Explain its purpose and signature.
Checks if loaded scene contains singleton instance.Checked scene.True if singleton is instantiated in given loaded scene, otherwise false. Signature: ```csharp public static bool IsInstantiated(Scene scene) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_386fc9da3400
unity_docs
editor
What is `Search.IFilterNode` in Unity? Explain its purpose and usage.
IFilterNode interface in UnityEditor.Search Implements interfaces: IQueryNode Description Interface representing a filter node. Properties Property Description filterId The filter identifier. filterValue The filter value. This can be null or empty if the value has not been written yet. operatorId The operat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_770c0cfa0272
unity_docs
scripting
What is `SystemLanguage.Italian` in Unity? Explain its purpose and usage.
SystemLanguage.Italian Description Italian. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Italian language if (Application.systemLanguage == SystemLanguage.Italian) { //Outputs into console that the system is Itali...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9abcd8656d86
unity_docs
scripting
What is `SceneTemplate.SceneTemplateService.CreateSceneTemplate` in Unity? Explain its purpose and usage.
SceneTemplateService.CreateSceneTemplate Declaration public static SceneTemplate.SceneTemplateAsset CreateSceneTemplate (string sceneTemplatePath ); Parameters Parameter Description sceneTemplatePath The path to the new Scene template asset. Returns SceneTemplateAsset Returns a new Scene template Asset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4a8357015e20
unity_docs
ui
Explain 'Local folder or tarball paths' in Unity.
You can specify a dependency as any local folder or tarball that contains a package. This feature is helpful for local offline development and testing. Note : If you want to reference a package on the local file system as a Git dependency, use the file://<url> format instead. Unity doesn’t support directly referencing ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_13
github
scripting
What does `OnMouseDownAsObservable` do in this Unity script? Explain its purpose and signature.
OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider. Signature: ```csharp public static IObservable<Unit> OnMouseDownAsObservable(this Component component) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_720390176e77
unity_docs
scripting
Explain 'Compile a static library as a Unity plug-in' in Unity.
You can compile libraries with Emscripten and use the libraries in Unity. It can be more beneficial to call functions from libraries that encapsulate C++ code rather than C++ code directly from the plug-in directory. The benefits include: Your code is easier to integrate with your Web Unity project. Your code can perfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fad3733263d7
unity_docs
editor
What is `AssetDatabase.LoadAllAssetRepresentationsAtPath` in Unity? Explain its purpose and usage.
AssetDatabase.LoadAllAssetRepresentationsAtPath Declaration public static Object[] LoadAllAssetRepresentationsAtPath (string assetPath ); Parameters Parameter Description assetPath The path of the asset. Returns Object[] Returns all sub-assets at assetPath . Description Obtains all sub-assets at as...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca4f5a6e16ee
unity_docs
scripting
What is `UIElements.Experimental.PointerOverLinkTagEvent.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PointerOverLinkTagEvent Constructor Declaration public PointerOverLinkTagEvent (); Description Constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7f8094043ed8
unity_docs
rendering
In Unity's 'Configure a skybox with a Skybox Shader', what is '6 Sided Skybox shader' and how does it work?
This skybox Shader generates a skybox from six separate Textures. Each texture represents a view of the sky along a particular world axis. To illustrate this, think of the Scene as being inside a cube. Each Texture represents one of the interior faces of the cube and all six combine to create a seamless environment. To...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_79f588963556
github
scripting
Write a Unity C# UI script for Pointer
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; namespace VrBlocks { public class Pointer : MonoBehaviour { public bool Active { get; set; } = true; public ControllerButton Trigger { get; } = new ControllerButton(); private void Start() ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_4a064c7b9c9b
unity_docs
scripting
What is `Device.Application.sandboxType` in Unity? Explain its purpose and usage.
Application.sandboxType public static ApplicationSandboxType sandboxType ; Description This has the same functionality as Application.sandboxType . At the moment, the Device Simulator doesn't support simulation of this property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d35333d1dcce_doc_7
github
scripting
What does `OnDestroy` do in this Unity script? Explain its purpose and signature.
If you override this Unity Magic™ method, BE SURE TO CALL base.OnDestroy() from your method Signature: ```csharp protected virtual void OnDestroy() => UnsubscribeAll(); ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
gh_339eb2d93a7b_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
abstract class with automatic registration in .Instances will register themselves for job scheduling in the OnEnable message and unregister in the OnDisable message. Signature: ```csharp public abstract class AJobBehaviour<TData> : MonoBehaviour, ITransformJobUpdatable<TData> where TData : struct, IUpdateTrans...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee449a7d7c6d
unity_docs
input
What is `AI.NavMesh.SetAreaCost` in Unity? Explain its purpose and usage.
NavMesh.SetAreaCost Declaration public static void SetAreaCost (int areaIndex , float cost ); Parameters Parameter Description areaIndex Index of the area to set. cost New cost. Description Sets the cost for finding path over geometry of the area type on all agents. This will replace any custom area co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17da6af123b7
unity_docs
animation
What is `UIElements.Experimental.ValueAnimation_1` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ValueAnimation<T0> class in UnityEngine.UIElements.Experimental / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IValueAnimation Description Implementation object for transition animations. Propertie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0a80c8eb878a
unity_docs
scripting
In Unity's 'Place a Reflection Probe', what is 'Positioning probes' and how does it work?
The position of a probe is primarily determined by the position of its GameObject and so you can simply drag the object to the desired location. Having done this, you should set the probe’s zone of effect; this is an axis-aligned box shape whose dimensions are set by the Box Size property. You can set the size values d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4fb6a15543a
unity_docs
editor
What is `Experimental.GraphView.PortSource_1` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PortSource<T0> class in UnityEditor.Experimental.GraphView Description Port source. Constructors Constructor Description PortSource_1 Port source constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b09a0f6cedcd
unity_docs
physics
Explain 'Global Illumination (GI) cache' in Unity.
The Global Illumination (GI) cache is an internal data cache that the Unity Editor uses to store intermediate files when it precomputes lighting data for Baked Global Illumination and Enlighten Realtime Global Illumination. By storing this data in a cache, Unity can speed up subsequent precomputations. All Unity projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8828b30889ea
unity_docs
scripting
Explain 'Create and export asset packages' in Unity.
To share scenes , samples, tools, or other assets, you can export them as an asset package in the.unitypackage format. Asset packages are a convenient way to copy several assets or an entire scene from one project to another quickly, with little additional overhead. If you want to distribute assets in a more formal way...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e736e326bf86
unity_docs
scripting
Explain 'Add and remove asset packages' in Unity.
You can perform a variety of package management tasks by using the Package Manager window. Follow these tasks to manage asset packages . For information about managing UPM packages or feature sets , refer to Add and remove UPM packages or feature sets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4044a1fa208
unity_docs
physics
What is `PhysicsSceneExtensions.GetPhysicsScene` in Unity? Explain its purpose and usage.
PhysicsSceneExtensions.GetPhysicsScene Declaration public static PhysicsScene GetPhysicsScene ( SceneManagement.Scene scene ); Parameters Parameter Description scene The Scene from which to return the 3D physics Scene. Returns PhysicsScene The 3D physics Scene used by the Scene. Description An ext...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea770619b2f3
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.SearchItemOptions.Ellipsis`.
SearchItemOptions.Ellipsis Description If the description is longer than the width of the search view, truncates the description and adds an ellipsis. ``` private static SearchItem SearchLogEntry(SearchContext context, SearchProvider provider, LogEntry logEntry) { if (!SearchUtils.MatchSearchGroups(context, logEnt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7e63fe6825dc
unity_docs
rendering
Explain 'Combine meshes using batching' in Unity.
Resources and approaches for improving performance by combining static GameObjects or moving GameObjects into fewer draw calls. Page Description Introduction to batching Understand how Unity creates batches of static and dynamic GameObjects to reduce draw calls. Set up GameObjects for batching Get the best results from...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9bfb3c461c62
unity_docs
scripting
Explain 'Calling Java and Kotlin plug-in code from C# scripts' in Unity.
Unity allows you to call Java and Kotlin code directly from C# scripts and integrate Android-specific features in your Unity project. To achieve this, Unity provides C# APIs that communicate with the Android Java Native Interface (JNI) through C++. You can choose between low level and high level APIs to interact with t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_195907d4c0b5
unity_docs
rendering
In Unity's 'Debug Draw Modes for lighting reference', what is 'Shadow Cascades' and how does it work?
The Shadow Cascades mode displays a different color for each shadow cascade . The colors match the shadow cascade colors in the Shadows section of the Quality Settings window . You can use this mode to help you adjust the shadow distance, cascade count and cascade shadow splits. This mode uses the Scene view far plane ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_24726516ad74
unity_docs
scripting
What is `UIElements.StyleFloat` in Unity? Explain its purpose and usage.
StyleFloat struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IStyleValue<T0> Description Style value that can be either a float or a StyleKeyword . Properties Property Description keyword The style keyword. value The float value. Constructor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7dff8b01fc3
unity_docs
ui
Show me a Unity C# example demonstrating `EditorGUI.IntSlider`.
he slider. value The value the slider shows. This determines the position of the draggable thumb. leftValue The value at the left end of the slider. rightValue The value at the right end of the slider. Returns int The value that has been set by the user. Description Makes a slider the user can drag to cha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f37de3ffd31e
unity_docs
scripting
What is `Progress.UnregisterPauseCallback` in Unity? Explain its purpose and usage.
Progress.UnregisterPauseCallback Declaration public static void UnregisterPauseCallback (int id ); Parameters Parameter Description id The progress indicator's unique ID. Description Unregisters a previously registered progress pause callback. Additional resources: Progress.RegisterPauseCallback , Progr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ebaf0c6b3a9
unity_docs
performance
What is `Jobs.IJobParallelForTransformExtensions.RunReadOnly` in Unity? Explain its purpose and usage.
IJobParallelForTransformExtensions.RunReadOnly Declaration public static void RunReadOnly (T jobData , Jobs.TransformAccessArray transforms ); Parameters Parameter Description transforms The TransformAccessArray to run this job on. jobData The job to run. Description Runs an IJobParallelForTransfor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e7bd2c46cf6e
unity_docs
xr
What is `Overlays.Overlay.CreateContent` in Unity? Explain its purpose and usage.
Overlay.CreateContent Declaration public UIElements.VisualElement CreateContent ( Overlays.Layout requestedLayout ); Parameters Parameter Description requestedLayout The layout that contents should be styled to match. Returns VisualElement A new Visual Element containing the contents of the Overlay. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77f1e5162fa4
unity_docs
performance
What are the parameters of `Unity.Profiling.ProfilerMarker.Begin` in Unity?
Description Begin profiling a piece of code marked with a custom name defined by this instance of ProfilerMarker . Always use End to close a started section of an instrumented code. Code marked with Begin and End will show up in the Profiler hierarchy. Use Recorder to obtain per-frame timings in the Player. Note: Both ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d14a35b8f70
unity_docs
scripting
What is `Toolbars.EditorToolbarDropdown` in Unity? Explain its purpose and usage.
EditorToolbarDropdown class in UnityEditor.Toolbars / Inherits from: Toolbars.EditorToolbarButton Description A clickable dropdown used with EditorToolbarElementAttribute . Constructors Constructor Description EditorToolbarDropdown Constructor. Inherited Members Static Properties Property Description ico...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26902e30cac0
unity_docs
rendering
What is `AssetDatabase.IsSubAsset` in Unity? Explain its purpose and usage.
AssetDatabase.IsSubAsset Declaration public static bool IsSubAsset ( Object obj ); Declaration public static bool IsSubAsset (int instanceID ); Parameters Parameter Description obj The asset object to query. instanceID Instance ID of the asset object to query. entityId The EntityID of the asset obj...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db8ef5d1f58f
unity_docs
rendering
What is `ImageConversion.EncodeArrayToJPG` in Unity? Explain its purpose and usage.
ImageConversion.EncodeArrayToJPG Declaration public static byte[] EncodeArrayToJPG (Array array , Experimental.Rendering.GraphicsFormat format , uint width , uint height , uint rowBytes , int quality ); Parameters Parameter Description array The byte array to convert. format The pixel format of the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ab24bccfaf0
unity_docs
input
What is `Windows.Input` in Unity? Explain its purpose and usage.
Input class in UnityEngine.Windows / Implemented in: UnityEngine.CoreModule Description Provides static methods for Windows specific input manipulation. Static Methods Method Description ForwardRawInput Forwards raw input events to Unity.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f79204537d7b
unity_docs
physics
What is `UIElements.Binding.updateTrigger` in Unity? Explain its purpose and usage.
Binding.updateTrigger public UIElements.BindingUpdateTrigger updateTrigger ; Description When set to BindingUpdateTrigger.EveryUpdate , the binding instance updates in every update, regardless of the data source version.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3300c082ca79
unity_docs
scripting
What are the parameters of `Camera.ViewportToWorldPoint` in Unity?
Returns Vector3 The 3d vector in World space. Description Transforms position from viewport space into world space. Viewport space is normalized and relative to the camera. The bottom-left of the viewport is (0,0); the top-right is (1,1). The z position is in world units from the camera. Note that ViewportToWor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cdd257932fa4
unity_docs
scripting
Explain 'Migrating from MovieTexture to VideoPlayer' in Unity.
If you have projects that use the legacy MovieTexture component to download and play movies, you can update them to use the newer VideoPlayer component. To help you migrate from MovieTexture to VideoPlayer, this page provides examples of how to download and play back a movie using each component. ## MovieTexture ```c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c63c17502914
unity_docs
xr
What is `Networking.UnityWebRequest.GetRequestHeader` in Unity? Explain its purpose and usage.
UnityWebRequest.GetRequestHeader Declaration public string GetRequestHeader (string name ); Parameters Parameter Description name Name of the custom request header. Case-insensitive. Returns string The value of the custom request header. If no custom header with a matching name has been set, returns an e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_def4028f88c2
unity_docs
performance
What is `ShortcutManagement.IShortcutManager.DeleteProfile` in Unity? Explain its purpose and usage.
IShortcutManager.DeleteProfile Declaration public void DeleteProfile (string profileId ); Parameters Parameter Description profileId ID of profile to delete. Description Deletes profile with the given profile ID. Throws ArgumentNullException if profileId is null . Throws ArgumentException if profi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e601abf12664
unity_docs
editor
In Unity's 'Tooltip event', what is 'Unique properties' and how does it work?
rect : Rectangle of the hovered visual element in the panel coordinate system. tooltip : The tooltip property is a text string to display inside the tooltip box during the tooltip event. The following callback event sets the tooltip property during the event: ``` evt.tooltip = "Tooltip set by parent!"; ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_655b7d7231ce
unity_docs
editor
What is `IMGUI.Controls.ArcHandle.DrawHandle` in Unity? Explain its purpose and usage.
ArcHandle.DrawHandle Declaration public void DrawHandle (); Description A function to display this instance in the current handle camera using its current configuration. Always write properties to the handle before calling this function. Place the calls to this function inside EditorGUI.BeginChangeCheck and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a23a1718b2e9
unity_docs
scripting
In Unity's 'App slicing', what is 'Load an asset' and how does it work?
To load an Asset, create a script file named LoadBundle.cs in your Assets folder and copy in the following code. Replace textures with the name of the variant you want to load. ```csharp using UnityEngine; using UnityEngine.iOS; using System; using System.Collections; public class LoadBundle : MonoBehaviour { public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_793893b0d737
unity_docs
performance
What is `Unity.Jobs.LowLevel.Unsafe.ScheduleMode` in Unity? Explain its purpose and usage.
ScheduleMode enumeration Description Options for scheduling a managed job. Properties Property Description Run Run a job immediately on calling thread. Parallel Schedule a job to run on multiple worker threads if possible. Jobs that can't run concurrently run on one thread only. Single Schedule a job to run o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_def9c8566a50
unity_docs
scripting
What is `SceneManagement.SceneManager.SetActiveScene` in Unity? Explain its purpose and usage.
SceneManager.SetActiveScene Declaration public static bool SetActiveScene ( SceneManagement.Scene scene ); Parameters Parameter Description scene The Scene to be set. Returns bool Returns false if the Scene is not loaded yet. Description Set the Scene to be active. The active Scene is the Scene whi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d59f70a399e1
unity_docs
scripting
What is `Android.AndroidApplication.currentContext` in Unity? Explain its purpose and usage.
AndroidApplication.currentContext public static AndroidJavaObject currentContext ; Description Indicates the Java instance of the current context. For more information, refer to the Android developer documentation on Context . Note: This object is managed by Unity runtime, so do not call AndroidJavaObject....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc0dfaaa5675
unity_docs
math
What is `Tilemaps.Tilemap.SetColor` in Unity? Explain its purpose and usage.
Tilemap.SetColor Declaration public void SetColor ( Vector3Int position , Color color ); Parameters Parameter Description position Position of the Tile on the Tilemap . color Color to set the Tile to at the XYZ coordinate. Description Sets the color of a Tile given the XYZ coordinates of a cell ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cb5c8072a812
unity_docs
input
Explain 'Requirements and compatibility' in Unity.
Although the Apple TV platform (tvOS) is similar to the iOS platform, there are some differences between the two. Before developing your application for tvOS, review the requirements, compatibility notes, and known limitations. ## Xcode version support When developing for iOS, it’s recommended to use Xcode version 15...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9dde001a5b2
unity_docs
scripting
What is `Resolution` in Unity? Explain its purpose and usage.
Resolution struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Represents a display resolution. Resolution structures are returned by Screen.resolutions property. Properties Property Description height Resolution height in pixels. refreshRateRatio Resolution's vertical refresh rate...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c54c9de75247
unity_docs
scripting
In Unity's 'Mobile feature set', what is 'Getting started' and how does it work?
To get started with the Mobile feature set, the following setup is required: Enable data provider subsystems to work with Adaptive Performance. Refer to Provider Installation . Verify the Project settings for Adaptive performance.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_05f0d546bcf4
unity_docs
ui
What is `PackageManager.UI.IPackageManagerExtension.CreateExtensionUI` in Unity? Explain its purpose and usage.
IPackageManagerExtension.CreateExtensionUI Declaration public UIElements.VisualElement CreateExtensionUI (); Returns VisualElement A visual element that represents the UI or null if none. Description Creates the extension UI visual element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a18f66a1eed2
unity_docs
scripting
What is `UIElements.UxmlAttributeAttribute.ctor` in Unity? Explain its purpose and usage.
UxmlAttributeAttribute Constructor Declaration public UxmlAttributeAttribute (); Description Declares that a field or property is associated with a UXML attribute. Declaration public UxmlAttributeAttribute (string name ); Parameters Parameter Description name The name of the UXML attribute. Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_81b036b66098
unity_docs
physics
What is `TargetJoint2D.dampingRatio` in Unity? Explain its purpose and usage.
TargetJoint2D.dampingRatio public float dampingRatio ; Description The amount by which the target spring force is reduced in proportion to the movement speed. The target spring will oscillate with a certain frequency as it attempts to reestablish the target position. The higher the damping ratio, the quicker th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7254d7e858f7
unity_docs
rendering
What is `Lightmapping.Clear` in Unity? Explain its purpose and usage.
Lightmapping.Clear Declaration public static void Clear (); Description Deletes all runtime data for the currently loaded Scenes. This method deletes the following: baked and real-time lightmaps, Enlighten Realtime Global Illumination metadata, baked output on Lights, and baked and real-time data on instances (...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a5b95ad98ca
unity_docs
rendering
What are the parameters of `Cubemap.SetPixel` in Unity?
Description Sets the pixel color at coordinates ( x , y ). This method sets pixel data for the texture in CPU memory. Texture.isReadable must be true , and you must call Apply after SetPixel to upload the changed pixels to the GPU. Apply is an expensive operation because it copies all the pixels in the texture even if ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84f8c1db01fa
unity_docs
scripting
What is `Transform.position` in Unity? Explain its purpose and usage.
Transform.position public Vector3 position ; Description The world space position of the Transform. The position property of a GameObject ’s Transform , which is accessible in the Unity Editor and through scripts. Alter this value to move a GameObject . Get this value to locate the GameObject in 3D wo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30c8767193e8
unity_docs
scripting
What is `Search.SearchItem.SetField` in Unity? Explain its purpose and usage.
SearchItem.SetField Declaration public void SetField (string name , object value ); Declaration public void SetField (string name , string alias , object value ); Parameters Parameter Description name Field name. value Value to be set. alias Alias to be given to the field. Description Sets a fi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0aee750608e8
unity_docs
ui
What is `Experimental.GraphView.Pill.left` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Pill.left public UIElements.VisualElement left ; Description The VisualElement to the left of the pill.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d7f6ed95f24
unity_docs
scripting
What is `KeyCode.A` in Unity? Explain its purpose and usage.
KeyCode.A Description 'a' key. ```csharp //Attach this to a GameObject //This script tells when the A arrow key is pressed down and when it is released using UnityEngine;public class Example : MonoBehaviour { void Update() { //Detect when the A arrow key is pressed down if (Input.GetKeyDown(KeyCode.A)) Debug.L...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1269123ad1a0
unity_docs
rendering
What is `RenderTextureFormat.Depth` in Unity? Explain its purpose and usage.
RenderTextureFormat.Depth Description A depth render texture format. Depth format is used to render high precision "depth" value into a render texture. Which format is actually used depends on platform support and on the number of depth bits you request through the constructor. You can also set an exact depth-stenc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5a70eccc1afc
unity_docs
xr
Explain 'Dual thread allocator example' in Unity.
## Customize block size You can customize the block sizes of the two dynamic heap allocators: ## Usage report example The usage report contains information for all three parts of the allocator. For example: ``` [ALLOC_DEFAULT] Dual Thread Allocator Peak main deferred allocation count 135 [ALLOC_BUCKET] Large Bloc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2e14c9f2d23c
unity_docs
ui
In Unity's 'Bind to a list with ListView', what is 'Create an object with a list' and how does it work?
Create a GameSwitch object and a serialized object that has a list of GameSwitch objects as a property. Create a Unity project with any template. In your Project window , create a folder named bind-to-list to store all your files. Create a C# script named GameSwitchListAsset.cs and replace its contents with the followi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d8aeb2c0b39
unity_docs
rendering
What is `Video.VideoPlayer.targetCamera3DLayout` in Unity? Explain its purpose and usage.
VideoPlayer.targetCamera3DLayout public Video.Video3DLayout targetCamera3DLayout ; Description Type of 3D content contained in the source video media. When stereoscopic rendering is used, the rendering for each eye samples the correct half of the video according to this setting. This setting is only used when...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0c02ca9d725
unity_docs
animation
What is `AnimatorControllerParameter.defaultFloat` in Unity? Explain its purpose and usage.
AnimatorControllerParameter.defaultFloat public float defaultFloat ; Description The default float value for the parameter. Only valid for Parameters of type AnimatorControllerParameterType.Float .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a5c59634a44
unity_docs
rendering
What is `TextureFormat.BC5` in Unity? Explain its purpose and usage.
TextureFormat.BC5 Description Compressed two-channel (RG) texture format. BC5 format compresses textures to 8 bits per pixel, keeping only the red and green color channels. It is widely supported on PC and console platforms. It is a good format to compress two-channel textures, e.g. as a compression format for tang...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2db26d42600d
unity_docs
rendering
Explain 'Add a subshader in a custom shader' in Unity.
A Shader object contains one or more SubShaders. SubShaders let you define different GPU settings and shader programs for different hardware, render pipelines , and runtime settings. Some Shader objects contain only a single SubShader; others contain multiple SubShaders to support a range of different configurations. F...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aa677fc5aff6
unity_docs
editor
Explain 'Introduction to debugging Unity in Windows' in Unity.
You can use various tools and techniques to debug Unity applications on Windows and identify and resolve runtime issues. This guide covers practical debugging types, such as live debugging and forensic debugging. It also covers vital concepts like symbols and managed exceptions, which support and enhance your debugging...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2ec381fa016
unity_docs
math
What is `BoundingSphere.ctor` in Unity? Explain its purpose and usage.
BoundingSphere Constructor Declaration public BoundingSphere ( Vector3 pos , float rad ); Declaration public BoundingSphere ( Vector4 packedSphere ); Parameters Parameter Description pos The center of the sphere. rad The radius of the sphere. packedSphere A four-component vector containing the po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.