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_6cd753fbd0a2
unity_docs
math
What is `Rendering.BatchCullingContext` in Unity? Explain its purpose and usage.
BatchCullingContext struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Culling context for a batch. Specifies the data required to perform culling. Additional resources: OnPerformCulling . Properties Property Description cullingFlags Additional culling information for the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_355d3fd953ac
unity_docs
editor
Show me a Unity C# example demonstrating `Android.IPostGenerateGradleAndroidProject.OnPostGenerateGradleAndroidProject`.
nerated Gradle files before the build process begins. Note : To compile the script for this function as an Editor script and prevent any compilation errors related to the UnityEditor.Android namespace, use one of these methods: Place the script in the Assets/Editor folder of your project. Create an assembly defin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc27b2bd9964
unity_docs
rendering
Show me a Unity C# example demonstrating `Mesh.GetIndexBuffer`.
that, first request an appropriate buffer binding target via indexBufferTarget , then get the mesh data using GetIndexBuffer , and then set it up as a parameter for your shaders using ComputeBuffer.SetBuffer, Material.SetBuffer and similar methods. If you modify the CPU copy of the data, this can cause the GPU inde...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9479e7d846fe
unity_docs
scripting
What is `Display.SetRenderingResolution` in Unity? Explain its purpose and usage.
Display.SetRenderingResolution Declaration public void SetRenderingResolution (int w , int h ); Parameters Parameter Description w The rendering width in pixels. h The rendering height in pixels. Description Sets rendering resolution for the display. This method is only supported on Android and iOS pla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4537b0305403
unity_docs
editor
In Unity's 'Create custom packages', what is 'Creating a new local package' and how does it work?
Follow these instructions if you want to create a custom package outside your project folder. Note : These instructions are part of the larger procedure for Creating custom packages . Using your computer’s file manager (for example the Windows File Explorer or the macOS Finder), create a folder for your package. You ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8ad938bd98bb
unity_docs
physics
In Unity's 'Create rule set files', what is 'Step 3: Add a custom ruleset' and how does it work?
In Assets/Subfolder, create a .ruleset file, and give it any name you like (in this exampleHello.ruleset ): ``` <?xml version="1.0" encoding="utf-8"?> <RuleSet Name="New Rule Set" Description=" " ToolsVersion="10.0"> <Rules AnalyzerId="ErrorProne.NET.CodeAnalyzers" RuleNamespace="ErrorProne.NET.CodeAnalyzers"> <Rule ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ec5211d7289
unity_docs
scripting
What is `Time.maximumDeltaTime` in Unity? Explain its purpose and usage.
Time.maximumDeltaTime public static float maximumDeltaTime ; Description The maximum value of Time.deltaTime in any given frame. This is a time in seconds that limits the increase of Time.time between two frames. When a very slow frame happens, maximumDeltaTime limits the value of Time.deltaTime in the fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2a854dda3550
unity_docs
rendering
What is `WebCamKind.ColorAndDepth` in Unity? Explain its purpose and usage.
WebCamKind.ColorAndDepth Description Camera which supports synchronized color and depth data (currently these are only dual back and true depth cameras on latest iOS devices). Additional resources: WebCamDevice.kind , WebCamDevice.depthCameraName , WebCamTexture.isDepth .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86fd97dc559f
unity_docs
xr
What is `XR.XRSettings.loadedDeviceName` in Unity? Explain its purpose and usage.
XRSettings.loadedDeviceName public static string loadedDeviceName ; Description Type of XR device that is currently loaded. Note: Rendering to the device may not be happening even though it is loaded. See XRSettings.enabled . In order to change the currently loaded device or reload the current device, use XRS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1df6167caca
unity_docs
scripting
What is `UIElements.BaseCompositeField_3` in Unity? Explain its purpose and usage.
BaseCompositeField<T0,T1,T2> class in UnityEngine.UIElements / Inherits from: UIElements.BaseField_1 / Implemented in: UnityEngine.UIElementsModule Description This is the base class for the composite fields. Static Properties Property Description fieldGroupUssClassName USS class name of field groups ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93c1761c77b1
unity_docs
scripting
Show me a Unity C# example demonstrating `ObjectFactory.CreateGameObject`.
hideFlags , string name , params Type[] types ); Parameters Parameter Description name Name of the GameObject. types The optional types to add to the GameObject when created. scene Scene where the GameObject should be created. hideFlags HideFlags to assign to the GameObject. Returns GameObject Return...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75882fe9ffbe
unity_docs
rendering
What is `Cubemap.ctor` in Unity? Explain its purpose and usage.
Cubemap Constructor Declaration public Cubemap (int width , TextureFormat textureFormat , bool mipChain ); Declaration public Cubemap (int width , TextureFormat textureFormat , bool mipChain , bool createUninitialized = false); Declaration public Cubemap (int width , TextureFormat format , in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d06fc07e959
unity_docs
scripting
Show me a Unity C# example demonstrating `ISerializationCallbackReceiver`.
it's called on any of the host object's managed references. OnAfterDeserialize is called on the host object before it's called on any of the host object's managed references. For a full explanation of the SerializeReference attribute's behaviour, refer to SerializeReference . For more information on when and how ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_000e3cb57e64
unity_docs
rendering
What is `SpriteDrawMode.Tiled` in Unity? Explain its purpose and usage.
SpriteDrawMode.Tiled Description The SpriteRenderer will render the sprite as a 9-slice image where the corners will remain constant and the other sections will tile. In this draw mode, the corners will remain unscaled while the other sections will be repeated instead of stretched. It uses the Sprite.border value...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b23ba5ac97b
unity_docs
rendering
What is `ShaderVariantCollection.WarmUp` in Unity? Explain its purpose and usage.
ShaderVariantCollection.WarmUp Declaration public void WarmUp (); Description Prewarms all shader variants in this shader variant collection. For information on shader loading and prewarming, including a list of different prewarming techniques, see Shader loading . Warning: This method is fully supported on D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6e6c7d07c83e_doc_5
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Gets or sets the class type for the objects in this pool. Signature: ```csharp public Type ClassType ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_1dbffdd2ddd7
unity_docs
math
Show me a Unity code example for 'Using randomness'.
he different values). To find which array element the point is “in”, firstly check to see if it is less than the value in the first element. If so, then the first element is the one selected. Otherwise, subtract the first element’s value from the point value and compare that to the second element and so on until the co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31a14f90530d
unity_docs
scripting
What is `UIElements.FocusEvent` in Unity? Explain its purpose and usage.
FocusEvent class in UnityEngine.UIElements / Inherits from: UIElements.FocusEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Event sent immediately after an element has gained focus. This event trickles down and does not bubbles up. Inherited Members Properties Property Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_26
github
scripting
What does `UpdateAsObservable` do in this Unity script? Explain its purpose and signature.
Update is called every frame, if the MonoBehaviour is enabled. Signature: ```csharp public static IObservable<Unit> UpdateAsObservable(this Component component) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_affe2f8c08ad
unity_docs
rendering
What is `Rect.ctor` in Unity? Explain its purpose and usage.
Rect Constructor Declaration public Rect (float x , float y , float width , float height ); Parameters Parameter Description x The X value the rect is measured from. y The Y value the rect is measured from. width The width of the rectangle. height The height of the rectangle. Description Creates a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75568f4fef55
unity_docs
scripting
What is `Rendering.BatchDrawRange.drawCommandsCount` in Unity? Explain its purpose and usage.
BatchDrawRange.drawCommandsCount public uint drawCommandsCount ; Description The number of draw commands , starting from BatchDrawRange.drawCommandsBegin , this draw range applies to. This must be at least 1 .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c1bc59083ec4
unity_docs
rendering
In Unity's 'Model Import Settings reference', what is 'Model' and how does it work?
Contains settings for 3D models, which can represent a character, a building, or a piece of furniture. In these cases, Unity creates multiple assets from a single model file . In the Project window, the main imported object is a model prefab . Usually there are also several mesh objects that the model prefab references...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_78e83f23aafe
unity_docs
rendering
Explain 'Input data into HLSL' in Unity.
To pass data into a custom shader in High-Level Shader Language (HLSL), create a struct that declares shader variables and connects them to the mesh vertex data. Use one of the following methods: Include a prebuilt vertex structure from Unity’s shader library. Declare a custom vertex structure. ## Include a prebuilt s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d02899ff1369
unity_docs
scripting
What is `ArticulationBody.SetDriveLimits` in Unity? Explain its purpose and usage.
ArticulationBody.SetDriveLimits Declaration public void SetDriveLimits ( ArticulationDriveAxis axis , float lower , float upper ); Parameters Parameter Description axis The drive axis. lower The lower limit of the drive. upper The upper limit of the drive. Description Sets the lower and upper limit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9637dfff96e0
unity_docs
physics
What is `AI.NavMesh.avoidancePredictionTime` in Unity? Explain its purpose and usage.
NavMesh.avoidancePredictionTime public static float avoidancePredictionTime ; Description Describes how far in the future the agents predict collisions for avoidance. The larger the value, the earlier the agents will start to avoid each other if they are on collision course. The value is measured in seconds. De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2a1767d06c55
unity_docs
rendering
What are the parameters of `Accessibility.VisionUtility.GetColorBlindSafePalette` in Unity?
Returns int The number of unambiguous colors in the palette. Description Gets a palette of colors that should be distinguishable for normal vision, deuteranopia, protanopia, and tritanopia. The set of colors from which to draw, along with their perceived luminance values. Allocate the size of your palette before passin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8a9d3ce5c421
unity_docs
rendering
Show me a Unity C# example demonstrating `Experimental.Rendering.GraphicsStateCollection.EndTrace`.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsStateCollection.EndTrace Declaration public void EndTrace (); Description Stop tracing shader variants and graphics states encountered at runtime. ```csharp using UnityEngine; using UnityEngine.Experimental.Rendering...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c154327561aa
unity_docs
scripting
What is `XR.InputDevices.deviceConfigChanged` in Unity? Explain its purpose and usage.
InputDevices.deviceConfigChanged Parameters Parameter Description value The InputDevice whose configuration has changed. Description Defines the delegate to use to register events when an InputDevice 's configuration changes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e38459a016b
unity_docs
xr
What is `ResourcesAPI.LoadAsync` in Unity? Explain its purpose and usage.
ResourcesAPI.LoadAsync Declaration protected ResourceRequest LoadAsync (string path , Type systemTypeInstance ); Parameters Parameter Description path Path to the target resource to load. systemTypeInstance Type filter for objects returned. Description Override for customizing the behavior of the Res...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db8c9ac2faf3
unity_docs
scripting
What is `WSA.SecondaryTileData.foregroundText` in Unity? Explain its purpose and usage.
SecondaryTileData.foregroundText public WSA.TileForegroundText foregroundText ; Description Defines the style for foreground text on a secondary tile. Default value is TileForegroundText.Default.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2ed64b33b14
unity_docs
performance
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderDescription.DataType` in Unity? Explain its purpose and usage.
ProfilerRecorderDescription.DataType public Unity.Profiling.LowLevel.ProfilerMarkerDataType DataType ; Description Gets the data value type of the Profiler metric. Represents value data type of the Profiler metric.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_23f9eb8531f1
unity_docs
audio
Show me a Unity code example for 'Develop an ambisonic audio decoder'.
sAmbisonicDecoder effect definition flag The UnityAudioAmbisonicData data struct ## UnityAudioEffectDefinitionFlags_IsAmbisonicDecoder During the plug-in scanning phase, the UnityAudioEffectDefinitionFlags_IsAmbisonicDecoder flag notifies Unity that this is an ambisonic decoder effect. To enable a plug-in to operate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2857caefb0cd
unity_docs
rendering
What is `ShaderUtil.GetPropertyCount` in Unity? Explain its purpose and usage.
ShaderUtil.GetPropertyCount Declaration public static int GetPropertyCount ( Shader s ); Parameters Parameter Description s The shader to check against. Description Get the number of properties in Shader s.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50480164fb53
unity_docs
rendering
What is `Rendering.CommandBuffer.EnableShaderKeyword` in Unity? Explain its purpose and usage.
CommandBuffer.EnableShaderKeyword Declaration public void EnableShaderKeyword (string keyword ); Parameters Parameter Description keyword Name of a global shader keyword to enable. Description Adds a command to enable a global keyword with a given name. If a global keyword with the name you pass in does n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_feae77408675
unity_docs
physics
In Unity's 'Panel Settings properties reference', what is 'Scale with Screen Size' and how does it work?
Set elements to grow or shrink depending on the screen size. Parameters Description Screen Match Mode Set how to scale elements when the screen resolution is different from the Reference Resolution : Match Width or Height : Scale the canvas area with the width or the height as reference, or a linear interpolation betwe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55e456546dca
unity_docs
physics
What is `PolygonCollider2D.CreatePrimitive` in Unity? Explain its purpose and usage.
PolygonCollider2D.CreatePrimitive Declaration public void CreatePrimitive (int sides , Vector2 scale = Vector2.one, Vector2 offset = Vector2.zero); Parameters Parameter Description sides The number of sides in the polygon. This must be greater than two. scale The X/Y scale of the polygon. These mus...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_05c4c37dcc8d
unity_docs
rendering
In Unity's 'Get frame timing data', what is 'Use a custom Profiler module' and how does it work?
To view frame timing data in a custom Profiler module perform the following steps: Create a custom profiler module according to the instructions on Creating a custom profiler module . Open the Profiler window ( Window > Analysis > Profiler ) Open the Profiler Module Editor ( Profler Modules dropdown > gear icon) and se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d03778ac5c01
unity_docs
math
What are the parameters of `Rendering.RayTracingAccelerationStructure.AddInstance` in Unity?
Returns int A value representing a handle that you can use to perform later actions (e.g. RemoveInstance). Description Adds a ray tracing instance to the RayTracingAccelerationStructure. Ray tracing instances in the acceleration structure contain an 8-bit user defined instance mask. The TraceRay() HLSL function has an ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_621a3a07832d
unity_docs
editor
Show me a Unity C# example demonstrating `SettingsProvider.GetSearchKeywordsFromPath`.
SettingsProvider.GetSearchKeywordsFromPath Declaration public static IEnumerable<string> GetSearchKeywordsFromPath (string path ); Parameters Parameter Description path Path of the Asset on disk. Returns IEnumerable<string> Returns the list of keywords. Description Extract search keywords from the se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_218bc6b58086
unity_docs
scripting
What is `Experimental.GraphView.GraphViewBlackboardWindow.OnGraphViewChanged` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphViewBlackboardWindow.OnGraphViewChanged Declaration protected void OnGraphViewChanged (); Description Callback invoked when the GraphView has changed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_adceba291d04
unity_docs
scripting
What is `UIElements.CurveField.ctor` in Unity? Explain its purpose and usage.
CurveField Constructor Declaration public CurveField (); Description Initializes and returns an instance of CurveField. Declaration public CurveField (string label ); Parameters Parameter Description label The text to use as a label. Description Initializes and returns an instance of CurveField.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_261e068ef182
unity_docs
physics
What is `VersionControl.Provider.IsOpenForEdit` in Unity? Explain its purpose and usage.
Provider.IsOpenForEdit Declaration public static bool IsOpenForEdit ( VersionControl.Asset asset ); Parameters Parameter Description asset Asset to test. Description Returns true if an asset can be edited. Version control systems like Perforce or Plastic SCM require that an asset be checked out before it...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5fba01ee5de3
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.ForceOverLifetimeModule.zMultiplier`.
ParticleSystem.ForceOverLifetimeModule.zMultiplier public float zMultiplier ; Description Defines the z-axis multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall z-axis multiplier. ```csharp using UnityEngine; using System.Collections;[Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16922a146989
unity_docs
editor
What is `Networking.PlayerConnection.PlayerConnectionGUI.ConnectionTargetSelectionDropdown` in Unity? Explain its purpose and usage.
PlayerConnectionGUI.ConnectionTargetSelectionDropdown Declaration public static void ConnectionTargetSelectionDropdown ( Rect rect , Networking.PlayerConnection.IConnectionState state , GUIStyle style ); Parameters Parameter Description rect Where to draw the drop-down button. state The state for th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c86b57f4de9
unity_docs
rendering
What is `LightTransport.PostProcessing.RadeonRaysProbePostProcessor.DeringSphericalHarmonicsL2` in Unity? Explain its purpose and usage.
RadeonRaysProbePostProcessor.DeringSphericalHarmonicsL2 Declaration public bool DeringSphericalHarmonicsL2 ( LightTransport.IDeviceContext context , BufferSlice<SphericalHarmonicsL2> shIn , BufferSlice<SphericalHarmonicsL2> shOut , int probeCount ); Parameters Parameter Description context Device context...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e6778ad6c01f
unity_docs
scripting
Show me a Unity code example for 'Move elements at runtime'.
project with any template. In the Project window , create a folder named UI to store the UXML and USS files. In the UI folder, create a UXML file named NameTagContainer.uxml . Double-click the NameTagContainer.uxml file to open it in the UI Builder. Add a VisualElement to the Hierarchy panel and name it as BaseContaine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e2cad4eb117a
unity_docs
rendering
In Unity's 'Platform-specific texture overrides panel reference', what is 'Default formats' and how does it work?
The following table lists the default Format Unity selects in the platform-specific override tab, based on the Format and Compression settings in the Default tab. For more information about each format, refer to GPU texture formats reference . Platform Texture channels Format for no compression Format for Normal Qualit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1d2c159fa6b7
unity_docs
scripting
What are the parameters of `EditorGUILayout.InspectorTitlebar` in Unity?
Returns bool The foldout state selected by the user. Description Make an inspector-window-like titlebar. Create a custom inspector that shows the X,Y,Z,W quaternion components on the rotation. ```csharp // Create a custom transform inspector that shows the X,Y,Z,W // quaternion components instead of the rotation angles...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_92c0a5973c8e
unity_docs
rendering
What is `GraphicsBuffer` in Unity? Explain its purpose and usage.
GraphicsBuffer class in UnityEngine / Implemented in: UnityEngine.CoreModule Description GPU graphics data buffer, for working with geometry or compute shader data. ComputeShader programs often need to read or write arbitrary data from or to memory buffers, and some rendering algorithms need a lower level acce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21302f1c3419
unity_docs
rendering
What is `TextureFormat.RGHalf` in Unity? Explain its purpose and usage.
TextureFormat.RGHalf Description Two color (RG) texture format, 16 bit floating point per channel. Note that not all graphics cards support all texture formats, use SystemInfo.SupportsTextureFormat to check.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d6ad7a0c086
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGB_BC6H_UFloat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGB_BC6H_UFloat Description A three-component, block-compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned floating-point RGB texel data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de08da737ce5
unity_docs
physics
Show me a Unity C# example demonstrating `MonoBehaviour.OnJointBreak2D`.
rque of the joint, the joint will break. When the joint breaks, Joint2D.OnJointBreak2D will be called and the specific Joint2D that broke will be passed in. After Joint2D.OnJointBreak2D is called, the joint action depends on the option selected in Joint2D.breakAction . Additional resources: Joint2D.breakForce ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a53eee07bc4
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.ExternalForcesModule.RemoveInfluence`.
emForceField field ); Parameters Parameter Description index The index to remove the chosen Force Field from. field The Force Field to remove from the list. Description Removes the Force Field from the influencers list at the given index. When influenceFilter is set to ParticleSystemGameObjectFilter.Li...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a326a9e5b629_doc_3
github
scripting
What does `Condition` do in this Unity script? Explain its purpose and signature.
A block of code (see ) that returnsa value of type boolean. This code may be executed asmany times as necessary by the function it is passed to.Note that a Condition is usually a closure, meaningthat it uses variables defined outside of it's scope.This is important, as a constant Condition may cause endlessloops, e.g. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f93ecf5ce004
unity_docs
scripting
What is `Tilemaps.ITilemap.GetComponent` in Unity? Explain its purpose and usage.
ITilemap.GetComponent Declaration public T GetComponent (); Returns T The Component of type T to retrieve. Description Returns the component of type T if the GameObject of the tile map has one attached, null if it doesn't.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_851ccbe30899
unity_docs
scripting
What is `WindZoneMode.Spherical` in Unity? Explain its purpose and usage.
WindZoneMode.Spherical Description Wind zone only has an effect inside the radius, and has a falloff from the center towards the edge. ```csharp // Creates a Spherical Wind Zone. using UnityEngine;public class ExampleScript : MonoBehaviour { void Start() { var wind = gameObject.AddComponent<WindZone>(); wind.mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a031220520d4
unity_docs
rendering
What is `ModelImporterMaterialName.BasedOnMaterialName` in Unity? Explain its purpose and usage.
ModelImporterMaterialName.BasedOnMaterialName Description Use a material name of the form <materialName>.mat . Material names will be accepted in the form <materialName>.mat when searching for existing materials or creating new ones. Additional resources: ModelImporter.materialName .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efa3bbee1e9f
unity_docs
rendering
What is `TrailRenderer.Clear` in Unity? Explain its purpose and usage.
TrailRenderer.Clear Declaration public void Clear (); Description Removes all points from the TrailRenderer. Useful for restarting a trail from a new position. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(TrailRenderer))] public class ExampleClass : MonoBehaviour { private Tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2c7e7344219
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.GetColorComponentCount` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.GetColorComponentCount Declaration public static uint GetColorComponentCount ( Experimental.Rendering.GraphicsFormat format ); Declaration public static uint GetColorComponentCount ( TextureFormat fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59c09b55c284
unity_docs
physics
What is `PhysicsVisualizationSettings.DeinitDebugDraw` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.DeinitDebugDraw Declaration public static void DeinitDebugDraw (); Description Deinitializes the physics debug visualization system and tracking of changes Colliders.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6782aad909f7
unity_docs
scripting
What is `Bounds.max` in Unity? Explain its purpose and usage.
Bounds.max public Vector3 max ; Description The maximal point of the box. This is always equal to center+extents . ```csharp using UnityEngine;public class ColliderBounds : MonoBehaviour { Collider m_Collider; Vector3 m_Center; Vector3 m_Size, m_Min, m_Max; void Start() { //Fetch the Collider from the G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_07b360ac9217
unity_docs
scripting
What is `UIElements.PointerEnterEvent.ctor` in Unity? Explain its purpose and usage.
PointerEnterEvent Constructor Declaration public PointerEnterEvent (); Description Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cf8a1c86f70
unity_docs
physics
What is `RigidbodyType2D.Kinematic` in Unity? Explain its purpose and usage.
RigidbodyType2D.Kinematic Description Sets the Rigidbody2D to have kinematic behaviour. Kinematic behaviour stops the Rigidbody2D from reacting to gravity or applied forces including contacts with other Kinematic or Static Rigidbody2D . This type of Rigidbody2D can be moved by setting its Rigidbody2D.ve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_65fdc288fbef
unity_docs
math
Show me a Unity C# example demonstrating `Ray2D.ctor`.
Ray2D Constructor Declaration public Ray2D ( Vector2 origin , Vector2 direction ); Parameters Parameter Description Vector2 Origin. Vector2 Direction. Description Creates a 2D ray starting at origin along direction . ```csharp using UnityEngine;public class ExampleClass : MonoBehaviour { void St...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8b18b54d8ce
unity_docs
physics
What is `PhysicsVisualizationSettings.contactImpulseColor` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.contactImpulseColor public static Color contactImpulseColor ; Description ContactPoint.impulse arrow color. The color of the arrow that represents the ContactPoint.impulse .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6802574a04a
unity_docs
rendering
What is `ParticleSystem.Burst.time` in Unity? Explain its purpose and usage.
ParticleSystem.Burst.time public float time ; Description The time that each burst occurs. Can be either Time or Distance, based on the current emission mode. Additional resources: ParticleSystem.EmissionModule.type.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8bfaf3e5b9de
unity_docs
scripting
What is `IMGUI.Controls.TreeView.GetFoldoutIndent` in Unity? Explain its purpose and usage.
TreeView.GetFoldoutIndent Declaration protected float GetFoldoutIndent ( IMGUI.Controls.TreeViewItem item ); Parameters Parameter Description item Item used to determine the indent. Returns float Indent for the foldout arrow. Description Returns the horizontal foldout offset for an item. This is whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8fd2dd473a13
unity_docs
rendering
Explain 'UWP build settings reference' in Unity.
Use the Universal Windows Platform (UWP) Build Settings to configure and build your application for UWP platform. The UWP build settings are part of the Platform Settings section of the Build Profiles window . To build your application for UWP: Select File > Build Profiles . Select Add Build Profile to open the Platfor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09cdacbd3e2a
unity_docs
scripting
Give me an overview of the `AndroidJavaClass` class in Unity.
AndroidJavaClass class in UnityEngine / Inherits from: AndroidJavaObject / Implemented in: UnityEngine.AndroidJNIModule Description AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class. Note : this API can be used from custom thread, but requires that thread to be attached to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6b0260cd6d5
unity_docs
math
What is `CullingGroup.SetBoundingSpheres` in Unity? Explain its purpose and usage.
CullingGroup.SetBoundingSpheres Declaration public void SetBoundingSpheres (BoundingSphere[] array ); Parameters Parameter Description array The BoundingSphere s to cull. Description Sets the array of bounding sphere definitions that the CullingGroup should compute culling for. Note that the provided arr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0182c2ff61d0
unity_docs
physics
Explain 'Joints' in Unity.
A Joint connects a Rigidbody to another Rigidbody, or to a fixed point in space. Joints can apply forces that move rigid bodies, and joint limits can restrict that movement. You can configure Joints via the Joint class, or the appropriate Joint component. Topic Description Introduction to joints Overview of the concept...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97e2fb89a74e
unity_docs
physics
What is `RaycastHit.point` in Unity? Explain its purpose and usage.
RaycastHit.point public Vector3 point ; Description The impact point in world space where the ray hit the collider. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Apply a force to a rigidbody in the Scene at the point // where it is clicked. // The force with which the target is "poke...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20a96de49cd5
unity_docs
editor
Show me a Unity C# example demonstrating `StaticEditorFlags.OccluderStatic`.
StaticEditorFlags.OccluderStatic Description Mark the GameObject as a Static Occluder in the occlusion culling system. For more information, see the documentation on the Occlusion Culling system . ```csharp using UnityEngine; using UnityEditor; public class StaticEditorFlagsExample { [MenuItem("Examples/Create G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f13f7ddf20ab
unity_docs
rendering
What is `GUIContent.ctor` in Unity? Explain its purpose and usage.
GUIContent Constructor Declaration public GUIContent (); Description Constructor for GUIContent in all shapes and sizes. Build an empty GUIContent. Declaration public GUIContent (string text ); Description Build a GUIContent object containing only text. When using the GUI, you don't need to create GUICo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0941f5d64837
unity_docs
physics
In Unity's 'Debug shaders with Visual Studio', what is 'Creating a placeholder Visual Studio project for Windows Standalone' and how does it work?
If you build your application for Windows Standalone, you must create a placeholder Visual Studio project. If you build your application for Universal Windows Platform, Unity generates a Visual Studio project for you. Launch Visual Studio. Go to File > New > Project > Visual C++ > Empty Project . Go to Project > Proper...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36786d9c8d7c
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R8G8_UInt` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R8G8_UInt Description A two-component, 16-bit unsigned integer format that has an 8-bit R component in byte 0, and an 8-bit G component in byte 1.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c15a8237de68
unity_docs
scripting
Give me an overview of the `IconAttribute` class in Unity.
IconAttribute class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Attribute to specify an icon for a MonoBehaviour or ScriptableObject . Properties Property Description path A project-relative path to a texture. Constructors Constructor Description IconAttribute Create an IconAtt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2e228bca78d
unity_docs
rendering
Show me a Unity C# example demonstrating `QualitySettings.pixelLightCount`.
QualitySettings.pixelLightCount public static int pixelLightCount ; Description The maximum number of pixel lights that should affect any object. If there are more lights illuminating an object, the dimmest ones will be rendered as vertex lights. Use this from scripting if you want to have finer control than o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f249cac30bcd
unity_docs
physics
What are the parameters of `Search.PropertyDatabase.ctor` in Unity?
Description Constructs a new instance of a PropertyDatabase . If filePath does not exist, the file will be created automatically. The PropertyDatabase will not update the backing file automatically, you will have to trigger the update manually with PropertyDatabase.TriggerBackgroundUpdate . If another PropertyDatabase ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9771df91b90b
unity_docs
scripting
What is `Device.Application.consoleLogPath` in Unity? Explain its purpose and usage.
Application.consoleLogPath public static string consoleLogPath ; Description This has the same functionality as Application.consoleLogPath . At the moment, the Device Simulator doesn't support simulation of this property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca61c030a1a7
unity_docs
scripting
What is `TerrainLayerUtility.ShowTerrainLayersSelectionHelper` in Unity? Explain its purpose and usage.
TerrainLayerUtility.ShowTerrainLayersSelectionHelper Declaration public static int ShowTerrainLayersSelectionHelper ( Terrain terrain , int activeTerrainLayer ); Parameters Parameter Description terrain Terrain tile. activeTerrainLayer Currently selected terrain layer index. Returns int Newly selecte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_349274bc6aa7
unity_docs
editor
What are the parameters of `Search.QueryFilterOperator.AddHandler` in Unity?
Returns QueryFilterOperator The current QueryFilterOperator . Description Adds a custom filter operator handler. <TFilterVariable>: The type of the operator's left-hand side operand. This is the type returned by a filter handler. <TFilterConstant>: The type of the operator's right-hand side operand. An operator handler...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e952719d6e7
unity_docs
editor
What is `Rendering.SupportedOnRenderPipelineAttribute` in Unity? Explain its purpose and usage.
SupportedOnRenderPipelineAttribute class in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Set which render pipelines make a class active. Add [SupportedOnRenderPipeline] above a class to set which Render Pipeline Assets make a class active. For example, [SupportedOnRenderPipeli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9dc4b1aa01ec
unity_docs
scripting
What are the parameters of `Search.IPropertyDatabaseView.Store` in Unity?
Returns bool True if the store operation succeeded, false if not. Description Stores a document property. ``` // Store a property of a document, like a property of an asset. using (var view = propertyDatabase.GetView()) { var stored = view.Store("path/to/my/asset", "m_Color", new Color(1, 0, 1)); if (!stored) ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_234e1743a928
unity_docs
scripting
What is `Media.MediaTime.Invalid` in Unity? Explain its purpose and usage.
MediaTime.Invalid public static Media.MediaTime Invalid ; Description Invalid time value. Invalid time values have an invalid rate (see MediaRational.isValid ), regardless of the count value. This utility value just provides one of the many possible invalid MediaTime s.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e56a3d4d25e1
unity_docs
math
What is `Unity.Collections.NativeSlice_1.ToArray` in Unity? Explain its purpose and usage.
NativeSlice<T0>.ToArray Declaration public T[] ToArray (); Returns T[] A managed array with a copy of the contents of the NativeSlice. Description Converts a NativeSlice<T0> to managed array.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eac7f90d716c
unity_docs
editor
What is `Search.QueryEngineFilterAttribute` in Unity? Explain its purpose and usage.
QueryEngineFilterAttribute class in UnityEditor.Search Description Base attribute class used to define a custom filter on a QueryEngine. All filter types supported by QueryEngine.AddFilter are supported by this attribute. For a usage example, see QueryEngine.AddFiltersFromAttribute . Properties Property Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0190e36edfd9
unity_docs
xr
What is `Networking.UnityWebRequest.uri` in Unity? Explain its purpose and usage.
UnityWebRequest.uri public Uri uri ; Description Defines the target URI for the UnityWebRequest to communicate with. The passed Uri must be full absolute URI. This property cannot be set after calling SendWebRequest . If the UnityWebRequest encounters and follows redirects, this property will be updated wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5405fa3b5b00
unity_docs
ui
What is `Experimental.GraphView.ISelectable.IsSelected` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ISelectable.IsSelected Declaration public bool IsSelected ( UIElements.VisualElement selectionContainer ); Parameters Parameter Description selectionContainer Container in which the selection is tracked. Returns bool ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c02ec288610
unity_docs
xr
What is `Networking.UnityWebRequest.uploadProgress` in Unity? Explain its purpose and usage.
UnityWebRequest.uploadProgress public float uploadProgress ; Description Returns a floating-point value between 0.0 and 1.0, indicating the progress of uploading body data to the server. If the UnityWebRequest is complete (either a success or a system error), this property will always return 1. If the UnityW...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90fa96b13fb7
unity_docs
scripting
What is `AI.NavMeshBuildSettings.agentRadius` in Unity? Explain its purpose and usage.
NavMeshBuildSettings.agentRadius public float agentRadius ; Description The radius of the agent for baking in world units. The resulting NavMesh will be shrunk by this radius to make sure that agents do not clip to walls when close to obstacles, in some scenarios it can be useful to reduce this radius.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2913195ba11f
unity_docs
math
Show me a Unity C# example demonstrating `TerrainData.GetDetailLayer`.
cale image, where each pixel value denotes the number of detail objects that will be procedurally placed Terrain area. That corresponds to the pixel. Since several different detail types may be used, the map is arranged into "layers" - the array indices of the layers are determined by the order of the detail types def...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f630aabd206
unity_docs
physics
Show me a Unity C# example demonstrating `MonoBehaviour.OnCollisionStay2D`.
parameter passed during the call. If you don't need this information then you can declare OnCollisionStay2D without the parameter. Note: Collision events will be sent to disabled MonoBehaviours, to allow enabling Behaviours in response to collisions. Collision stay events are not sent for sleeping Rigidbodies. Additio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8afa13e1efe8
github
scripting
Write a Unity C# script called Color Extensions
```csharp using System; using JetBrains.Annotations; using UnityEngine; namespace CoreLibrary { /// <summary> /// Author: Cameron Reuschel /// <br/><br/> /// The class holding all extension methods specific to colors in the core library. /// </summary> public static class ColorExtens...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e265dc0b710
unity_docs
rendering
What is `XR.XRDisplaySubsystem.supportedTextureLayouts` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.supportedTextureLayouts public XR.XRDisplaySubsystem.TextureLayout supportedTextureLayouts ; Description Specifies all texture layouts supported by this display subsystem. This var is a bit field that could be combination of XRDisplaySubsystem.TextureLayout.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1eaf00afc1e
unity_docs
rendering
What is `TextureImporterSettings.spriteMeshType` in Unity? Explain its purpose and usage.
TextureImporterSettings.spriteMeshType public SpriteMeshType spriteMeshType ; Description SpriteMeshType defines the type of Mesh that TextureImporter generates for a Sprite. When SpriteMeshType.FullRect is specified, it will generate a rectangle Mesh equal to the user specified Sprite size. When Sprite...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4adc5cd1c02a
unity_docs
editor
In Unity's 'Analyze built assets', what is 'Extract archive files' and how does it work?
To extract an archive file to binary format use the WebExtract tool: Go to the Tools folder that contains WebExtract . Run the command WebExtract <FilePathOfArchiveFile> , or ./WebExtract <FilePathOfArchiveFile> if using macOS or Linux. The tool then creates a folder that contains the binary data of the archive file.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_730587476841
unity_docs
physics
In Unity's 'Create a compound collider', what is 'Plan a compound collider' and how does it work?
Before you build your compound collider, think about what you want to use the collider for, and how you want to arrange the colliders. If you only need the collider to provide collisions, and not any collision or trigger events, you can arrange colliders in any arrangement, including overlaps, as long as you have cover...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_280feca13681
unity_docs
editor
In Unity's 'Use unsupported video files in the Editor', what is 'Use placeholder video files' and how does it work?
If you want to use placeholder versions of your video files that are compatible with your Editor but use a different version for your target platform, you can include both versions in your project and decide which version to use at runtime. The following example script demonstrates how to use different video URLs for d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_43b8ccc7bc8e
unity_docs
scripting
What is `Renderer.bounds` in Unity? Explain its purpose and usage.
Renderer.bounds public Bounds bounds ; Description The bounding box of the renderer in world space. This is the axis-aligned bounding box fully enclosing the object in world space. Using bounds is convenient to make rough approximations about the object's location and its extents. For example, the center ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.