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_bd9689e315d1
unity_docs
physics
What is `ParticleSystemForceField.gravityFocus` in Unity? Explain its purpose and usage.
ParticleSystemForceField.gravityFocus public float gravityFocus ; Description When using the gravity force, set this value between 0 and 1 to control the focal point of the gravity effect. Setting a value of 0 causes particles to be attracted to the center of the volume, whereas setting a value of 1 will resul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5b55cbaa328e
unity_docs
input
Show me a Unity code example for 'Mobile Keyboard'.
tive returns true. TouchScreenKeyboard.visible returns true. TouchScreenKeyboard.area returns real position and size of the keyboard. ## Secure Text Input It is possible to configure the keyboard to hide symbols when typing. This is useful when users are required to enter sensitive information (such as passwords). To...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_baf0215b2e3a
unity_docs
rendering
Give me an overview of the `StaticEditorFlags` class in Unity.
StaticEditorFlags enumeration Description Describes which Unity systems consider the GameObject as static, and include the GameObject in their precomputations in the Unity Editor. Setting StaticEditorFlags at runtime has no effect on these systems. For more information, see the Unity Manual documentation on Stat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d8558e9337f
unity_docs
rendering
What is `BuildAssetBundlesParameters.subtarget` in Unity? Explain its purpose and usage.
BuildAssetBundlesParameters.subtarget public int subtarget ; Description The subtarget to build. (optional) For some BuildTargets the behaviour of a build can be influenced by using this field. The supported values are based on target-specific enums, for example MobileTextureSubtarget . The subtarget can be...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c1bc5aac611
unity_docs
animation
Show me a Unity C# example demonstrating `HumanBone`.
HumanBone struct in UnityEngine / Implemented in: UnityEngine.AnimationModule Description The mapping between a bone in the model and the conceptual bone in the Mecanim human anatomy. The names of the Mecanim human bone and the bone in the model are stored along with the limiting muscle values that constrain th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3820a5fdfe3f
unity_docs
scripting
Explain 'Rect Transform' in Unity.
The Rect Transform component is the 2D layout counterpart of the Transform component. Where Transform represents a single point, Rect Transform represent a rectangle that a UI element can be placed inside. If the parent of a Rect Transform is also a Rect Transform, the child Rect Transform can also specify how it shoul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39de50093b20
unity_docs
scripting
What is `SpeedTreeImporter.animateCrossFading` in Unity? Explain its purpose and usage.
SpeedTreeImporter.animateCrossFading public bool animateCrossFading ; Description Indicates if the cross-fade LOD transition, applied to the last mesh LOD and the billboard, should be animated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_017143eac7fa
unity_docs
math
What are the parameters of `Camera.CalculateFrustumCorners` in Unity?
Description Given viewport coordinates, calculates the view space vectors pointing to the four frustum corners at the specified camera depth. The order of the corners is lower left, upper left, upper right, lower right. CalculateFrustumCorners can be used to efficiently calculate the world space position of a pixel in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03e3e45f66b4
unity_docs
editor
What is `Search.SearchProvider.fetchDescription` in Unity? Explain its purpose and usage.
SearchProvider.fetchDescription public Func<SearchItem,SearchContext,string> fetchDescription ; Description Handler to provide an asynchronous description for an item. Is called when the item is about to be displayed. Allows a plugin provider to only fetch long descriptions when they are needed. ```csharp [Sear...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9b4eab678b3
unity_docs
physics
What is `FrameTimingManager` in Unity? Explain its purpose and usage.
FrameTimingManager class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Provides frame-level CPU and GPU time measurements. The FrameTimingManager API is designed for use in Players and collects important frame statistics with a lower performance overhead compared to Unity Profiler. Use Fra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87c0c2f3a01f
unity_docs
animation
What is `Animations.AimConstraint.worldUpObject` in Unity? Explain its purpose and usage.
AimConstraint.worldUpObject public Transform worldUpObject ; Description The world up object, used to calculate the world up vector when the world up Type is AimConstraint.WorldUpType.ObjectUp or AimConstraint.WorldUpType.ObjectRotationUp .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8aa8921d2629
unity_docs
networking
What is `Networking.PlayerConnection.PlayerConnection.Unregister` in Unity? Explain its purpose and usage.
PlayerConnection.Unregister Declaration public void Unregister (Guid messageId , UnityAction<MessageEventArgs> callback ); Parameters Parameter Description messageId Message ID associated with the callback that you wish to deregister. callback The associated callback function you wish to deregister. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d195ede117d
unity_docs
rendering
What are the parameters of `LineRenderer.SetPositions` in Unity?
Description Set the positions of all vertices in the line. This method is preferred to SetPosition when setting all positions, as it is more efficient to set all positions using a single command than to set each position individually. Note that positionCount must be called before SetPositions . Also SetPositions ignor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1cf93f01e12a
unity_docs
editor
Explain 'Check the consistency of the import process' in Unity.
Asset importers, including any scripted importers that you write, should produce consistent, or deterministic results. A deterministic importer always produces the same output from the same input and set of dependencies. To verify if an importer is deterministic, the Asset Database has the following ways that you can c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a07456d0f86b
unity_docs
rendering
Explain 'Types of Reflection Probe' in Unity.
Reflection probes come in three basic types as chosen by the Type property in the inspector (see the component reference page for further details). Baked probes store a reflection cubemap generated (“baked”) within the editor. You can trigger the baking by clicking either the Bake button at the bottom of the Reflection...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d39c29e75d49
unity_docs
scripting
What is `PackageManager.Events.registeringPackages` in Unity? Explain its purpose and usage.
Events.registeringPackages Parameters Parameter Description value A PackageRegistrationEventArgs structure describing the modifications to the registered packages list. Description Event raised before applying changes to the registered packages list. Occurs before the asset database begins refreshing. Packa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a404d621e894
unity_docs
animation
What is `WrapMode.Default` in Unity? Explain its purpose and usage.
WrapMode.Default Description Reads the default repeat mode set higher up. If you haven't changed wrapMode on AnimationClip or on Animation , then WrapMode.Default resolves to WrapMode.Once . Additional resources: WrapMode for me details.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e03ff2ccc32c
unity_docs
ui
Show me a Unity code example for 'Bind a custom control'.
he new type. You can find the completed files that this example creates in this GitHub repository . ## Create a serialized object Create a serialized object that contains a Texture2D. Create a Unity project with any template. In the Project window , create a folder named bind-custom-control to store the files. Create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2d49ae74013
unity_docs
scripting
What is `Build.Profile.BuildProfile` in Unity? Explain its purpose and usage.
BuildProfile class in UnityEditor.Build.Profile / Inherits from: ScriptableObject Description Provides a set of configuration settings you can use to build your application on a particular platform. Additional resources: BuildPlayerWithProfileOptions . Properties Property Description overrideGlobalScenes O...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d90bf8e0f597
unity_docs
scripting
What is `Playables.PlayableExtensions.GetTime` in Unity? Explain its purpose and usage.
PlayableExtensions.GetTime Declaration public static double GetTime (U playable ); Parameters Parameter Description playable The Playable used by this operation. Returns double The current time in seconds. Description Returns the current local time of the Playable . The PlayableGraph updates the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_89a62e170235
unity_docs
audio
What is `Rendering.SplashScreen.isFinished` in Unity? Explain its purpose and usage.
SplashScreen.isFinished public static bool isFinished ; Description Returns true once the splash screen has finished. This is once all logos have been shown for their specified duration. ```csharp using System.Collections; using UnityEngine; using UnityEngine.Rendering;// This example shows how you could draw t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8acc5f4009ef
unity_docs
rendering
Explain 'Introduction to lighting' in Unity.
Lighting in Unity works by approximating how light behaves in the real world. Unity uses detailed models of how light works for a more realistic result, or simplified models for a more stylized result. To set up lighting, choose a render pipeline , configure global lighting, and add elements like lights, emissive surfa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_539efd8119c6
github
scripting
Write a Unity C# script called Proxy Attribute
```csharp using System; using UnityEngine; namespace InterfaceField { public class ProxyAttribute : PropertyAttribute { public Type ProxyType { get; } public ProxyAttribute(Type proxyType) { if (proxyType == null) { throw new Exception("Provided proxy type is null!"); } if (!typeof(ObjectPro...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_627cb4a6323a
unity_docs
physics
Show me a Unity C# example demonstrating `Joint.OnJointBreak`.
r than the breakForce of the joint, the joint will break off. When the joint breaks off, OnJointBreak will be called and the break force applied to the joint will be passed in. After OnJointBreak the joint will automatically be removed from the game object and deleted. Note: OnJointBreak is called by Unity, it is not a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_68c9a162b908
unity_docs
animation
In Unity's 'Animation Blend Trees', what is 'Using Blend Trees' and how does it work?
To start working with a new Blend Tree, do the following: Right-click on an empty space in the Animator Controller view. Select Create State > From New Blend Tree from the context menu. Double-click the Blend Tree to enter the Blend Tree Graph. The Animator window displays a graph of the entire Blend Tree while the Ins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58fc3a0ae731
unity_docs
math
What is `Screen.mainWindowPosition` in Unity? Explain its purpose and usage.
Screen.mainWindowPosition public static Vector2Int mainWindowPosition ; Description The position of the top left corner of the main window relative to the top left corner of the display. This API is only supported on Linux, macOS and Windows Standalone.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec1c65ccf3bc
unity_docs
scripting
What is `Search.SearchViewState.queryBuilderEnabled` in Unity? Explain its purpose and usage.
SearchViewState.queryBuilderEnabled public bool queryBuilderEnabled ; Description If true, the search view will be opened in builder mode. If false, the search view will be opened in default text mode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a800dbd6702c
unity_docs
scripting
What is `Event.alt` in Unity? Explain its purpose and usage.
Event.alt public bool alt ; Description Is Alt/Option key held down? (Read Only) On Windows, this returns true if any Alt key is held down. On Mac, this returns true if any Option key is held down. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints Option or Alt key was pressed dep...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4ff0b506cb3
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUI.IntPopup`.
values for each option. If optionValues a direct mapping of selectedValue to displayedOptions is assumed. style Optional GUIStyle . Returns int The value of the option that has been selected by the user. Description Makes an integer popup selection field. Takes the currently selected integer as a parameter ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_82cecbac7d53
unity_docs
ui
In Unity's 'SliderInt', what is 'Set page size' and how does it work?
The SliderInt control has a page-size property that controls how much the thumb moves, and how much the value changes, when you click the track to either side of the thumb. If the page size value is 0 , clicking the track moves the thumb to the cursor or pointer position, and updates the value accordingly. If the page ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7fadd72ec230
unity_docs
editor
Show me a Unity code example for 'Introduction to debugging Unity in Windows'.
n-handling mechanism handles these exceptions. For example, a NullReferenceException occurs when code attempts to access a member on a null object reference. ## Example: Debugging a null reference exception The following samples show an example of what a null reference with a built-in debugger attached can look like....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f1c569bee0a
unity_docs
performance
What is `Unity.Jobs.JobHandle` in Unity? Explain its purpose and usage.
JobHandle struct in Unity.Jobs / Implemented in: UnityEngine.CoreModule Description Represents a handle to a job, which uniquely identifies a job scheduled in the job system. Properties Property Description IsCompleted Determines if a task is running. Public Methods Method Description Complete Ensures th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56138326e6f7
unity_docs
scripting
What is `Build.Reporting.StrippingInfo.includedModules` in Unity? Explain its purpose and usage.
StrippingInfo.includedModules public IEnumerable<string> includedModules ; Description The native engine modules that were included in the build. You can pass each of these to StrippingInfo.GetReasonsForIncluding to obtain information about what caused a module to be included in the build.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_760e45d25514
unity_docs
xr
In Unity's 'Notarize with Xcode and command-line tools', what is 'Compress the application' and how does it work?
Apple requires that you compress your application before you upload it for notarization. To do this, use the following steps: Open Terminal and navigate to the directory the application is in. Run the following command where: "application_name.app" is your built application. "application_name.zip" is the name of the co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9afd4d05dfe
unity_docs
rendering
What is `GraphicsBuffer.Target.IndirectArguments` in Unity? Explain its purpose and usage.
GraphicsBuffer.Target.IndirectArguments Description GraphicsBuffer can be used as an indirect argument buffer for indirect draws and dispatches. Indirect arguments buffers are used for Graphics.RenderPrimitivesIndirect , ComputeShader.DispatchIndirect , RayTracingShader.DispatchIndirect or Graphics.RenderMeshI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f78e8e3cee3
unity_docs
scripting
What is `ISubsystemDescriptor` in Unity? Explain its purpose and usage.
ISubsystemDescriptor interface in UnityEngine Description A subsystem descriptor is metadata about a subsystem which can be inspected before loading / initializing a subsystem. Properties Property Description id A unique string that identifies the subsystem that this Descriptor can create. Public Methods M...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3712d96ad7f
unity_docs
scripting
Show me a Unity C# example demonstrating `Editor.OnSceneGUI`.
ts, OnSceneGUI is used to draw lines between GameObjects. The first script shows how OnSceneGUI is used. In this script, a GameObject is used as a parent. The script obtains the position of the parent and then draws lines from that position to GameObjects stored in an array. The script uses Handles.DrawLine to dr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0168f33a53e0
unity_docs
physics
What is `Collider2D.OnTriggerExit2D` in Unity? Explain its purpose and usage.
Collider2D.OnTriggerExit2D(Collider2D) Parameters Parameter Description other The other Collider2D involved in this collision. Description Sent when another object leaves a trigger collider attached to this object (2D physics only). Further information about the other collider is reported in the Collider2D par...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b20409fdb576
unity_docs
rendering
Give me an overview of the `EditorUtility` class in Unity.
EditorUtility class in UnityEditor Description Editor utility functions. Static Properties Property Description activePlayModeTint The tint color that is currently applied the editor UI. scriptCompilationFailed True if there are any compilation error messages in the log. Static Methods Method Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_09e0219989f4
unity_docs
scripting
What is `ParticleSystem.LimitVelocityOverLifetimeModule.multiplyDragByParticleVelocity` in Unity? Explain its purpose and usage.
ParticleSystem.LimitVelocityOverLifetimeModule.multiplyDragByParticleVelocity public bool multiplyDragByParticleVelocity ; Description Adjust the amount of drag this module applies to particles, based on their speeds. Additional resources: ParticleSystem.LimitVelocityOverLifetimeModule.drag , ParticleSystem....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9c5d426d1ea0
unity_docs
editor
Explain 'Troubleshooting the Embedded Linux Unity Editor' in Unity.
This page lists the common problems that might occur when using the Embedded Linux Unity Editor. ## The Player build fails with an error When exporting the Unity project, the following error appears: No EmbeddedLinux Burst Support on X86/Arm32 architecture . Disabling Burst in Settings and removing it from the projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76275a06cfb8
unity_docs
math
What is `TerrainTools.BrushTransform.ctor` in Unity? Explain its purpose and usage.
BrushTransform Constructor Declaration public BrushTransform ( Vector2 brushOrigin , Vector2 brushU , Vector2 brushV ); Parameters Parameter Description brushOrigin Origin of the brush, in target XY space. brushU Brush U vector, in target XY space. brushV Brush V vector, in target XY space. Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ee1bd19bbf1d
unity_docs
rendering
Explain 'Shader Graph' in Unity.
com.unity.shadergraph ## Description The Shader Graph package adds a visual Shader editing tool to Unity. You can use this tool to create Shaders in a visual way instead of writing code. Specific render pipelines can implement specific graph features. Currently, both the High Definition Rendering Pipeline and the Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2dfb41589d35
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.LightsModule.useRandomDistribution`.
ParticleSystem.LightsModule.useRandomDistribution public bool useRandomDistribution ; Description Randomly assign Lights to new particles based on ParticleSystem.LightsModule.ratio . When this property is false, the system assigns Lights at regular intervals according to the ParticleSystem.LightsModule.ratio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38a1071e82e8_doc_8
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
When enabled, the object will be rotated about the y-axis when spawned by in relation to the direction of the spawn point to the camera. Signature: ```csharp public bool applyRandomAngleAtSpawn ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_676fcd489ce8
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.RotationBySpeedModule.enabled`.
ParticleSystem.RotationBySpeedModule.enabled public bool enabled ; Description ESpecifies whether the RotationBySpeedModule is enabled or disabled. Additional resources: ParticleSystem.rotationBySpeed . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d58d2ad99ecf
unity_docs
scripting
What is `Mesh.GetVertexAttributeOffset` in Unity? Explain its purpose and usage.
Mesh.GetVertexAttributeOffset Declaration public int GetVertexAttributeOffset ( Rendering.VertexAttribute attr ); Parameters Parameter Description attr The vertex data attribute to check for. Returns int The byte offset within a atream of the data attribute, or -1 if it is not present. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e3ed46e0630
unity_docs
scripting
What is `GridPalette` in Unity? Explain its purpose and usage.
GridPalette class in UnityEditor / Inherits from: ScriptableObject Description GridPalette stores settings for Palette assets when shown in the Palette window. Properties Property Description cellSizing Determines the sizing of cells for a Palette. transparencySortAxis Determines the sorting axis if the Tra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1cf45c5222c2
unity_docs
rendering
In Unity's 'Introduction to mipmap streaming', what is 'Limitations' and how does it work?
Unity doesn’t support mipmap streaming on terrain textures, because Unity needs the highest resolution mipmap levels at all times. Unity doesn’t support mipmap streaming with texture arrays, cubemap arrays, or 3D textures. If you use an API such as Graphics.DrawMeshNow to render a texture, Unity doesn’t have the inform...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03058facd166
unity_docs
rendering
What is `Rendering.CommandBuffer.DrawProceduralIndirect` in Unity? Explain its purpose and usage.
CommandBuffer.DrawProceduralIndirect Declaration public void DrawProceduralIndirect ( Matrix4x4 matrix , Material material , int shaderPass , MeshTopology topology , ComputeBuffer bufferWithArgs , int argsOffset , MaterialPropertyBlock properties ); Declaration public void DrawProceduralIndirect ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ff5b26e68b2
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.AddCopyFilesBuildPhase`.
ing watch content. Returns string Returns the GUID of the new phase. Description Creates a new Copy Files build phase for a given target. If a Copy Files build phase with the same name, dstPath , and subfolderSpec is already configured for the target, the function returns the existing phase. The new pha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3d39c5189e6
unity_docs
editor
What is `SearchService.ObjectSelectorSearchContext` in Unity? Explain its purpose and usage.
ObjectSelectorSearchContext class in UnityEditor.SearchService Implements interfaces: ISearchContext Description A search context implementation for ObjectSelector search engines. All methods that are called on an ObjectSelector search engine, and expect a ISearchContext , receive an object of this type. Proper...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_94a0d5b8232d
unity_docs
math
What is `Quaternion.LookRotation` in Unity? Explain its purpose and usage.
Quaternion.LookRotation Declaration public static Quaternion LookRotation ( Vector3 forward , Vector3 upwards = Vector3.up); Parameters Parameter Description forward The direction to look in, in world coordinates. upwards The vector that defines in which direction up is, in world coordinates. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c333d51ecdc
unity_docs
editor
What are the parameters of `EditorBuildSettings.TryGetConfigObject` in Unity?
Returns bool Returns true if the config object reference was found and the type matched the result parameter. Returns false if the entry is not found, the config object reference is null , or if the type requested does not match the type stored. Description Retrieve a config object reference by name. ```csharp using U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d84b5058b97c
unity_docs
scripting
What is `AndroidJNI.GetMethodID` in Unity? Explain its purpose and usage.
AndroidJNI.GetMethodID Declaration public static IntPtr GetMethodID (IntPtr clazz , string name , string sig ); Description Returns the method ID for an instance (nonstatic) method of a class or interface. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_270fce20e1d7
unity_docs
scripting
What are the parameters of `Handles.DrawDottedLines` in Unity?
Description Draw a list of dotted line segments. "Draw multiple dotted lines in sceneview.". ```csharp // Draw lines to the connected game objects that a script has. // if the target object doesn't have any game objects attached // then it draws a line from the object to 0,0,0.using UnityEditor; using UnityEngine; usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4d6eeaa9e8a
unity_docs
scripting
What is `UIElements.PanelChangedEventBase_1.GetPooled` in Unity? Explain its purpose and usage.
PanelChangedEventBase<T0>.GetPooled Declaration public static T GetPooled ( UIElements.IPanel originPanel , UIElements.IPanel destinationPanel ); Parameters Parameter Description originPanel Sets the originPanel property of the event. destinationPanel Sets the destinationPanel property of the event. R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5dad0c4b076
unity_docs
editor
What is `Search.SearchUtils.GetMainWindowCenteredPosition` in Unity? Explain its purpose and usage.
SearchUtils.GetMainWindowCenteredPosition Declaration public static Rect GetMainWindowCenteredPosition ( Vector2 size ); Parameters Parameter Description size Size of the window to be centered. Returns Rect Centered position. Description Returns a UnityEngine.Rect to center a window on the main Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1dde0ea05eb
unity_docs
animation
What is `Animator.PlayInFixedTime` in Unity? Explain its purpose and usage.
Animator.PlayInFixedTime Declaration public void PlayInFixedTime (string stateName , int layer = -1, float fixedTime = float.NegativeInfinity); Declaration public void PlayInFixedTime (int stateNameHash , int layer = -1, float fixedTime = float.NegativeInfinity); Parameters Parameter Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_25b196c0b1e1
unity_docs
rendering
What is `Rendering.GraphicsTextureDescriptor` in Unity? Explain its purpose and usage.
GraphicsTextureDescriptor struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Contains all the information Unity uses to create a GraphicsTexture . Additional resources: GraphicsTexture.descriptor . Properties Property Description arrayLength The number of textures in the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c5c1000bff15
unity_docs
xr
In Unity's 'Define exceptions on your web proxy', what is 'Changelog' and how does it work?
March 18, 2025: Added endpoints for plasticscm.com : prd-azure-eastjp-01-cloud.plasticscm.com , prd-azure-seasia-01-cloud.plasticscm.com , prd-azure-westeu-01-cloud.plasticscm.com , prd-azure-eastus-01-cloud.plasticscm.com . July 10, 2024: Changed the endpoint (URL) value from upm-cdn.unity.com to cdn.packages.unity.co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f10310eef30c
unity_docs
editor
What is `Build.Content.ContentBuildProfileEvent` in Unity? Explain its purpose and usage.
ContentBuildProfileEvent struct in UnityEditor.Build.Content Description Details about a profile event captured using the ContentBuildInterface.BeginProfileCapture and ContentBuildInterface.EndProfileCapture APIs. Properties Property Description Metadata Additional metadata associated with the event. Name Nam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f07120efa50
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.CheckReadAndThrow` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.CheckReadAndThrow Declaration public static void CheckReadAndThrow ( Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle ); Parameters Parameter Description handle The AtomicSafetyHandle to check. Description Check whether the referenced native container can be read from. Throw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56b7525c4519
unity_docs
rendering
Show me a Unity C# example demonstrating `GL.Viewport`.
GL.Viewport Declaration public static void Viewport ( Rect pixelRect ); Description Set the rendering viewport. All rendering is constrained to be inside the passed pixelRect . If the Viewport is modified, all the rendered content inside of it gets stretched. ```csharp using UnityEngine;public class Example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78cd36bbc9a5
unity_docs
scripting
What is `IMGUI.Controls.TreeView.RenameEndedArgs.acceptedRename` in Unity? Explain its purpose and usage.
TreeView.RenameEndedArgs.acceptedRename public bool acceptedRename ; Description Is true if the rename is accepted. The rename is set as accepted when the user ends rename with Return/Enter or the rename loses focus. The rename is rejected if the user presses Esc while editing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bda0c9ac5156
unity_docs
scripting
Explain 'Deep linking on iOS' in Unity.
Deep links are hyperlinks outside of your application that take a user to a specific location within the application rather than a website. When a user clicks a deep link, the application opens from the designated location, such as a specific scene in a Unity application. For more information about deep links and how t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9b73b03bf4b
unity_docs
scripting
What is `PlayerSettings.bundleVersion` in Unity? Explain its purpose and usage.
PlayerSettings.bundleVersion public static string bundleVersion ; Description The application’s global version number string. This is the master version string for your project, corresponding to the Version field in the Player Settings UI. It is shared across all platforms and is the value returned by Appli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aa70fbad520b
unity_docs
scripting
What is `Callbacks.DidReloadScripts.ctor` in Unity? Explain its purpose and usage.
DidReloadScripts Constructor Declaration public DidReloadScripts (); Declaration public DidReloadScripts (int callbackOrder ); Parameters Parameter Description callbackOrder Order in which separate attributes will be processed. Description DidReloadScripts attribute. The callbackOrder parameter dete...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78b162ed04e8
unity_docs
math
What is `Matrix4x4.operator_multiply` in Unity? Explain its purpose and usage.
Matrix4x4.operator * public static Matrix4x4 operator * ( Matrix4x4 lhs , Matrix4x4 rhs ); Description Multiplies two matrices. The returned result is lhs * rhs . public static Vector4 operator * ( Matrix4x4 lhs , Vector4 vector ); Description Transforms a Vector4 by a matrix.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8eebf49f6bee
unity_docs
editor
Show me a Unity C# example demonstrating `FileUtil.ReplaceFile`.
FileUtil.ReplaceFile Declaration public static void ReplaceFile (string src , string dst ); Description Replaces a file. Replaces the file located at dst with the file located at src . if dst doesnt exists it just copies the file. If dst exists then it deletes it and copies the file at src to dst A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7f95249959e
unity_docs
animation
What is `Animations.AnimatorControllerPlayable.ResetTrigger` in Unity? Explain its purpose and usage.
AnimatorControllerPlayable.ResetTrigger Declaration public void ResetTrigger (string name ); Declaration public void ResetTrigger (int id ); Parameters Parameter Description name The parameter name. id The parameter ID. Description Resets the value of the given trigger parameter. Use this to reset ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00c62e552a95
unity_docs
scripting
What is `Search.IPropertyDatabaseRecord.value` in Unity? Explain its purpose and usage.
IPropertyDatabaseRecord.value public Search.IPropertyDatabaseRecordValue value ; Description The value of the record. If the data is serializable (see PropertyDatabase.IsPersistedType ), the record value contains the serialized data and the record can be stored on disk, otherwise it contains the C# object an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3def5f258271
github
scripting
Write a Unity C# script called Card
```csharp using System; using System.Collections.Generic; using shadcnui.GUIComponents.Core.Base; using shadcnui.GUIComponents.Core.Styling; using shadcnui.GUIComponents.Core.Utils; using UnityEngine; #if IL2CPP_MELONLOADER_PRE57 using UnhollowerBaseLib; #endif namespace shadcnui.GUIComponents.Layout { public clas...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_2e7577f806cc
unity_docs
scripting
Explain 'Position Constraint component' in Unity.
A Position Constraint component moves a GameObject to follow its source GameObjects. ## Properties Property Description Activate After you position the constrained GameObject and its source GameObjects, click Activate to save this information. Activate saves the current offset from the source GameObjects in Position ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f8f112eb36f
unity_docs
animation
What is `Animations.AnimatorStateMachine.AddState` in Unity? Explain its purpose and usage.
AnimatorStateMachine.AddState Declaration public Animations.AnimatorState AddState (string name ); Declaration public Animations.AnimatorState AddState (string name , Vector3 position ); Parameters Parameter Description name The name of the new state. position The position of the state node. R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abb99126ea1a
unity_docs
editor
What are the parameters of `AssetDatabase.MoveAssetToTrash` in Unity?
Returns bool Returns true if the asset has been successfully removed, false if it doesn't exist or couldn't be removed. Description Moves the specified asset or folder to the OS trash. Paths should be relative to the project folder, for example: "Assets/MyTextures/hello.png" Additional resources: AssetDatabase.DeleteA...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_297319bd9215
unity_docs
rendering
What is `Rendering.GraphicsSettings.lightsUseColorTemperature` in Unity? Explain its purpose and usage.
GraphicsSettings.lightsUseColorTemperature public static bool lightsUseColorTemperature ; Description Whether to use a Light's color temperature when calculating the final color of that Light." Enable to use the correlated color temperature (abbreviated as CCT) for adjusting light color. CCT is a natural way t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_13f97351d172
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.customData`.
ertexStreams from script. Once enabled, the custom data will be passed to your vertex shader through a TEXCOORD channel. The ParticleSystemRenderer Inspector will tell you which channels are being used. Particle System modules do not need to be reassigned back to the system; they are interfaces and not independent o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4757ff8b3fa7
unity_docs
physics
What is `PolygonCollider2D.pathCount` in Unity? Explain its purpose and usage.
PolygonCollider2D.pathCount public int pathCount ; Description The number of paths in the polygon. A path is cyclic sequence of line segments between points that define the outline of the polygon. Because the polygon can have holes and discontinuous parts, its shape is not necessarily defined by a single path...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0f2ea2ab7ff
unity_docs
math
What is `Unity.Collections.NativeSlice_1.CopyFrom` in Unity? Explain its purpose and usage.
NativeSlice<T0>.CopyFrom Declaration public void CopyFrom (NativeSlice<T> slice ); Declaration public void CopyFrom (T[] array ); Parameters Parameter Description slice The NativeSlice<T0> to copy the elements from. array The array to copy elements from. Description Copies all the elements from a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9b393f95a28
unity_docs
scripting
Show me a Unity C# example demonstrating `LensFlare.color`.
LensFlare.color public Color color ; Description The color of the flare. This controls the color of some flare elements (the ones that have use light color enabled). Additional resources: Lens flare component , flare assets . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Increme...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e03e0d11d55a
unity_docs
rendering
Give me an overview of the `WebCamDevice` class in Unity.
WebCamDevice struct in UnityEngine / Implemented in: UnityEngine.AudioModule Description A structure describing the webcam device. Properties Property Description availableResolutions Possible WebCamTexture resolutions for this device. depthCameraName A string identifier used to create a depth data based We...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78265c857a3d
unity_docs
scripting
What is `TrueTypeFontImporter.shouldRoundAdvanceValue` in Unity? Explain its purpose and usage.
TrueTypeFontImporter.shouldRoundAdvanceValue public bool shouldRoundAdvanceValue ; Description Set this property to true if you want to round the internal advance width of the font to the nearest integer. When positioning characters, the cumulated error induced by a rounded advance width may cause the spacing b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2706b8fb15e4
unity_docs
physics
What is `PhysicsShapeGroup2D.SetShapeAdjacentVertices` in Unity? Explain its purpose and usage.
PhysicsShapeGroup2D.SetShapeAdjacentVertices Declaration public void SetShapeAdjacentVertices (int shapeIndex , bool useAdjacentStart , bool useAdjacentEnd , Vector2 adjacentStart , Vector2 adjacentEnd ); Parameters Parameter Description shapeIndex The index of the shape to be modified that is stored...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_671bd4ff986d
unity_docs
input
Explain 'IME in Unity' in Unity.
## What is Input Method Editor (IME)? An input method is an operating system component or program that allows users to enter characters and symbols not found on their input device. For instance, on the computer, this allows the user of ‘Western’ keyboards to input Chinese, Japanese, Korean, and Indic characters. On ha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f4e2e604ff85
unity_docs
rendering
Explain 'Size by Speed module reference' in Unity.
This module allows you to create particles that change size according to their speed in distance units per second. ## 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 ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fad3b97c2dba
unity_docs
scripting
What is `Rendering.VertexAttributeFormat.SNorm8` in Unity? Explain its purpose and usage.
VertexAttributeFormat.SNorm8 Description 8-bit signed normalized number. This format stores uniformly quantized numbers in [-1..1] range, with 8 bits of precision (256 possible different values). Additional resources: Mesh class, VertexAttribute enum, Mesh.GetVertexAttributeFormat .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6204fd83dc2f
unity_docs
editor
What are the parameters of `PrefabUtility.RecordPrefabInstancePropertyModifications` in Unity?
Description Causes modifications made to the Prefab instance to be recorded. The recommended way to enable instances of prefabs to record changes is to use SerializedProperty and SerializedObject , instead of using this method. Using SerializedProperty and SerializedObject enables instances to record changes and automa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e7b5103cda9
unity_docs
rendering
What is `LightTransport.IProbeIntegrator.Result` in Unity? Explain its purpose and usage.
Result struct in UnityEngine.LightTransport Description The type returned by the probe integrator. The type contains detailed error information. Properties Property Description message The string containing the error message. type The enum containing the result type. Constructors Constructor Description I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e885d24c702b
unity_docs
editor
Show me a Unity C# example demonstrating `Profiling.RawFrameDataView.GetSampleChildrenCountRecursive`.
mpleChildrenCountRecursive Declaration public int GetSampleChildrenCountRecursive (int sampleIndex ); Parameters Parameter Description sampleIndex Index of the Profiler sample. Returns int Returns amount of direct and indirect child samples. Description Gets amount of direct and indirect child sample...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9d51af06641d
unity_docs
xr
Explain 'Mesh data for deformable meshes' in Unity.
Deformable meshes hold data specific to the deformation of the mesh . Deformable meshes contain either: Blend shapes : Data that describes different deformed versions of the mesh, for use with animation. Bind poses : Data that describes the “base” pose of the skeleton in a skinned mesh. ## Blend shapes Blend shapes d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e2a2509c5ec
unity_docs
editor
What are the parameters of `AssetDatabase.GetAssetPathFromTextMetaFilePath` in Unity?
Description Gets the path to the asset file associated with a text .meta file. ```csharp using System.IO; using UnityEditor; using UnityEngine; public class AssetDatabaseExamples : MonoBehaviour { [MenuItem("AssetDatabase/Get All Assets With Meta File")] static void GetAllAssetsWithMetaFiles() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11cb6924bac3
unity_docs
editor
What is `Device.SystemInfo.maxComputeWorkGroupSize` in Unity? Explain its purpose and usage.
SystemInfo.maxComputeWorkGroupSize public static int maxComputeWorkGroupSize ; Description This has the same functionality as SystemInfo.maxComputeWorkGroupSize and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2fc263481e5b
unity_docs
editor
What is `Build.Content.ObjectIdentifier.filePath` in Unity? Explain its purpose and usage.
ObjectIdentifier.filePath public string filePath ; Description The file path on disk that contains this object. (Only used for objects not known by the AssetDatabase). Internal use only. See ObjectIdentifier .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51e9ebf62a41
unity_docs
physics
What is `Joint2D.attachedRigidbody` in Unity? Explain its purpose and usage.
Joint2D.attachedRigidbody public Rigidbody2D attachedRigidbody ; Description The Rigidbody2D attached to the Joint2D . Joint2D are automatically attached to a Rigidbody2D on the same GameObject as the Joint2D . Additional resources: Rigidbody2D . ```csharp using UnityEngine; using System.Collection...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aa193d8cf1c1
unity_docs
scripting
What is `Search.StringView.operator_stringView` in Unity? Explain its purpose and usage.
StringView.bool Parameters Parameter Description sv A StringView . Description Implicit boolean conversion operator. This implicit boolean operator will return true if the StringView is not null and not empty.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_884d9322f1e9
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeader.GetColumn` in Unity? Explain its purpose and usage.
MultiColumnHeader.GetColumn Declaration public IMGUI.Controls.MultiColumnHeaderState.Column GetColumn (int columnIndex ); Parameters Parameter Description columnIndex Column index. Returns Column Column data. Description Returns the column data for a given column index. Additional resources: Multi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_281a8c324ac8
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.MainModule.prewarm`.
ParticleSystem.MainModule.prewarm public bool prewarm ; Description If ParticleSystem.MainModule.loop is true, when you enable this property, the Particle System looks like it has already simulated for one loop when first becoming visible. ```csharp using UnityEngine; using System.Collections;[RequireCompone...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c147588c0cad
unity_docs
rendering
Explain 'GPU render state commands in ShaderLab reference' in Unity.
Find the commands in ShaderLab you need to change the render state on the GPU, such as Blend , Cull and ZWrite . Page Description AlphaToMask command reference Reference for the AlphaMask command in ShaderLab. Blend command reference Reference for the Blend command in ShaderLab. BlendOp command reference Reference for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46b9b6dd7524
unity_docs
scripting
What is `UIElements.IStyle.display` in Unity? Explain its purpose and usage.
IStyle.display public StyleEnum<DisplayStyle> display ; Description Defines how an element is displayed in the layout. Unlike the visibility property, this property affects the layout of the element. This is a convenient way to hide an element without removing it from the hierarchy (when using the Display...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.