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_4879115febac
unity_docs
rendering
What is `Search.SearchProvider.isEnabledForContextualSearch` in Unity? Explain its purpose and usage.
SearchProvider.isEnabledForContextualSearch public Func<bool> isEnabledForContextualSearch ; Description Called when search is invoked in "contextual mode". Returns true if the search provider is enabled for this search context. ```csharp using System.Collections.Generic; using UnityEditor; using UnityEditor.Se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5ed88d3e178b
unity_docs
performance
Explain 'Analyzing asset processes' in Unity.
Optimize and measure the performance of assets in your project. The Asset Loading Profiler module and the AsyncReadManagerMetrics API allow you to measure how quickly Unity loads the assets in your project. You can also use the Import Activity window to measure import timings. Topic Description Collect asset loading me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c5dd4902633
unity_docs
rendering
What is `AssetImporters.FBXMaterialDescriptionPreprocessor` in Unity? Explain its purpose and usage.
FBXMaterialDescriptionPreprocessor class in UnityEditor.AssetImporters / Inherits from: AssetPostprocessor Description This is a default implementation for AssetPostProcessor.OnPreprocessMaterialDescription, this implementation converts material descriptions imported from FBX assets into materials for the intern...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_621b81ab7b0c
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.LimitVelocityOverLifetimeModule.limitMultiplier`.
ParticleSystem.LimitVelocityOverLifetimeModule.limitMultiplier public float limitMultiplier ; Description Change the limit multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall limit multiplier. ```csharp using UnityEngine; using System.Co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f3336e31064
unity_docs
rendering
What is `Rendering.ScriptableRenderContext.StartMultiEye` in Unity? Explain its purpose and usage.
ScriptableRenderContext.StartMultiEye Declaration public void StartMultiEye ( Camera camera ); Declaration public void StartMultiEye ( Camera camera , int eye ); Parameters Parameter Description camera Camera to enable stereo rendering on. eye The current eye to be rendered. Description Schedules...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5e8ad42ec06e
unity_docs
rendering
Explain 'Emit light from a GameObject in the Built-In Render Pipeline' in Unity.
Like area lights, emissive materials emit light across their surface area. They contribute to bounced light in your scene and associated properties such as color and intensity can be changed during gameplay. Whilst area lights are not supported by Enlighten Realtime Global Illumination , similar soft lighting effects i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1b11c889b75
unity_docs
scripting
What is `Unity.Android.Gradle.Plugins` in Unity? Explain its purpose and usage.
Plugins class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the plugins element in a gradle file. For more information about the element, see Gradle's documentation: Applying plugins with the plugins DSL Constructors Constructor Description Plugi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_82dcd8cc6ad3
unity_docs
rendering
What is `AssetImporters.AssetImportContext.GetOutputArtifactFilePath` in Unity? Explain its purpose and usage.
AssetImportContext.GetOutputArtifactFilePath Declaration public string GetOutputArtifactFilePath (string fileName ); Parameters Parameter Description fileName Unique identifier to refer to this Artifact File. Returns string The file path which can be used to create a new Artifact File. Description Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb70f63ddc4a
unity_docs
performance
What is `Unity.Profiling.LowLevel.ProfilerMarkerDataType.Blob8` in Unity? Explain its purpose and usage.
ProfilerMarkerDataType.Blob8 Description Indicates that ProfilerMarkerData.Ptr points to a raw byte array. Use Blob8 to arbitrary binary data to the ProfilerUnsafeUtility.BeginSampleWithMetadata . ```csharp using System.Diagnostics; using System.Runtime.CompilerServices; using Unity.Profiling; using Unity.Pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a536b3bdb871
unity_docs
input
What is `Experimental.GraphView.EdgeManipulator.OnMouseUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeManipulator.OnMouseUp Declaration protected void OnMouseUp ( UIElements.MouseUpEvent evt ); Parameters Parameter Description evt The event. Description Handle mouse up event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef52f7202bab
unity_docs
editor
What is `GenericMenu` in Unity? Explain its purpose and usage.
GenericMenu class in UnityEditor Description GenericMenu lets you create custom context menus and dropdown menus. The example below opens an Editor window with a button. Clicking the button displays a context menu, which lets you change the color to apply to the GUI in the window. Copy the example's contents into...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_82cfc4f4b67a
unity_docs
math
What is `GridBrushBase.BoxErase` in Unity? Explain its purpose and usage.
GridBrushBase.BoxErase Declaration public void BoxErase ( GridLayout gridLayout , GameObject brushTarget , BoundsInt position ); Parameters Parameter Description gridLayout Grid used for layout. brushTarget Target of the erase operation. By default the currently selected GameObject. position The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_687549fb8e91
unity_docs
editor
What is `VersionControl.Message` in Unity? Explain its purpose and usage.
Message class in UnityEditor.VersionControl Description Messages from the version control system. Properties Property Description message The message text. severity The severity of the message. Public Methods Method Description Show Write the message to the console.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f3b75130535
unity_docs
editor
What is `AI.NavMeshBuildDebugFlags.All` in Unity? Explain its purpose and usage.
NavMeshBuildDebugFlags.All Description All debug data from the NavMesh build process is taken into consideration. Additional resources: NavMeshBuildSettings.debug , NavMeshEditorHelpers.DrawBuildDebug .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c45a2bba92ed
unity_docs
audio
What is `Experimental.Audio.AudioSampleProvider.sampleRate` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. AudioSampleProvider.sampleRate public uint sampleRate ; Description The expected playback rate for the sample frames produced by this class. This property does not change throughout the AudioSampleProvider' life scope.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa21d2d1ac5b
unity_docs
rendering
What is `SparseTexture.tileHeight` in Unity? Explain its purpose and usage.
SparseTexture.tileHeight public int tileHeight ; Description Get sparse texture tile height (Read Only). After creating the sparse texture, query the tile size with tileWidth & tileHeight . Tile sizes are platform and GPU dependent. Additional resources: SparseTexture .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4797da9d5d84
github
scripting
Write a Unity C# script called Fusion Vector4Type
```csharp // // /*=============================================================================== // // Copyright (C) 2024 PhantomsXR Ltd. All Rights Reserved. // // // // This file is part of the Phantom.XRMOD.PhotonModule.Runtime. // // // // The XR-MOD cannot be copied, distributed, or made available to // // third...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_af6fe00e1ca8
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchProvider.fetchLabel`.
SearchProvider.fetchLabel public Func<SearchItem,SearchContext,string> fetchLabel ; Description Handler used to fetch and format the label of a search item. ```csharp [SearchItemProvider] internal static SearchProvider CreateProvider() { return new SearchProvider("example_tree", "Trees") { filterId = "tree:"...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55dda4c024c5
unity_docs
scripting
What is `GUIStyle.fontSize` in Unity? Explain its purpose and usage.
GUIStyle.fontSize public int fontSize ; Description The font size to use (for dynamic fonts). If this is set to a non-zero value, the font size specified in the font importer is overriden with a custom size. This is only supported for fonts set to use dynamic font rendering. Other fonts will always use the def...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e586f8cda72b
unity_docs
editor
In Unity's 'Create list and tree views', what is 'Example overview' and how does it work?
This example creates four Editor windows that display the following: A list of planets with a single column A list of planets with two columns A tree view of planets A tree view of planets with two columns You can find the completed files that this example creates in this GitHub repository .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ce8076b0376
unity_docs
rendering
What is `HandleUtility` in Unity? Explain its purpose and usage.
HandleUtility class in UnityEditor Description Helper functions for Scene View style 3D GUI. These are mainly mathematical functions that assist in converting between the 3D Scene space and the 2D GUI. The functions are used in the construction of the Unity Editor itself and so using them is a good way to make yo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_696138a2ac38
unity_docs
scripting
Explain 'MultiColumnTreeView' in Unity.
A MultiColumnTreeView is a UI control commonly used to display tabular or grid-like data with multiple columns. Use a MultiColumnTreeView to present data in a structured format, where each row represents an item or entry, and each column represents a specific attribute or property of that item. ## Create a MultiColumn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_106164071fde
unity_docs
input
What is `UIElements.ScrollView.mouseWheelScrollSize` in Unity? Explain its purpose and usage.
ScrollView.mouseWheelScrollSize public float mouseWheelScrollSize ; Description This property controls the scrolling speed only when using a mouse scroll wheel, based on the size of the page. It takes precedence over the --unity-metrics-single_line-height USS variable.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e9e5a750d05
unity_docs
editor
What is `AssetDatabase.importPackageCompleted` in Unity? Explain its purpose and usage.
AssetDatabase.importPackageCompleted Parameters Parameter Description value Name of package. Description Callback raised whenever a package import successfully completes. ```csharp using UnityEditor; using UnityEngine;[InitializeOnLoad] public class AssetDatabaseExamples { static AssetDatabaseExamples() { A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09dd30394782
unity_docs
math
What is `Search.IQueryEngineFilter` in Unity? Explain its purpose and usage.
IQueryEngineFilter interface in UnityEditor.Search Description Interface for the QueryEngine filters. When you add a new filter on a QueryEngine , you receive a filter object that implements the interface IQueryEngineFilter . You can modify this filter to override the global behaviors of the QueryEngine . Fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e11e0132a307
unity_docs
scripting
What is `WSA.SecondaryTileData.roamingEnabled` in Unity? Explain its purpose and usage.
SecondaryTileData.roamingEnabled public bool roamingEnabled ; Description Defines whether secondary tile is copied to another device when application is installed by the same users account. Note: when true on Windows 8 this sets CopyOnDeployment tile option. Defaults to true (matches the Windows 8.1 default).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee5a10e6099c
unity_docs
scripting
What is `UIElements.ITransitionEvent` in Unity? Explain its purpose and usage.
ITransitionEvent interface in UnityEngine.UIElements Description Interface for all transition events. Properties Property Description elapsedTime The number of seconds the transition has been running, excluding delay phase time. stylePropertyNames The names of the properties associated with the trans...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e3429c9c8f6
unity_docs
scripting
What is `IMGUI.Controls.TreeView.SetupDragAndDrop` in Unity? Explain its purpose and usage.
TreeView.SetupDragAndDrop Declaration protected void SetupDragAndDrop ( IMGUI.Controls.TreeView.SetupDragAndDropArgs args ); Description This function is called when CanStartDrag returns true. Override this function to set the global DragAndDrop state and set which items can be dragged and dropped. Use F...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_293e9bcd82eb
unity_docs
scripting
What are the parameters of `Assertions.Assert.IsFalse` in Unity?
Description Return true when the condition is false. Otherwise return false . ```csharp using UnityEngine; using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour { GameObject go; void Update() { // Make sure the Game Object is never in active state Assert.IsFalse(go....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fdd186a2ebf8
unity_docs
editor
Show me a Unity C# example demonstrating `Handles.DrawBezier`.
cription Draw textured bezier line through start and end points with the given tangents. To get an anti-aliased effect use a texture that is 1x2 pixels with one transparent white pixel and one opaque white pixel. The bezier curve will be swept using this texture. Note: Use HandleUtility.GetHandleSize where you mig...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_946e471bd8f5
unity_docs
physics
Give me an overview of the `HingeJoint2D` class in Unity.
HingeJoint2D class in UnityEngine / Inherits from: AnchoredJoint2D / Implemented in: UnityEngine.Physics2DModule Description Joint that allows a Rigidbody2D object to rotate around a point in space or a point on another object. Additional resources: DistanceJoint2D , SliderJoint2D , SpringJoint2D , JointA...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1dd6d8c0456
unity_docs
scripting
What is `ReflectionProbe.timeSlicingMode` in Unity? Explain its purpose and usage.
ReflectionProbe.timeSlicingMode public Rendering.ReflectionProbeTimeSlicingMode timeSlicingMode ; Description Sets this probe time-slicing mode Additional resources: ReflectionProbeTimeSlicingMode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ddc3836471b
unity_docs
rendering
What are the parameters of `Material.IsKeywordEnabled` in Unity?
Returns bool Returns true if a LocalKeyword with the given name is enabled for this material. Description Checks whether a local shader keyword is enabled for this material. Shader keywords determine which shader variants Unity uses. For information on working with local shader keywords and global shader keywords and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_158aca855527
unity_docs
input
What is `SystemInfo.supportsDepthFetchInRenderPass` in Unity? Explain its purpose and usage.
SystemInfo.supportsDepthFetchInRenderPass public static bool supportsDepthFetchInRenderPass ; Description Indicates whether RenderPass can use its depth attachment as input. (Read Only) When RenderPass is emulated (e.g. D3D11 or OpenGL Core) this is always possible since the temporary copy will be used.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_98b79f27ddfb
unity_docs
scripting
Show me a Unity code example for 'ToolbarBreadcrumbs'.
A ToolbarBreadcrumbs is an Editor-only control that serves as a breadcrumb navigation bar. It has a predefined style that matches the Toolbar style. ## Create a ToolbarBreadcrumbs You can create a ToolbarBreadcrumbs with UI Builder, UXML, or C#. The following C# example creates a ToolbarBreadcrumbs with three items: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4126704456f0
unity_docs
editor
Give me an overview of the `SceneViewCameraWindow` class in Unity.
SceneViewCameraWindow class in UnityEditor / Inherits from: PopupWindowContent Description Use this class to instantiate a SceneViewCameraWindow window. The SceneViewCameraWindow window displays settings for the SceneView camera. Constructors Constructor Description SceneViewCameraWindow Creates an in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8bb1c25c203b
unity_docs
math
What is `Tilemaps.Tilemap.GetObjectToInstantiate` in Unity? Explain its purpose and usage.
Tilemap.GetObjectToInstantiate Declaration public GameObject GetObjectToInstantiate ( Vector3Int position ); Parameters Parameter Description position The position of the Tile on the Tilemap . Returns GameObject Returns the GameObject to be instantiated by the Tile at the position. Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e200a21b4896
unity_docs
scripting
What is `MeshPreview.GetInfoString` in Unity? Explain its purpose and usage.
MeshPreview.GetInfoString Declaration public static string GetInfoString ( Mesh mesh ); Parameters Parameter Description mesh The Mesh to build a summary phrase for. Returns string A short summary of the mesh attributes. Description Returns a short summary of the Mesh attributes (ex, does this m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9d9271206d49
unity_docs
rendering
Show me a Unity code example for 'Receiving shadows shader example in the Built-In Render Pipeline'.
es a lot more: it also compiles variants for the different lightmap types, Enlighten Realtime Global Illumination being on or off etc. Currently we don’t need all that, so we’ll explicitly skip these variants. Then to get actual shadowing computations, we’ll #include “AutoLight.cginc” shader include file and use SHADOW...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39becf712be2
unity_docs
scripting
What is `ISubsystem.Destroy` in Unity? Explain its purpose and usage.
ISubsystem.Destroy Declaration public void Destroy (); Description Destroys this instance of a subsystem. Also unloads all resources acquired during initialization step. Should be called when this instance of a subsystem is no longer needed. Note: Once a Subsystem is Destroyed, script can still hold a referenc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be40eadd133f
unity_docs
rendering
What is `TrailRenderer.generateLightingData` in Unity? Explain its purpose and usage.
TrailRenderer.generateLightingData public bool generateLightingData ; Description Configures a trail to generate Normals and Tangents. With this data, Scene lighting can affect the trail via Normal Maps and the Unity Standard Shader, or your own custom-built Shaders. ```csharp using UnityEngine; using System.C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e364e05bcc6
unity_docs
rendering
What is `XR.CommonUsages.colorCameraAngularVelocity` in Unity? Explain its purpose and usage.
CommonUsages.colorCameraAngularVelocity public static InputFeatureUsage<Vector3> colorCameraAngularVelocity ; Description The angular velocity of the color camera on this device, formatted as euler angles.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8b092386835c
unity_docs
scripting
Explain 'Per-frame updates' in Unity.
Unity performs some updates once per frame. Your MonoBehaviour scripts can hook into this update loop through the MonoBehaviour.Update method. For example, in your game character’s Update method, you might read the user input from a joypad, and move the character forward a certain amount. It’s important to remember whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23c68f99aa3c
unity_docs
rendering
What is `EditorUserSettings.compressAssetsOnImport` in Unity? Explain its purpose and usage.
EditorUserSettings.compressAssetsOnImport public static bool compressAssetsOnImport ; Description Enable or disable texture compression during asset import. When enabled, Unity compresses textures during import to reduce disk space usage. Disabling this option can speed up the import process but increases disk ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fe43fd7ae8f7
unity_docs
rendering
In Unity's 'Sky', what is 'Skyboxes' and how does it work?
A skybox is a cube with a different texture on each face. When you use a skybox to render a sky, Unity essentially places your Scene inside the skybox cube. Unity renders the skybox first, so the sky always renders at the back. Note: The High Definition Render Pipeline (HDRP) does not support skybox Materials and inste...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_06225481167b
unity_docs
math
What is `Graphics.RenderMeshIndirect` in Unity? Explain its purpose and usage.
Graphics.RenderMeshIndirect Declaration public static void RenderMeshIndirect (ref RenderParams rparams , Mesh mesh , GraphicsBuffer commandBuffer , int commandCount = 1, int startCommand = 0); Parameters Parameter Description rparams The parameters Unity uses to render the mesh. mesh The Mesh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8477c98efa62
unity_docs
rendering
What is `Texture2DArray` in Unity? Explain its purpose and usage.
Texture2DArray class in UnityEngine / Inherits from: Texture / Implemented in: UnityEngine.CoreModule Description Class for handling 2D texture arrays. Modern graphics APIs (e.g. D3D10 and later, OpenGL ES 3.0 and later, Metal etc.) support "texture arrays", which is an array of same size & format textures. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44804a9866aa
unity_docs
math
What is `AndroidJNI.NewIntArray` in Unity? Explain its purpose and usage.
AndroidJNI.NewIntArray Declaration public static IntPtr NewIntArray (int size ); Description Constructs a new primitive array 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_man_254c05d185f6
unity_docs
scripting
Explain 'Place Light Probes with the Editor' in Unity.
To place Light Probes in your Scene, you must use a GameObject with a Light Probe Group component attached. You can add a Light Probe Group component from the menu: Component > Rendering > Light Probe Group . You can add the Light Probe Group component to any GameObject in the Scene. However, it’s good practice to crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6c45d831b25
unity_docs
rendering
What is `Search.SearchExpressionType.Selector` in Unity? Explain its purpose and usage.
SearchExpressionType.Selector Description Denote an expression representing a selector. All selector starts with @. For example @size in expression: select{t:material, @size}. ```csharp [Description("Convert arguments to a string allowing you to format the result.")] [SearchExpressionEvaluator(SearchExpressionType....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_52a4cf820733
unity_docs
rendering
Explain 'Terrain Tools package' in Unity.
The Terrain Tools package provides additional functionality on top of Unity’s built-in Terrain tools . It includes more advanced features such as erosion tools, sculpting tools, and brush mask filters. It also contains the Terrain Toolbox, which lets you create new terrain from preset files or imported heightmaps , bat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2f0e4e81aa8e
unity_docs
scripting
Explain 'Structure UI' in Unity.
You can structure UI with either UXML or C#. Topic Description The visual tree Structure elements in your UI into a visual tree . Structure UI with UXML Write UXML files, add styles to UXML, and reuse UXML templates. Structure UI with C# scripts Add and interact with UI controls in C#. Custom controls Understand the st...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f66b4fc77eb7
unity_docs
scripting
What is `UIElements.NavigationMoveEvent.Direction` in Unity? Explain its purpose and usage.
Direction enumeration Description Move event direction. Properties Property Description None No specific direction. Left Left. Up Up. Right Right. Down Down. Next Forwards, toward next element. Previous Backwards, toward previous element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f6907de4d1d
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.CollisionModule.enabled`.
ParticleSystem.CollisionModule.enabled public bool enabled ; Description Specifies whether the CollisionModule is enabled or disabled. Additional resources: ParticleSystem.collision . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_607efa381e3d
unity_docs
scripting
What is `UIElements.TagField.ctor` in Unity? Explain its purpose and usage.
TagField Constructor Declaration public TagField (); Description Initializes and returns an instance of TagField. Declaration public TagField (string label , string defaultValue ); Parameters Parameter Description label The text to use as a label for the field. defaultValue The initial tag value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37452074aabd
unity_docs
scripting
What is `UIElements.BaseListView.listViewWithFooterUssClassName` in Unity? Explain its purpose and usage.
BaseListView.listViewWithFooterUssClassName public static string listViewWithFooterUssClassName ; Description The USS class name for ListView when add/remove footer is enabled. Unity adds this USS class to ListView when showAddRemoveFooter is set to true . Any styling applied to this class affects every l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2021aa59e6e3
unity_docs
scripting
What is `Progress.Exists` in Unity? Explain its purpose and usage.
Progress.Exists Declaration public static bool Exists (int id ); Parameters Parameter Description id The unique ID to search for. Returns bool True if the progress indicator exists, false otherwise. Description Checks whether a progress indicator with the specified ID exists.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2566dc0bce6
unity_docs
rendering
Show me a Unity C# example demonstrating `Experimental.Rendering.GraphicsStateCollection.WarmUpProgressively`.
ssively Declaration public Unity.Jobs.JobHandle WarmUpProgressively (int count , Unity.Jobs.JobHandle dependency ); Parameters Parameter Description count The maximum number of variants to warm up. dependency Job to wait for. Returns JobHandle Handle to prewarming job. Description Prewarms the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e581f513154
unity_docs
editor
What is `EditorGUI.GetPropertyHeight` in Unity? Explain its purpose and usage.
EditorGUI.GetPropertyHeight Declaration public static float GetPropertyHeight ( SerializedProperty property , bool includeChildren ); Declaration public static float GetPropertyHeight ( SerializedPropertyType type , GUIContent label ); Declaration public static float GetPropertyHeight ( SerializedPro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4dbce62861c0
unity_docs
xr
What is `ShaderData.Pass.PreprocessVariant` in Unity? Explain its purpose and usage.
ShaderData.Pass.PreprocessVariant Declaration public ShaderData.PreprocessedVariant PreprocessVariant ( Rendering.ShaderType shaderType , string[] keywords , Rendering.ShaderCompilerPlatform shaderCompilerPlatform , BuildTarget buildTarget , bool stripLineDirectives ); Declaration public ShaderData.P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dd3fdfdea6ec
unity_docs
physics
In Unity's 'Introduction to collision', what is 'Trigger colliders' and how does it work?
Trigger colliders don’t cause collisions. Instead, they detect other Colliders that pass through them, and call functions that you can use to initiate events (see Use collisions to trigger other events ). To turn a collider into a trigger collider, enable the Is Trigger property on the Collider component. A trigger col...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0434e5b544bc
unity_docs
performance
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerUnsafeUtility.CategoryInternal` in Unity? Explain its purpose and usage.
ProfilerUnsafeUtility.CategoryInternal public static ushort CategoryInternal ; Description Internal Unity systems Profiler category. This Profiler category does not have its own visualization in the CPU Usage Profiler chart. Instead, Profiler samples generated with this category will add their self time to the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e5ef6cef6304
unity_docs
scripting
What is `Rendering.BatchDrawCommandProcedural.visibleOffset` in Unity? Explain its purpose and usage.
BatchDrawCommandProcedural.visibleOffset public uint visibleOffset ; Description The index of the element in BatchCullingOutputDrawCommands.visibleInstances that matches the first instance in this draw command.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8788b23f6253
unity_docs
scripting
What is `AvatarMask.SetTransformActive` in Unity? Explain its purpose and usage.
AvatarMask.SetTransformActive Declaration public void SetTransformActive (int index , bool value ); Parameters Parameter Description index The index of the transform. value Active or not. Description Sets the tranform at the given index to active or not.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e44398266012
unity_docs
rendering
What is `DefaultLightingExplorerExtension.GetLightProbeColumns` in Unity? Explain its purpose and usage.
DefaultLightingExplorerExtension.GetLightProbeColumns Declaration protected LightingExplorerTableColumn[] GetLightProbeColumns (); Returns LightingExplorerTableColumn[] Column definitions for Light Probes. Description Returns column definitions for Light Probes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a11979ee327
unity_docs
networking
What is `Networking.IMultipartFormSection.contentType` in Unity? Explain its purpose and usage.
IMultipartFormSection.contentType public string contentType ; Returns string The value to use in the Content-Type header, or null . Description Returns the value to use in the Content-Type header for this form section. If this property returns a non-null, non-empty string, then the returned string wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c74052aefa9
unity_docs
physics
What is `PhysicsShape2D.radius` in Unity? Explain its purpose and usage.
PhysicsShape2D.radius public float radius ; Description The radius of the shape. All PhysicsShapeType2D use this radius with the exception of the Polygon type. Refer to the individual shape types for details on how the radius is used for the respective shape. ```csharp using UnityEngine; using UnityEngine....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_44006150af81
unity_docs
performance
Explain 'Write multithreaded code with the job system' in Unity.
The job system lets you write simple and safe multithreaded code so that your application can use all available CPU cores to execute your code. This can help improve the performance of your application. Topic Description Job system overview Understand Unity’s job system. Jobs overview Understand the type of jobs availa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_563584a39c9f
unity_docs
rendering
Give me an overview of the `SpriteSortPoint` class in Unity.
SpriteSortPoint enumeration Description Determines the position of the Sprite used for sorting the Renderer . Properties Property Description Center The center of the Sprite is used as the point for sorting the Renderer. Pivot The pivot of the Sprite is used as the point for sorting the Renderer.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_53f8040f3d59
unity_docs
audio
Show me a Unity C# example demonstrating `AudioChorusFilter.rate`.
AudioChorusFilter.rate public float rate ; Description Chorus modulation rate in hz. 0.0 to 20.0. Default = 0.8 hz. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioChorusFilter))] public class Example : MonoBehaviour { // Set the rate on the chorus filter to 1...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e540d6fee5de
unity_docs
scripting
In Unity's 'Button', what is 'Change the Button icon position' and how does it work?
When you add an icon to a Button, it adds two read-only sub-elements to the Button: An Image element to define the icon image. A TextElement to define the button text. You can’t edit the sub-elements but you can change their layout using the USS flex-direction property for the Button element. By default, the icon is ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1122594cee0f
unity_docs
performance
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerUnsafeUtility.BeginSampleWithMetadata` in Unity? Explain its purpose and usage.
ProfilerUnsafeUtility.BeginSampleWithMetadata Declaration public static void BeginSampleWithMetadata (IntPtr markerPtr , int metadataCount , void* metadata ); Parameters Parameter Description markerPtr Profiler marker handle. metadataCount Metadata parameters count. metadata Unsafe pointer to the Profi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6d66e387035
unity_docs
scripting
Show me a Unity C# example demonstrating `Quaternion.w`.
Quaternion.w public float w ; Description W component of the Quaternion. Do not directly modify quaternions. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine;// Quaternion-w script example // Create a Sphere and apply a texture to help the orientation be recognised. // At...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13d1bd4cca30
unity_docs
rendering
Explain 'Color over Lifetime module reference' in Unity.
This module specifies how a particle ’s color and transparency changes over its lifetime. ## Properties For some properties in this section, you can use different modes to set their value. For information on the modes you can use, refer to Vary Particle System properties over time . Property: Function: Color The colo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4acc4feb3e1b
unity_docs
scripting
What is `Android.AndroidAssetPackStatus.Pending` in Unity? Explain its purpose and usage.
AndroidAssetPackStatus.Pending Description Indicates that the Android asset pack status should soon change. Additional resources: AndroidAssetPacks.DownloadAssetPackAsync , AndroidAssetPacks.GetAssetPackStateAsync .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b07deb0bb07
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.ObjectIdRequest`.
ility: URP: Supported by falling back on the Built-In Render Pipeline implementation when called in the editor. HDRP: Supported by falling back on the Built-In Render Pipeline implementation when called in the editor. This render request is not currently supported outside of the editor. Additional resources: Camera...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69c6976dac33
unity_docs
scripting
What is `Search.SearchTable.Clone` in Unity? Explain its purpose and usage.
SearchTable.Clone Declaration public Search.SearchTable Clone (string newName ); Parameters Parameter Description newName Name of the new table configuration. Returns SearchTable The newly created search table, ready to be saved. Description Creates a copy of the search table configuration. New co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dfb29dc47406
unity_docs
rendering
In Unity's 'Code examples: Call JavaScript and C/C++/C# functions in Unity', what is 'Call C/C++/C# code in Unity C# scripts example' and how does it work?
The following code is an example C++ plug-in with simple functions that you can call in your Unity project. ```csharp #include <stdio.h> extern "C" void Hello () { printf("Hello, world!\n"); } extern "C" int AddNumbers (int x, int y) { return x + y; } ``` Then, use the following Unity C# code in your Unity project ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3fc186c84eea_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The type of trigger to use to spawn an object. Signature: ```csharp public enum SpawnTriggerType ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_2a6a103a2744
unity_docs
editor
What is `Handles.lineThickness` in Unity? Explain its purpose and usage.
Handles.lineThickness public static float lineThickness ; Description Retrieves the user preference setting that controls the thickness of tool handle lines. (Read Only) Tools like Move, Scale, or Rotate display their lines using this thickness value. Users can set this value in the Editor's [Preferences] Prefe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f370b45f5aa6
unity_docs
animation
In Unity's 'How Root Motion works', what is 'Animation Clip Inspector' and how does it work?
The Animation Clip Editor settings - Root Transform Rotation , Root Transform Position (Y) and Root Transform Position (XZ) - let you control the Root Transform projection from the Body Transform. Depending on these settings some parts of the Body Transform may be transferred to Root Transform. For example you can deci...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9a73455d054
unity_docs
networking
What is `Random.state` in Unity? Explain its purpose and usage.
Random.state public static Random.State state ; Description Gets or sets the full internal state of the random number generator. This property can be used to save and restore a previously saved state of the random number generator. Note that state is serializable, so that determinism can be preserved acr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17458e610708
unity_docs
scripting
What is `ObjectChangeKind.DestroyGameObjectHierarchy` in Unity? Explain its purpose and usage.
ObjectChangeKind.DestroyGameObjectHierarchy Description A change of this type indicates that a GameObject and the entire hierarchy below it has been destroyed. This happens for example when Undo.DestroyObjectImmediate is used with an GameObject .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4abdbdb8be66
unity_docs
physics
What is `PhysicsSceneExtensions` in Unity? Explain its purpose and usage.
PhysicsSceneExtensions class in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description Scene extensions to access the underlying physics scene. Static Methods Method Description GetPhysicsScene An extension method that returns the 3D physics Scene from the Scene.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1091c7946bc6
unity_docs
rendering
What is `UIElements.DynamicAtlasFilters.Format` in Unity? Explain its purpose and usage.
DynamicAtlasFilters.Format Description Excludes textures that, because of their format, would lose precision, or be truncated when the system adds them to the atlas. The dynamic atlas system accepts non-HDR texture formats that have 8 bits or less per component, before compression You can add a compressed textur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db7d2fec6168
unity_docs
math
What is `BoundsInt.xMin` in Unity? Explain its purpose and usage.
BoundsInt.xMin public int xMin ; Description The minimal x point of the box. Only points with an x component greater than or equal to this value are contained in the box. Sets the minimum value of BoundsInt 's x point. If you enter a minimum value that is greater than the current maximum value, then the enter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7f7962d40cd
unity_docs
audio
Show me a Unity C# example demonstrating `Search.ObjectIndexer.IndexPropertyComponents`.
rty. name Key used to retrieve the value. value Value to add to the index. Description Indexes multiple variations of a property value. In the example, indexing "AudioClipComponent", will split the word in many ways and index variations such as "Audio", "Clip", "Component", "ACC", etc. The user will be able to s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_19391b39c798
unity_docs
editor
What is `AssetDatabase.StartAssetEditing` in Unity? Explain its purpose and usage.
AssetDatabase.StartAssetEditing Declaration public static void StartAssetEditing (); Description Pauses automatic asset import, allowing you to group several asset imports together into one larger import. This method allows you to pause the Asset Database's automatic import of new or modified assets. This is us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97fed36071de
unity_docs
math
What is `Color.grayscale` in Unity? Explain its purpose and usage.
Color.grayscale public float grayscale ; Description The grayscale value of the color. (Read Only) Unity uses the following formula to calculate the grayscale value: (0.299f * Color.r) + (0.587f * Color.g) + (0.114f * Color.b) . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c2bc48425dd9
unity_docs
rendering
What is `Rendering.GraphicsTextureState.Constructed` in Unity? Explain its purpose and usage.
GraphicsTextureState.Constructed Description The GraphicsTexture constructor has started execution. This is the initial state of a GraphicsTexture. At this state, the descriptor is uninitialized and the GraphicsTexture is not ready to be used. Additional resources: GraphicsTextureDescriptor , GraphicsTexture.desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da431b1d1ee0
unity_docs
scripting
What is `Physics2D.gravity` in Unity? Explain its purpose and usage.
Physics2D.gravity public static Vector2 gravity ; Description Acceleration due to gravity. Set this vector to change all 2D gravity in your Scene. The default is (0, -9.8). ```csharp //Attach this script to a 2D GameObject (for example a Sprite). //Attach a Rigidbody component to the GameObject (Click the Ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5bdb83e153e8
unity_docs
math
Show me a Unity code example for 'Serialization rules'.
ally need one of the features that [SerializeReference] supports. For full details on how to use [SerializeReference] , refer to the SerializeReference documentation. ## Serialization of properties Unity doesn’t normally serialize properties except in the following situations: If a property has an explicit backing fi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6ec66cb58f3
unity_docs
physics
What is `Physics2D.OverlapCircle` in Unity? Explain its purpose and usage.
Physics2D.OverlapCircle Declaration public static Collider2D OverlapCircle ( Vector2 point , float radius , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description point Centre of the circle. radius The radius of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_374d4ed54743
unity_docs
physics
What is `WheelHit` in Unity? Explain its purpose and usage.
WheelHit struct in UnityEngine / Implemented in: UnityEngine.VehiclesModule Description Contact information for the wheel, reported by WheelCollider . Friction for the WheelCollider is computed separately from the rest of the physics, using a slip based tire friction model. This allows for more realistic beh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c886fed567c
unity_docs
editor
What is `PlayerSettings.Android.splashScreenScale` in Unity? Explain its purpose and usage.
PlayerSettings.Android.splashScreenScale public static AndroidSplashScreenScale splashScreenScale ; Description Android splash screen scale mode. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Build;public class SplashScreenScaleSample : MonoBehaviour { [MenuItem("Build/Splash Screen Scal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5859871257a
unity_docs
rendering
What is `Rendering.CopyTextureSupport` in Unity? Explain its purpose and usage.
CopyTextureSupport enumeration Description Support for various Graphics.CopyTexture cases. Most modern platforms and graphics APIs support quite flexible texture copy (e.g. copy from a RenderTexture into a Cubemap face). However some older systems might not support certain parts of texture copy functionality...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_385d8388d63f
unity_docs
editor
Give me an overview of the `EditorBuildSettingsScene` class in Unity.
EditorBuildSettingsScene class in UnityEditor Description Represents entries in the Scenes list, as displayed in the Build Profiles window. This class contains the path of a Scene and an enabled flag that indicates whether the Scene is enabled in the Build Profiles window or not. You can use this class in combi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cec53f8d7d13
unity_docs
rendering
What is `GUI.BeginGroup` in Unity? Explain its purpose and usage.
GUI.BeginGroup Declaration public static void BeginGroup ( Rect position ); Declaration public static void BeginGroup ( Rect position , string text ); Declaration public static void BeginGroup ( Rect position , Texture image ); Declaration public static void BeginGroup ( Rect position , GUIC...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9bd9d43fa10a
github
scripting
Write a Unity C# physics script for Projectile
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; public class Projectile : MonoBehaviour { // Determines the location that the projectile will be instantiated. public GameObject spawnPosition; // The projectile prefab. public GameObject spawnPrefab; // H...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_9d0b1e014442
unity_docs
xr
Explain 'Graphics tiers in the Built-In Render Pipeline' in Unity.
In the Built-in Render Pipeline , you can use graphics tiers to apply different graphics settings when your application runs on hardware with different capabilities. You can use Unity’s built-in tier settings to configure common settings, or you can define custom behaviors in your own shader code or C# code. Note: This...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.