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_24171b0498fb
unity_docs
xr
What is `Networking.UploadHandler` in Unity? Explain its purpose and usage.
UploadHandler class in UnityEngine.Networking / Implemented in: UnityEngine.UnityWebRequestModule Description Helper object for UnityWebRequest s. Manages the buffering and transmission of body data during HTTP requests. When attached to a UnityWebRequest , an UploadHandler object handles all information rega...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e42bb45ff9da
unity_docs
scripting
What is `UIElements.TextElement.displayTooltipWhenElided` in Unity? Explain its purpose and usage.
TextElement.displayTooltipWhenElided public bool displayTooltipWhenElided ; Description When true, a tooltip displays the full version of elided text, and also if a tooltip had been previously provided, it will be overwritten.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_82234f1c10b1
unity_docs
scripting
Explain 'Digital distribution services for Android' in Unity.
This section of the documentation contains information about digital distribution service-specific delivery requirements for Android applications. Each page includes any relevant considerations to be aware of and requirements that an application must fulfill before you publish it there. For more information on how to p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_983cb9579222_doc_10
github
scripting
What does `WarnMessage` do in this Unity script? Explain its purpose and signature.
Log Warn wrapper for all debug logs of this class.Message to be logged. Signature: ```csharp private static void WarnMessage(string message) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_bdd1df8446bc
unity_docs
editor
Show me a Unity C# example demonstrating `QualitySettings.GetAllRenderPipelineAssetsForPlatform`.
uildTargetGroupName The platform to obtain the Render Pipeline Assets. renderPipelineAssets The list that will be filled with the unfiltered Render Pipeline Assets. There might be null Render Pipeline Assets. Description [Editor Only] Fills the given list with all the Render Pipeline Assets on any Quality Level fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5277e4ae069c
unity_docs
physics
What is `UIElements.FocusController` in Unity? Explain its purpose and usage.
FocusController class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Class in charge of managing the focus inside a Panel. Each Panel should have an instance of this class. The instance holds the currently focused VisualElement and is responsible for changing it. Pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b19d7ccd861
unity_docs
scripting
Show me a Unity C# example demonstrating `AsyncOperation.allowSceneActivation`.
se, and another AsyncOperation (e.g. SceneManager.UnloadSceneAsync ) initializes, Unity does not call the second operation until the first AsyncOperation.allowSceneActivation is set to true. You should set and use AsyncOperation.allowSceneActivation in coroutine functions. You cannot set and use AsyncOperation...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9077503430c1
unity_docs
rendering
Explain 'Writing compute shaders for multiple platforms' in Unity.
## Cross-platform best practices DirectX 11 (DX11) supports many actions that are not supported on other platforms (such as Metal or OpenGL ES ). Therefore, you should always ensure your shader has well-defined behavior on platforms that offer less support, rather than only on DX11. Here are few things to consider: Ou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27ca03defb4c
unity_docs
scripting
What is `UIElements.PointerEventBase_1.altitudeAngle` in Unity? Explain its purpose and usage.
PointerEventBase<T0>.altitudeAngle public float altitudeAngle ; Description Gets the angle of the stylus relative to the surface, in radians A value of 0 indicates that the stylus is parallel to the surface. A value of pi/2 indicates that it is perpendicular to the surface.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ce68ed6f2262
unity_docs
rendering
What is `Texture2DArray.mipmapLimitGroup` in Unity? Explain its purpose and usage.
Texture2DArray.mipmapLimitGroup public string mipmapLimitGroup ; Description The name of the texture mipmap limit group that this texture is associated with. (Read Only) If this texture has a mipmap limit group assignment, this texture respects the TextureMipmapLimitSettings of that group. If this texture do...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c526a4613564
unity_docs
rendering
Explain 'Light halos' in Unity.
Strategies for creating glowing halos around light sources, to give the impression of small dust particles in the air, and add atmosphere to your scene . Topic Description Create and configure a halo light effect Create and customize a halo around a light source. Halo component reference Explore the properties for the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76ced652f7fc
unity_docs
rendering
What is `Build.Content.ContentBuildInterface.CalculateBuildUsageTags` in Unity? Explain its purpose and usage.
ContentBuildInterface.CalculateBuildUsageTags Declaration public static void CalculateBuildUsageTags (ObjectIdentifier[] objectIDs , ObjectIdentifier[] dependentObjectIDs , Build.Content.BuildUsageTagGlobal globalUsage , Build.Content.BuildUsageTagSet usageSet ); Declaration public static void CalculateB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d8fa233cf65
unity_docs
physics
Show me a Unity C# example demonstrating `PhysicsShapeGroup2D.DeleteShape`.
PhysicsShapeGroup2D.DeleteShape Declaration public void DeleteShape (int shapeIndex ); Parameters Parameter Description shapeIndex The index of the shape stored the PhysicsShapeGroup2D . Description When destroying a shape at the specified shapeIndex , all other shapes that exist above the specified sha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_966316f19576
unity_docs
scripting
Show me a Unity C# example demonstrating `DragAndDrop.StartDrag`.
DragAndDrop.StartDrag Declaration public static void StartDrag (string title ); Description Start a drag operation. Initiates a drag operation with the current drag object state. Use paths and/or objectReferences to setup drag state. Additional resources: PrepareStartDrag , paths , objectReferences . `...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d35333d1dcce_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
MonoBehaviour extension with helper features for subcribing to and unsubscribing from ScriptableObject-based GameEvent and GameProperty objects. Signature: ```csharp public abstract class SubscriptionHelperMonoBehaviour : MonoBehaviour ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
gh_b7cfc526d0ed
github
scripting
Write a Unity C# XR/VR script for Update Manager
```csharp using System; using Gilzoide.UpdateManager.Internal; using Gilzoide.UpdateManager.Jobs; using UnityEngine; namespace Gilzoide.UpdateManager { /// <summary> /// Singleton MonoBehaviour that calls <see cref="IUpdatable.ManagedUpdate"/>, <see cref="ILateUpdatable.ManagedLateUpdate"/> or <see cref="IFixe...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_0a2b7be36518
unity_docs
math
What is `TerrainTools.BrushTransform.GetBrushXYBounds` in Unity? Explain its purpose and usage.
BrushTransform.GetBrushXYBounds Declaration public Rect GetBrushXYBounds (); Returns Rect Bounding rectangle in target XY space. Description Get the axis-aligned bounding rectangle of the brush, in target XY space.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f6467560f77a
unity_docs
physics
In Unity's 'Introduction to physics articulations', what is 'Articulation Joint types and degrees of freedom' and how does it work?
There are four types of articulation joints that you can select and configure through an Articulation Body: Fixed joint : sets a rigid, unbreakable and unstretchable link between bodies. Prismatic joint : prevents all motion except sliding along a particular axis. Revolute joint : allows rotation around a particular ax...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16f28513f0db
unity_docs
rendering
What is `TextureImporter.ClearPlatformTextureSettings` in Unity? Explain its purpose and usage.
TextureImporter.ClearPlatformTextureSettings Declaration public void ClearPlatformTextureSettings (string platform ); Parameters Parameter Description platform The platform whose settings are to be cleared (see below). Description Clears specific target platform settings. Refer to NamedBuildTarget for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bc6f7a8ca052
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R16_UInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R16_UInt Description A one-component, 16-bit unsigned integer format that has a single 16-bit R component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a03068cbdd5d
unity_docs
editor
What is `VersionControl.Provider.Incoming` in Unity? Explain its purpose and usage.
Provider.Incoming Declaration public static VersionControl.Task Incoming (); Description Starts a task that queries the version control server for incoming changes. The task returns the incoming changesets which then can be accessed through the task's Task.changeSets property once it has been completed. ``...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_57dcf45163ff
unity_docs
rendering
In Unity's 'Linux Player settings', what is 'Resolution section' and how does it work?
Use this section to customize the screen mode and default size. Property Description Run In Background Enable this option to allow the application to run in the background when it loses focus. When disabled, the application pauses when it loses focus. Fullscreen Mode Choose the full-screen mode. This defines the defaul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f2bfa7422c2
unity_docs
scripting
Show me a Unity C# example demonstrating `Quaternion.z`.
Quaternion.z public float z ; Description Z component of the Quaternion. Don't modify this directly unless you know quaternions inside out. ```csharp //Create three Sliders (Create>UI>Slider) and three Text GameObjects (Create>UI>Text). These are for manipulating the x, y, and z values of the Quaternion. The t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_872180670ca7
unity_docs
physics
In Unity's 'Create a ragdoll', what is 'Note' and how does it work?
For Character Joints made with the Ragdoll wizard, the joint’s Twist axis corresponds with the limb’s largest swing axis , the joint’s Swing 1 axis corresponds with the limb’s smaller swing axis, and the joint’s Swing 2 axis is for twisting the limb. This naming scheme is for legacy reasons.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e46529f0eff6
unity_docs
scripting
What is `Selection.GetTransforms` in Unity? Explain its purpose and usage.
Selection.GetTransforms Declaration public static Transform[] GetTransforms ( SelectionMode mode ); Parameters Parameter Description mode Options for refining the selection. Refer to SelectionMode for the available modes. Returns Transform[] The transforms of the selected objects determined by the mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_926a14a07944
unity_docs
physics
What is `Collider2D.isTrigger` in Unity? Explain its purpose and usage.
Collider2D.isTrigger public bool isTrigger ; Description Is this collider configured as a trigger? ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public Collider2D coll; // Use this for initialization void Start() { //Check if the isTrigger option on the Co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6007b3d4a65
unity_docs
performance
What is `Unity.Profiling.ProfilerFlowEventType.End` in Unity? Explain its purpose and usage.
ProfilerFlowEventType.End Description Use for the flow end point. Marks the ProfilerMarker scope that the ProfilerFlowEventType.End is enclosed in as the final flow point. ```csharp using System; using System.Threading; using Unity.Profiling; using Unity.Profiling.LowLevel; using Unity.Profiling.LowLevel.Unsafe;pu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52c49b80863a
unity_docs
scripting
Show me a Unity C# example demonstrating `Coroutine`.
lass in UnityEngine / Inherits from: YieldInstruction / Implemented in: UnityEngine.CoreModule Description MonoBehaviour.StartCoroutine returns a Coroutine. Instances of this class are only used to reference these coroutines, and do not hold any exposed properties or functions. A coroutine is a function that ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4be95b49dce8
unity_docs
rendering
What is `ParticleSystem.textureSheetAnimation` in Unity? Explain its purpose and usage.
ParticleSystem.textureSheetAnimation public ParticleSystem.TextureSheetAnimationModule textureSheetAnimation ; Description Script interface for the TextureSheetAnimationModule of a Particle System. This module allows you to add animations to your particle textures. This is achieved by authoring flipbook text...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a47d83aa0970
unity_docs
math
What is `Experimental.GraphView.Edge.PointsAndTangents` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Edge.PointsAndTangents protected Vector2[] PointsAndTangents ; Description The edge's points and tangents.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_81715f709233
unity_docs
rendering
What is `Texture2D.Reinitialize` in Unity? Explain its purpose and usage.
Texture2D.Reinitialize Declaration public bool Reinitialize (int width , int height ); Declaration public bool Reinitialize (int width , int height , Experimental.Rendering.GraphicsFormat format , bool hasMipMap ); Declaration public bool Reinitialize (int width , int height , TextureFormat form...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c771d68986a8
unity_docs
editor
What is `SearchService.IProjectSearchEngine` in Unity? Explain its purpose and usage.
IProjectSearchEngine interface in UnityEditor.SearchService Implements interfaces: ISearchEngine<T0> , ISearchEngineBase Description The interface for Project engines to implement. It inherits from ISearchEngine<T0> .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa338045cc4a
unity_docs
scripting
What is `Playables.Notification` in Unity? Explain its purpose and usage.
Notification class in UnityEngine.Playables / Implemented in: UnityEngine.CoreModule Implements interfaces: INotification Description Default implementation for Playable notifications. See PlayableOutputExtensions.PushNotification for an example. Properties Property Description id The name that identifie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_952de7409989
unity_docs
animation
In Unity's 'Animate a GameObject', what is 'Time line' and how does it work?
You can click anywhere on the Animation window time line to move the playback head to that frame, and preview or modify that frame in the Animation Clip. The numbers in the time line are shown as seconds and frames, so 1:30 means 1 second and 30 frames. Note: The time line is tinted blue in Preview mode and tinted red ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_982c85173185_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Called as soon as the player touches the screen. The argument is the screen position. Signature: ```csharp public event Action<Vector2> onStartTouch; ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d94f18f9aab
unity_docs
editor
What is `Build.Content.WriteResult` in Unity? Explain its purpose and usage.
WriteResult struct in UnityEditor.Build.Content Description Struct containing the results from the ContentBuildPipeline.WriteSerialziedFile and ContentBuildPipeline.WriteSceneSerialziedFile APIs. Note: this struct and its members exist to provide low-level support for the Scriptable Build Pipeline package. This...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2d8f030811a4
github
scripting
Write a Unity C# script called Transform Data
```csharp using UnityEngine; using System.Collections.Generic; using System.Text; namespace PlainSaveLoad { public class TransformData { public Vector3 position; public TransformData(Vector3 position) { this.position = position; } public override string To...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d5d1f0e7aec2
unity_docs
editor
What is `AssetSettingsProvider` in Unity? Explain its purpose and usage.
AssetSettingsProvider class in UnityEditor / Inherits from: SettingsProvider Description AssetSettingsProvider is a specialization of the SettingsProvider class that converts legacy settings to Unified Settings. Legacy settings include any settings that used the Inspector to modify themselves, such as the *.as...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a5cbe998165d
unity_docs
rendering
In Unity's 'Change or detect the active render pipeline', what is 'Activating the Built-in Render Pipeline' and how does it work?
To set the active render pipeline to the Built-in Render Pipeline, remove any Render Pipeline Assets from graphics settings and quality settings. To do this: Select Edit > Project Settings > Quality . For each quality level, if a Render Pipeline Asset is assigned to Render Pipeline Asset , unassign it. Select Edit > Pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ba76c79b3654
github
scripting
Write a Unity Editor script for Gaussian Move Tool
```csharp // SPDX-License-Identifier: MIT using GaussianSplatting.Runtime; using UnityEditor; using UnityEditor.EditorTools; using UnityEngine; namespace GaussianSplatting.Editor { [EditorTool("Gaussian Move Tool", typeof(GaussianSplatRenderer), typeof(GaussianToolContext))] class GaussianMoveTool : GaussianT...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
gh_0a212619fc54_doc_6
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Destroys the specified MonoBehaviour object and removes it from the pool.The type of the MonoBehaviour object to destroy.The object to destroy. Signature: ```csharp public static void DestroyMono<T>(T obj) where T : MonoBehaviour, IPoolable => _poolService.DestroyMono(obj); ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_47bcc8210d75
unity_docs
rendering
What is `LightProbeProxyVolume.QualityMode` in Unity? Explain its purpose and usage.
QualityMode enumeration Description An enum describing the Quality option used by the Light Probe Proxy Volume component. Additional resources: Light Probes , Light Probe Proxy Volume , Spherical Harmonics(SH) . Properties Property Description Low This option will use only two SH coefficients bands: L0 and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bef6a0eae5d7
unity_docs
scripting
Explain 'Android Library and Android Archive plug-ins' in Unity.
Android Libraries and Android Archives (AAR) are plug-in types that can contain C++ and Java code, resources such as assets, and a plug-in manifest file. You can use them to reuse components across multiple applications, or build variations of one application with the same core components. Topic Description Introducing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b03ef827a8c3
unity_docs
editor
What is `Profiling.RawFrameDataView.GetSampleMarkerId` in Unity? Explain its purpose and usage.
RawFrameDataView.GetSampleMarkerId Declaration public int GetSampleMarkerId (int sampleIndex ); Parameters Parameter Description sampleIndex Index of the Profiler sample. Returns int Returns Profiler marker indentifier. Returns invalidMarkerId for invalid index. Description Gets Profiler marker ind...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8261e762ee13
unity_docs
rendering
What is `LightProbesQuery` in Unity? Explain its purpose and usage.
LightProbesQuery struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Thread-safe struct for batch sampling Light Probes in a Scene. This struct allows for sampling Light Probes from a job or a thread. If you load a scene additively, you must call LightProbes.Tetrahedralize to include its ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ce5d2e96c20f
unity_docs
ui
What is `GUI.ScrollTo` in Unity? Explain its purpose and usage.
GUI.ScrollTo Declaration public static void ScrollTo ( Rect position ); Description Scrolls all enclosing scrollviews so they try to make position visible. ```csharp // Draws a Scroll view with 2 buttons inside. // When clicked each button it moves the scroll // where the other button is locatedusing UnityE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b1c6db565bc
unity_docs
scripting
What are the parameters of `Vector3.Lerp` in Unity?
Returns Vector3 Interpolated value. This value always lies on a line between points a and b . Description Interpolates linearly between two points. The interpolant parameter t is clamped to the range [0, 1]. This method is useful for finding a point some fraction of the way along a line between two endpoints. For examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_784d3901c1a4
unity_docs
scripting
In Unity's 'Deploy a QNX project', what is 'Application window configuration using environment variable' and how does it work?
Use the environment variable UNITY_QNX_WINDOW_CLASS_LIST to configure the properties for your Unity application windows. This variable allows you to override Unity’s default windowing behavior by using the platform-specific window properties. You can define properties including display index, position, size, and hardwa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b63722c4ca11
unity_docs
ui
Show me a Unity C# example demonstrating `UIElements.Clickable.clickedWithEventInfo`.
Clickable.clickedWithEventInfo Description Callback triggered when the target element is clicked, including event data. Encapsulates a method that has an EventBase parameter and does not return a value. ```csharp using UnityEngine; using UnityEngine.UIElements;[RequireComponent(typeof(UIDocument))] public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f25faac39dd6
unity_docs
rendering
What are the parameters of `Shader.SetGlobalFloat` in Unity?
Description Sets a global float property for all shaders. Global properties are used if a shader needs them but the material does not have them defined (for example, if the shader does not expose them in Properties block). Usually this is used if you have a set of custom shaders that all use the same "global" float (fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3bbf985e6ffa
unity_docs
ui
Show me a Unity code example for 'Bind to a list without ListView'.
ple creates in this GitHub repository . ## Create an object that contains a list Create a C# class that contains a list. This list is the target of the binding. Create a project in Unity with any template. In your Project window , create a folder named bind-to-list-without-ListView to store all your files. Create a C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03cfaea2f533
unity_docs
math
What is `Build.Content.ContentBuildInterface.StopProfileCapture` in Unity? Explain its purpose and usage.
ContentBuildInterface.StopProfileCapture Declaration public static ContentBuildProfileEvent[] StopProfileCapture (); Description Returns an array of ContentBuildProfileEvent structs that contain information for each occuring event. Also stops the profile capture. Throws an InvalidOperationException if no profil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_35a58c92758e
unity_docs
math
What is `Plane.GetSide` in Unity? Explain its purpose and usage.
Plane.GetSide Declaration public bool GetSide ( Vector3 point ); Description Is a point on the positive side of the plane? ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public Plane goalLine1; public Plane goalLine2; public Plane leftSideLine; public Pla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_701bd902716d
unity_docs
rendering
What is `Lightmapping.bakeOnSceneLoad` in Unity? Explain its purpose and usage.
Lightmapping.bakeOnSceneLoad public static Lightmapping.BakeOnSceneLoadMode bakeOnSceneLoad ; Description Determines whether lighting data should be generated when loading a scene, for scenes that have not already been baked.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_814af3f3dfb6
unity_docs
rendering
What are the parameters of `EditorGUILayout.ColorField` in Unity?
Returns Color The color selected by the user. Description Make a field for selecting a Color . Change the color of the selected GameObjects. ```csharp using UnityEngine; using UnityEditor;// Change the color of the selected GameObjects.public class ExampleClass : EditorWindow { Color matColor = Color.white; [Men...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21bd8c117909
unity_docs
rendering
What is `Video.VideoPlayer.targetMaterialProperty` in Unity? Explain its purpose and usage.
VideoPlayer.targetMaterialProperty public string targetMaterialProperty ; Description Material texture property which is targeted when VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride. The video is sent to every Material in the Renderer that has the targeted texture property. When this...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5572039094e7
unity_docs
scripting
What is `PackageManager.PackageInfo.deprecationMessage` in Unity? Explain its purpose and usage.
PackageInfo.deprecationMessage public string deprecationMessage ; Description Deprecation message for the version that this instance represents. Valid only if PackageInfo.isDeprecated is `true`. Additional resources: VersionsInfo.deprecated for the list of all deprecated versions.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5daf4e97a048
unity_docs
scripting
What are the parameters of `Video.VideoPlayer.frameReady` in Unity?
Description The VideoPlayer invokes this event when a new frame is ready to be displayed. Use this event to: Analyze certain frames of a video. Track progress of the video. Play other effects such as animations or sound effects at a certain frame. To enable this event so that the VideoPlayer emits it, set the VideoPlay...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e31b1ee1b530
unity_docs
editor
In Unity's 'Configuration files', what is 'Global configuration file location' and how does it work?
Package Manager uses a global configuration file named upmconfig.toml . This file isn’t automatically created when you install the Unity Hub or a Unity Editor. However, you can create the file in the following location if you need to customize your configuration: Environment Location Windows %ALLUSERSPROFILE%\Unity\con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_78c4c24814f3
unity_docs
xr
In Unity's 'Manage asset packs at runtime', what is 'Download asset packs' and how does it work?
If your application uses fast-follow or on-demand asset packs, the device must download these asset packs before the application can access assets inside of them. To check the status of asset packs and download them if they’re not on the device, you must first know the name of each asset pack. To get the names of Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc8a0fde57cf
unity_docs
scripting
What is `RenderPickingArgs.renderObjectSet` in Unity? Explain its purpose and usage.
RenderPickingArgs.renderObjectSet public IReadOnlyCollection<GameObject> renderObjectSet ; Description A set of GameObjects to check and determine what this callback is expected to render. Depending on renderPickingType , the GameObjects in this set are expected to be either included or excluded from the picki...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56b3807698a0
unity_docs
scripting
What is `ParticleSystem.CollisionModule.minKillSpeed` in Unity? Explain its purpose and usage.
ParticleSystem.CollisionModule.minKillSpeed public float minKillSpeed ; Description Kill particles whose speed falls below this threshold, after a collision. Additional resources: ParticleSystem.collision . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] publi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d64b1544bddb
unity_docs
scripting
What is `Tree` in Unity? Explain its purpose and usage.
Tree class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.TerrainModule Description Tree Component for the tree creator. Properties Property Description data Data asociated to the Tree. hasSpeedTreeWind Tells if there is wind data exported from SpeedTree are saved on this compone...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_46534cee46b9
unity_docs
rendering
In Unity's 'Text assets', what is 'Binary data' and how does it work?
Text assets can also store binary data. If you create a file with the.bytes extension, you can load it as a text asset and access it through the bytes property. For example, put a.jpeg file into the Resources folder and change the extension to.bytes , then use the following script code to read the data at runtime: ``` ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fba661a3cac
unity_docs
scripting
What is `HumanDescription.hasTranslationDoF` in Unity? Explain its purpose and usage.
HumanDescription.hasTranslationDoF public bool hasTranslationDoF ; Description True for any human that has a translation Degree of Freedom (DoF). It is set to false by default. Translation DoF are on Spine, Chest, Neck, Shoulder and Upper Leg bones.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3640f904370c
unity_docs
scripting
Show me a Unity code example for 'Access meshes via the Mesh API'.
iangles, vertex positions, normals and texture coordinates and also supplies a number of other useful properties and functions to assist mesh generation. ## Access an object’s Mesh The mesh data is attached to an object using the Mesh Filter component (and the object will also need a MeshRenderer to make the geometry...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16877124dbdb
unity_docs
animation
What is `Animator.SetLookAtWeight` in Unity? Explain its purpose and usage.
Animator.SetLookAtWeight Declaration public void SetLookAtWeight (float weight ); Declaration public void SetLookAtWeight (float weight , float bodyWeight ); Declaration public void SetLookAtWeight (float weight , float bodyWeight , float headWeight ); Declaration public void SetLookAtWeight (floa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d15b34a3502
unity_docs
scripting
What is `UIElements.DoubleField.ctor` in Unity? Explain its purpose and usage.
DoubleField Constructor Declaration public DoubleField (); Description Constructor. Declaration public DoubleField (int maxLength ); Parameters Parameter Description maxLength Maximum number of characters the field can take. Description Constructor. Declaration public DoubleField (string lab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f93bd36ffd1b
unity_docs
math
What is `GeometryUtility.CalculateBounds` in Unity? Explain its purpose and usage.
GeometryUtility.CalculateBounds Declaration public static Bounds CalculateBounds (Vector3[] positions , Matrix4x4 transform ); Parameters Parameter Description positions An array that stores the location of 3d positions. transform A matrix that changes the position, rotation and size of the bounds cal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66ded82287ed
unity_docs
rendering
What is `SceneView.Frame` in Unity? Explain its purpose and usage.
SceneView.Frame Declaration public bool Frame ( Bounds bounds , bool instant ); Parameters Parameter Description bounds The bounds to frame in the Scene view. instant Set to true to immediately frame the camera. Set to false to animate the action. Returns bool Returns true if the given bounds can be ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b061f1147052
unity_docs
scripting
What is `LightTransport.IDeviceContext.ReadBuffer` in Unity? Explain its purpose and usage.
IDeviceContext.ReadBuffer Declaration public void ReadBuffer (BufferSlice<T> src , NativeArray<T> dst ); Declaration public void ReadBuffer (BufferSlice<T> src , NativeArray<T> dst , LightTransport.EventID id ); Parameters Parameter Description src The buffer slice specifying the source data on the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ffc96e7873b
unity_docs
scripting
What is `ModelImporterNormalSmoothingSource.FromAngle` in Unity? Explain its purpose and usage.
ModelImporterNormalSmoothingSource.FromAngle Description Use the angle between adjacent faces to determine if an edge is smooth or hard. Additional resources: ModelImporter.normalSmoothingSource , ModelImporter.normalSmoothingAngle .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_659f467dfa13
unity_docs
xr
What is `U2D.SpriteAtlasManager.atlasRegistered` in Unity? Explain its purpose and usage.
SpriteAtlasManager.atlasRegistered Description Trigger when a SpriteAtlas is registered via invoking the callback in SpriteAtlasManager.atlasRequested . ```csharp using UnityEngine; using UnityEngine.U2D;public class AtlasRegistrationListener : MonoBehaviour { void OnEnable() { SpriteAtlasManager.atlasRegiste...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9caf842b5841
unity_docs
input
What is `UIElements.MouseEventBase_1.currentTarget` in Unity? Explain its purpose and usage.
MouseEventBase<T0>.currentTarget public UIElements.IEventHandler currentTarget ; Description The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77576637d383
unity_docs
math
What is `Build.Content.ContentBuildInterface.GetTypesForObject` in Unity? Explain its purpose and usage.
ContentBuildInterface.GetTypesForObject Declaration public static Type[] GetTypesForObject ( Build.Content.ObjectIdentifier objectID ); Parameters Parameter Description objectID The specific object. Returns Type[] The array of unique types. Description Returns the System.Type of the ObjectIdentifie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93d16eb04524
unity_docs
input
What is `SearchService.ISearchEngineBase.BeginSession` in Unity? Explain its purpose and usage.
ISearchEngineBase.BeginSession Declaration public void BeginSession ( SearchService.ISearchContext context ); Parameters Parameter Description context The search context. Description A function called at the beginning of a search session. A search session is started when a user inputs the first character...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0d949af1076
unity_docs
scripting
What is `U2D.PixelPerfectRendering` in Unity? Explain its purpose and usage.
PixelPerfectRendering class in UnityEngine.U2D / Implemented in: UnityEngine.CoreModule Description A collection of APIs that facilitate pixel perfect rendering of sprite-based renderers. Static Properties Property Description pixelSnapSpacing To achieve a pixel perfect render, Sprites must be displaced to d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac2ba2ce6a37
unity_docs
animation
What is `HumanBodyBones` in Unity? Explain its purpose and usage.
HumanBodyBones enumeration Description Human Body Bones. Additional resources: Animator.GetBoneTransform . Properties Property Description Hips This is the Hips bone. LeftUpperLeg This is the Left Upper Leg bone. RightUpperLeg This is the Right Upper Leg bone. LeftLowerLeg This is the Left Knee bone. Righ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dd5add5bf6cf
unity_docs
rendering
Explain 'Introduction to importing assets' in Unity.
When you create a Unity project, Unity creates a folder for your project which contains an Assets subfolder. You can use this folder to store assets created outside of Unity to then use in your project. Important: Using cloud-based storage methods to store your project is an unsupported workflow. It can cause synchroni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f89ad8b536b
unity_docs
scripting
Show me a Unity C# example demonstrating `Rendering.PIX.IsAttached`.
PIX.IsAttached Declaration public static bool IsAttached (); Description Returns true if running via PIX and in a development build. ```csharp using UnityEngine; using UnityEngine.Rendering;public class PixControl : MonoBehaviour { public int frameCaptureCount = 1; int frameCount = 0; bool capturing = false; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a75947cfa027
unity_docs
scripting
Explain 'Introduction to components' in Unity.
Components are the functional pieces of every GameObject . Components contain properties which you can edit to define the behavior of a GameObject. For more information on the relationship between components and GameObjects, see GameObjects . To view a list of the components attached to a GameObject in the Inspector wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ba13b2058cc
unity_docs
scripting
What is `NetworkReachability.ReachableViaCarrierDataNetwork` in Unity? Explain its purpose and usage.
NetworkReachability.ReachableViaCarrierDataNetwork Description Network is reachable via carrier data network. ```csharp //Attach this script to a GameObject //This script checks the device’s ability to reach the internet and outputs it to the console windowusing UnityEngine;public class Example : MonoBehaviour { s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec796fe9c7d8
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.velocityScale`.
ParticleSystemRenderer.velocityScale public float velocityScale ; Description Specifies how much particles stretch depending on their velocity. Use this to make particles get longer as their speed increases. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a5b7b9b642ea
unity_docs
ui
In Unity's 'Relative and absolute positioning', what is 'Example overview' and how does it work?
The example uses the automatic layout system to add boxes to an Editor and a runtime UI. One box demonstrates a relative offset of 25 px , while another box demonstrates the absolute position of 25 px, 25 px . The example structures the Editor UI with C# script and the runtime UI with UXML and CSS. You can find the com...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e5a36b882cb7
unity_docs
math
What is `Rendering.RayTracingGeometryInstanceConfig.frontTriangleCounterClockwise` in Unity? Explain its purpose and usage.
RayTracingGeometryInstanceConfig.frontTriangleCounterClockwise public bool frontTriangleCounterClockwise ; Description Whether to flip the way triangles face in this ray tracing instance. If True , front-facing triangles become back-facing, and vice versa.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f4df6eb2ca6
unity_docs
rendering
Give me an overview of the `ModelImporterMaterialName` class in Unity.
ModelImporterMaterialName enumeration Description Material naming options for ModelImporter . Additional resources: ModelImporter.materialName . Properties Property Description BasedOnTextureName Use material names in the form <textureName>.mat. BasedOnMaterialName Use a material name of the form <materialN...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8912bc6dffae
unity_docs
rendering
In Unity's 'Line Renderer properties reference', what is 'Line settings' and how does it work?
Property Function Loop Enable this to connect the first and last positions of the line, and form a closed loop. Positions The array of Vector3 points to connect. Width Define a width value, and a curve value to control the width of your line along its length. The curve is sampled at each vertex, so its accuracy is limi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee2b52924f5c
unity_docs
scripting
What is `UIElements.FocusOutEvent` in Unity? Explain its purpose and usage.
FocusOutEvent class in UnityEngine.UIElements / Inherits from: UIElements.FocusEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Event sent immediately before an element loses focus. This event trickles down and bubbles up. Constructors Constructor Description FocusOutEvent Constr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4686c0e5c0bc
unity_docs
scripting
What is `LensFlare.fadeSpeed` in Unity? Explain its purpose and usage.
LensFlare.fadeSpeed public float fadeSpeed ; Description The fade speed of the flare. Additional resources: Lens flare component , flare assets . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Increments the strenght of the Lensflare lf when the Transform tr // gets closer to the Le...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e94a0f28106
unity_docs
scripting
What is `Search.SearchUtils.TryParse` in Unity? Explain its purpose and usage.
SearchUtils.TryParse Declaration public static bool TryParse (string expression , out T result ); Parameters Parameter Description expression Expression to be parsed. result Type of the numeric value. Returns bool Returns true if the parsing succeed. Description Try to parse an expression into a n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1508d8be65e1_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The distance from the destination at which the pointer object spawns. Signature: ```csharp public float pointerDistance ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
gh_5193fd7ba658
github
scripting
Write a Unity C# script called Player State System
```csharp using System.Collections; using System.Collections.Generic; using Unity.Entities; using Unity.Mathematics; using UnityEngine; using Farmer.Core; using UnityEngine.AddressableAssets; namespace Farmer.Gameplay { public class PlayerStateSystem : ComponentSystem { //--- States readonly ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a16c3267ecaf
unity_docs
rendering
What is `Tilemaps.TilemapRenderer.maskInteraction` in Unity? Explain its purpose and usage.
TilemapRenderer.maskInteraction public SpriteMaskInteraction maskInteraction ; Description Specifies how the Tilemap interacts with the masks. Tilemaps by default do not interact with Sprite Masks, and remain at their original visibility even when overlapping masks. Set this value to either VisibleInsideMas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c778a716a93b
unity_docs
scripting
Show me a Unity code example for 'Programming with the Asset Database'.
Database operations You can use batching to save time when making changes to assets from code. If you make changes to multiple assets, the Asset Database’s default behavior is to process each change in turn, and perform a full refresh process for the asset before moving on to the next line of code. The following examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7981a8d7a91d
unity_docs
networking
What are the parameters of `Networking.MultipartFormFileSection.ctor` in Unity?
Description Contains a named file section based on the raw bytes from data , with a custom Content-Type and file name. The full-control option. Manually specify a section name, raw data, file name and Content-Type . If fileName is null or empty, it defaults to file.dat . If contentType is null or empty, it defaults to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28ce8cbd1635
unity_docs
editor
What is `Media.MediaRational` in Unity? Explain its purpose and usage.
MediaRational struct in UnityEditor.Media Description Rational number useful for expressing fractions precisely. Static Properties Property Description Invalid Invalid rational value. Properties Property Description denominator Fraction denominator. inverse The inverse of the rational number. isNegative ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ac39145d3d6
unity_docs
rendering
Show me a Unity C# example demonstrating `Video.Video3DLayout`.
e it's easier to adapt to the different tools used to create the 3D movie and the limitations of the platform decoding it. If the platform or decoder can't handle wide resolutions (for example 3840x1080 for side-by-side HD), you can switch to the over/under layout (e.g., 1920x2160) to solve the issue. Both layouts use ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ace60cca8c2c
unity_docs
rendering
What is `ShaderPrecisionModel.Unified` in Unity? Explain its purpose and usage.
ShaderPrecisionModel.Unified Description Use full sampler precision by default, and explicitly declare when you want to use lower precision. Refer to SL-DataTypesAndPrecision for more information. In addition, half is defined as min16float on all platforms. This sets BuiltinShaderDefine.UNITY_UNIFIED_SHADER_P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca4b0c653eb5
unity_docs
animation
What is `AnimationUtility.SetKeyBroken` in Unity? Explain its purpose and usage.
AnimationUtility.SetKeyBroken Declaration public static void SetKeyBroken ( AnimationCurve curve , int index , bool broken ); Parameters Parameter Description curve The curve to modify. index Keyframe index. broken Broken flag. Description Change the specified keyframe broken tangent flag. The keyf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe14cc9a82de
unity_docs
scripting
What is `Embree.GpuBvhBuildOptions.maxLeafSize` in Unity? Explain its purpose and usage.
GpuBvhBuildOptions.maxLeafSize public uint maxLeafSize ; Description The maximum number of primitives allowed in a leaf node. If this value is more than 1, the BVH builder can pack multiple triangles into a node, but it only does so when the increase preserves the traversal performance. Default value: 1.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.