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_c8b5199bb60d
unity_docs
math
What is `Vector3Int.operator_add` in Unity? Explain its purpose and usage.
Vector3Int.operator + public static Vector3Int operator + ( Vector3Int a , Vector3Int b ); Parameters Parameter Description a The first vector to add. b The second vector to add. Returns Vector3Int The resulting vector formed from component-wise addition of a and b . Description Adds two v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fcc4f1e674f4
unity_docs
rendering
In Unity's 'Content output of a build', what is 'Binary data' and how does it work?
Each serialized file in the build can be accompanied by a .resS file which contains texture or mesh data. For example level0 might be accompanied by level0.resS and sharedassets0 might be accompanied by sharedassets0.assets.resS .` Similarly any serialized file that contains AudioClip or VideoClip objects will have an ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_00a91ed66f92
unity_docs
scripting
Explain 'Get started with meshes' in Unity.
Understand meshes in Unity and the data they contain. Page Description Introduction to meshes Introductory information about meshes, and key terminology. Mesh data Information about the data that a mesh contains, and how Unity stores that data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ba003db4020
unity_docs
editor
What is `AssetSettingsProvider.CreateProviderFromResourcePath` in Unity? Explain its purpose and usage.
AssetSettingsProvider.CreateProviderFromResourcePath Declaration public static AssetSettingsProvider CreateProviderFromResourcePath (string settingsWindowPath , string resourcePath , IEnumerable<string> keywords ); Parameters Parameter Description settingsWindowPath Path of the settings in the Settings w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e4b226916e8
unity_docs
scripting
What is `Unity.Android.Gradle.Android` in Unity? Explain its purpose and usage.
Android class in Unity.Android.Gradle / Inherits from: Unity.Android.Gradle.BaseBlock Description The C# definition of the android element in a gradle file. The main block that contains all Android-specific build options. For more information about the element, see Android's documentation: Android Gradle plu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd4463ea31e9
unity_docs
scripting
What is `UnityEngine.ImageConversionModule` in Unity? Explain its purpose and usage.
UnityEngine.ImageConversionModule Description The ImageConversion module implements the ImageConversion class which provides helper methods for converting image data. Classes Class Description ImageConversion This class provides utility and extension methods to convert image data to and from PNG, JPEG and EXR fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d69598723f8
unity_docs
scripting
What is `Undo.SetCurrentGroupName` in Unity? Explain its purpose and usage.
Undo.SetCurrentGroupName Declaration public static void SetCurrentGroupName (string name ); Parameters Parameter Description name New name of the current undo group. Description Set the name of the current undo group. Setting a name manually will override an implicitly generated name for the group. Additi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4fac62939a6
unity_docs
editor
What is `EditorUtility.GetDialogOptOutDecision` in Unity? Explain its purpose and usage.
EditorUtility.GetDialogOptOutDecision Declaration public static bool GetDialogOptOutDecision ( DialogOptOutDecisionType dialogOptOutDecisionType , string dialogOptOutDecisionStorageKey ); Parameters Parameter Description dialogOptOutDecisionType The type of opt-out decision a user can make. dialogOptOutDe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f49adee2bff
unity_docs
editor
What is `EditorCurveBinding.FloatCurve` in Unity? Explain its purpose and usage.
EditorCurveBinding.FloatCurve Declaration public static EditorCurveBinding FloatCurve (string inPath , Type inType , string inPropertyName ); Parameters Parameter Description inPath The transform path to the object to animate. inType The type of the object to animate. inPropertyName The name of the p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d6a4609fbd5
unity_docs
scripting
What is `UIElements.BaseTreeView.ussClassName` in Unity? Explain its purpose and usage.
BaseTreeView.ussClassName public static string ussClassName ; Description The USS class name for TreeView elements. Unity adds this USS class to every instance of the TreeView element. Any styling applied to this class affects every TreeView located beside, or below the stylesheet in the visual tree.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0ef7a72d4a0
unity_docs
editor
What is `Unity.Profiling.Editor.ProfilerModule` in Unity? Explain its purpose and usage.
ProfilerModule class in Unity.Profiling.Editor Description Represents a Profiler module in the Profiler window. Use ProfilerModule to extend the Profiler window with custom Profiler modules. You can use ProfilerModule with the Profiling Core package , to expose and visualize performance metrics for your own sy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3905725f1db
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.Profiling.Editor.ProfilerModuleViewController`.
ride the ProfilerModuleViewController.Dispose method. You do not need to explicitly remove the view controller’s view from the hierarchy as part of the Dispose process; Unity does this automatically when it disposes the view controller. To use the ProfilerModuleViewController derived type, instantiate a new instanc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6e33aaf754c
unity_docs
rendering
What is `Material.GetTextureScale` in Unity? Explain its purpose and usage.
Material.GetTextureScale Declaration public Vector2 GetTextureScale (string name ); Declaration public Vector2 GetTextureScale (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the property. Description Gets t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_48e0f099924d
unity_docs
animation
What is `AvatarBuilder` in Unity? Explain its purpose and usage.
AvatarBuilder class in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Class to build avatars from user scripts. This class allows you to create custom avatars for your animated characters entirely via script, in a similar way to what goes on behind the Scenes in the Unity Editor when you ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7374d323abcf
unity_docs
math
What are the parameters of `Quaternion.FromToRotation` in Unity?
Returns Quaternion A unit quaternion which rotates from fromDirection to toDirection . Description Creates a rotation from fromDirection to toDirection . Use this method to rotate a transform so that one of its axes, such as the y-axis, follows the target direction, toDirection , in world space. ```csharp using UnityEn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c6ee5462275
unity_docs
xr
What is `WWWForm.ctor` in Unity? Explain its purpose and usage.
WWWForm Constructor Declaration public WWWForm (); Description Creates an empty WWWForm object. Use the AddField and AddBinaryData methods to insert data into the form. Additional resources: UnityWebRequest and WWW classes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eaaac0fa6032
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUIUtility.systemCopyBuffer`.
emCopyBuffer public static string systemCopyBuffer ; Description The system copy buffer. Use this to make Copy and Paste work for your own application. The systemCopyBuffer captures any text that is selected on the machine. This does not specifically have to be text that is selected in Unity. Reading and wr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60f97f8b2199
unity_docs
audio
Give me an overview of the `AudioRolloffMode` class in Unity.
AudioRolloffMode enumeration Description Rolloff modes that a 3D sound can have in an audio source. Properties Property Description Logarithmic Use this mode when you want a real-world rolloff. Linear Use this mode when you want to lower the volume of your sound over the distance. Custom Use this when you wan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5837dcdc8324
unity_docs
physics
Explain 'Types of 2D primitive GameObjects' in Unity.
Unity has import support for different image formats, such as .png or Adobe’s .psd, which gives you additional options when creating and preparing your 2D assets for your project. But if you want to create a quick prototype, Unity provides 2D primitive GameObjects to help you build your project, without needing to prep...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9548acaf315
unity_docs
rendering
What is `Shader.EnableKeyword` in Unity? Explain its purpose and usage.
Shader.EnableKeyword Declaration public static void EnableKeyword (ref Rendering.GlobalKeyword keyword ); Declaration public static void EnableKeyword (string keyword ); Parameters Parameter Description keyword The GlobalKeyword to enable. keyword The name of the GlobalKeyword to enable. Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6395e1c1d771
unity_docs
audio
Show me a Unity C# example demonstrating `AudioSettings.driverCapabilities`.
AudioSettings.driverCapabilities public static AudioSpeakerMode driverCapabilities ; Description Returns the speaker mode capability of the current audio driver. (Read Only) ```csharp using UnityEngine;public class Example : MonoBehaviour { // Set the speaker mode to that of the system settings. void Start(...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9cfcbcc35147
unity_docs
performance
What is `Search.QueryGraph.Optimize` in Unity? Explain its purpose and usage.
QueryGraph.Optimize Declaration public void Optimize (bool propagateNotToLeaves , bool swapNotToRightHandSide ); Parameters Parameter Description propagateNotToLeaves Propagate "Not" operations to leaves, so only leaves can have "Not" operations as parents. swapNotToRightHandSide Swaps "Not" operations to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3ddec8674e3
unity_docs
scripting
What is `AssetPostprocessor.OnPostprocessMeshHierarchy` in Unity? Explain its purpose and usage.
AssetPostprocessor.OnPostprocessMeshHierarchy(GameObject) Parameters Parameter Description root The root GameObject of the imported Asset. Description This function is called when a new transform hierarchy has finished importing. The ModelImporter calls this function for every root transform hierarchy in the s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0e02ae2538e
unity_docs
math
What is `AndroidJNI.SetObjectArrayElement` in Unity? Explain its purpose and usage.
AndroidJNI.SetObjectArrayElement Declaration public static void SetObjectArrayElement (IntPtr array , int index , IntPtr obj ); Description Sets an element of an Object array. 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_bd0dfb366562
unity_docs
editor
What is `EditorGUILayout.EndBuildTargetSelectionGrouping` in Unity? Explain its purpose and usage.
EditorGUILayout.EndBuildTargetSelectionGrouping Declaration public static void EndBuildTargetSelectionGrouping (); Description Close a group started with BeginBuildTargetSelectionGrouping. See Also: EditorGUILayout.BeginBuildTargetSelectionGrouping . Build Target Selection Group ```csharp using UnityEditor;p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ffca80cb2fb8
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.Package.AttributesContainer` in Unity? Explain its purpose and usage.
AttributesContainer class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseAttributesContainer Description The attributes container for the <package> element. Properties Property Description Name The C# definition of the android:name Android Manifest attribute. Inherit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0619404b8aac
unity_docs
physics
What is `RaycastHit2D.centroid` in Unity? Explain its purpose and usage.
RaycastHit2D.centroid public Vector2 centroid ; Description The world space centroid (center) of the physics query shape when it intersects. When the RaycastHit2D result is returned from a linecast or raycast query, the centroid is identical to the returned point property because a line or ray uses a ve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c2f7aec2c52
unity_docs
xr
What is `MPE.EventService.RegisterEventHandler` in Unity? Explain its purpose and usage.
EventService.RegisterEventHandler Declaration public static Unity.Android.Gradle.Manifest.Action RegisterEventHandler (string eventType , Action<string,object[]> handler ); Declaration public static Unity.Android.Gradle.Manifest.Action RegisterEventHandler (string eventType , Func<string,object[],object> ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f206f08bdf8
unity_docs
scripting
What is `Experimental.GraphView.ClickSelector.UnregisterCallbacksFromTarget` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ClickSelector.UnregisterCallbacksFromTarget Declaration protected void UnregisterCallbacksFromTarget (); Description Called to unregister event callbacks from the target element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0a212619fc54_doc_11
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Destroys all objects in the non-MonoBehaviour-based pool.The type of non-MonoBehaviour objects to destroy. Signature: ```csharp public static void DestroyAllPure<T>() where T : class, IPoolable => _poolService.DestroyAllPure<T>(); ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_05656f13eac6
unity_docs
rendering
In Unity's 'Version control integrations', what is 'Using version control in Unity' and how does it work?
When you set the Editor up to work with your version control system, you can perform version control operations via the Editor, instead of in the version control client. To do this, right-click on the Asset in the Project view. The version control operations vary depending on which version control you use. The followin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4dc2aa67a408
unity_docs
xr
Give me an overview of the `StereoRenderingPath` class in Unity.
StereoRenderingPath enumeration Description Enum used to specify what stereo rendering path to use. Additional resources: PlayerSettings.stereoRenderingPath . Properties Property Description MultiPass Multiple pass VR rendering. SinglePass Single pass VR rendering ( via double-wide render texture ). Instanc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_043ce1f15624
unity_docs
rendering
What is `DepthTextureMode.MotionVectors` in Unity? Explain its purpose and usage.
DepthTextureMode.MotionVectors Description Specifies whether motion vectors should be rendered (if possible). When set, the camera renders another pass (after opaque but before Image Effects): First, a full screen pass is rendered to reconstruct screen-space motion from the camera movement, then, any moving objects...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0aed5ccd2733
unity_docs
scripting
What is `Experimental.GraphView.GraphViewChange.elementsToRemove` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphViewChange.elementsToRemove public List<GraphElement> elementsToRemove ; Description Elements about to be removed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bdec6c58fea4
unity_docs
scripting
What is `AssetBundle.LoadAllAssets` in Unity? Explain its purpose and usage.
AssetBundle.LoadAllAssets Declaration public Object[] LoadAllAssets (Type type ); Declaration public Object[] LoadAllAssets (); Declaration public T[] LoadAllAssets (); Parameters Parameter Description type When specified only main or visible objects that derive from the provided type are returned. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a2358dfe7f7
unity_docs
scripting
Show me a Unity C# example demonstrating `Pool.GenericPool_1`.
GenericPool<T0> class in UnityEngine.Pool / Implemented in: UnityEngine.CoreModule Description Provides a static implementation of ObjectPool<T0> . The GenericPool has collection checks enabled that ensure that when an instance is released it is not already in the pool. Note this is not thread-safe. Additional...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f728d3e1fb36
unity_docs
editor
What are the parameters of `Profiling.FrameDataView.GetAllCategories` in Unity?
Description Gets all the available Profiler Categories for the current profiling session. Use to retrieve all the Profiler category information for the current Profiling session. ```csharp using System; using System.Collections.Generic; using UnityEditor.Profiling; using Unity.Profiling;public class Example { publi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6c4ae7d77df3
unity_docs
rendering
Explain 'Best practice guides' in Unity.
Discover and learn production-tested best practices from Unity experts in the following areas: Art and design DevOps Graphics & rendering Performance optimization Scripting ## Create virtual and mixed reality experiences in Unity Read this e-book to get practical tips for working with the VR template in Unity, the XR...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5e61eb07e30
unity_docs
rendering
Show me a Unity C# example demonstrating `TextAsset.bytes`.
ic byte[] bytes ; Description The raw bytes of the text asset. (Read Only) This returns an array containing all the data in a file, including invisible characters such as byte-order marks for Unicode text files. This property returns a new C# array with a copy of the asset data every time it's called. To get acce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a46790368911
unity_docs
rendering
What is `Rendering.CommandBuffer.SetViewProjectionMatrices` in Unity? Explain its purpose and usage.
CommandBuffer.SetViewProjectionMatrices Declaration public void SetViewProjectionMatrices ( Matrix4x4 view , Matrix4x4 proj ); Parameters Parameter Description view View (world to camera space) matrix. proj Projection (camera to clip space) matrix. Description Add a command to set the view and projec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a04050803bc
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.LightsModule.sizeAffectsRange`.
ParticleSystem.LightsModule.sizeAffectsRange public bool sizeAffectsRange ; Description Toggle whether the system multiplies the particle size by the light range to determine the final light range. This is useful for shrinking light influence at the same time as particles disappear, to avoid popping. ```cshar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5d8901ad214
unity_docs
rendering
What is `Unity.Android.Gradle.Manifest.Manifest` in Unity? Explain its purpose and usage.
Manifest class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseElement Description The C# definition of the <manifest> Android Manifest element. For more information about the element, see Android's documentation: Manifest element Properties Property Description Appl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9e4cf579e59
unity_docs
math
What is `Rendering.CommandBuffer.SetGlobalMatrixArray` in Unity? Explain its purpose and usage.
CommandBuffer.SetGlobalMatrixArray Declaration public void SetGlobalMatrixArray (string propertyName , Matrix4x4[] values ); Declaration public void SetGlobalMatrixArray (int nameID , Matrix4x4[] values ); Declaration public void SetGlobalMatrixArray (string propertyName , List<Matrix4x4> values ); ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cafe5bb25ff
unity_docs
scripting
What is `SystemLanguage.Bulgarian` in Unity? Explain its purpose and usage.
SystemLanguage.Bulgarian Description Bulgarian. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { //This checks if your computer's operating system is in the Bulgarian language if (Application.systemLanguage == SystemLanguage.Bulgarian) { //Outputs into console that the system ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0d9ebdcb52e0
unity_docs
math
What is `Unity.Android.Gradle.Dependencies.AddDependencyImplementationFiles` in Unity? Explain its purpose and usage.
Dependencies.AddDependencyImplementationFiles Declaration public Unity.Android.Gradle.Element AddDependencyImplementationFiles (string[] files ); Parameters Parameter Description files Array of implementation files. Returns Element The added dependency. Description Adds a plugin implementation elem...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_63ed8ce5d5aa
unity_docs
physics
Explain 'Optimize physics performance' in Unity.
Optimize physics system performance in the Unity Editor. Use the guidance in these pages to optimize the physics system so you can maintain your target frame rate and ensure smooth, responsive gameplay. The instructions in these pages address issues identified by Unity Editor diagnostic tools. Before you apply the opti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdaac01efc46
unity_docs
scripting
What are the parameters of `Rendering.RenderPipelineManager.activeRenderPipelineAssetChanged` in Unity?
Description Delegate that you can use to invoke custom code when the current RenderPipelineAsset between frames has changed. ```csharp using UnityEngine; using UnityEngine.Rendering;public class CurrentRenderPipelineAssetChangedExample : MonoBehaviour { void Start() { RenderPipelineManager.activeRenderP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_125b57d576b0
unity_docs
ui
What is `GUI.enabled` in Unity? Explain its purpose and usage.
GUI.enabled public static bool enabled ; Description Is the GUI enabled? Set this value to false to disable all GUI interaction. All controls will be draw semi-transparently, and will not respond to user input. Enabled / Disabled GUI controls. ```csharp using UnityEngine; using System.Collections;public class...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_748e647581ca
unity_docs
animation
What is `Animations.CurveFilterOptions.positionError` in Unity? Explain its purpose and usage.
CurveFilterOptions.positionError public float positionError ; Description The amount the position animation curve is allowed to deviate from its original curve. This amount is expressed as a percentage: a positive value between 0 and 100.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcb63aba058d
unity_docs
editor
Give me an overview of the `TakeInfo` class in Unity.
TakeInfo struct in UnityEditor Description A Takeinfo object contains all the information needed to describe a take. Additional resources: ModelImporter.importedTakeInfos . Properties Property Description bakeStartTime Start time in second. bakeStopTime Stop time in second. defaultClipName This is the defa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ac2342c51c7
unity_docs
rendering
What is `ParticleSystem.NoiseModule.sizeAmount` in Unity? Explain its purpose and usage.
ParticleSystem.NoiseModule.sizeAmount public ParticleSystem.MinMaxCurve sizeAmount ; Description How much the noise affects the particle sizes, applied as a multiplier on the size of each particle. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class E...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bcdf337200e
unity_docs
scripting
What is `Rendering.ScopedSubPass` in Unity? Explain its purpose and usage.
ScopedSubPass struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Represents an active sub pass until disposed. Additional resources: ScriptableRenderContext.BeginScopedSubPass . Public Methods Method Description Dispose Ends the current sub pass in the ScriptableRenderCont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49d7f0830422
unity_docs
networking
What is `Android.AndroidConfiguration.ctor` in Unity? Explain its purpose and usage.
AndroidConfiguration Constructor Declaration public AndroidConfiguration (); Description Mirrors the Android method Configuration() . For information about this method, refer to the Android developer documentation on Configuration() .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e69f8be30344
unity_docs
scripting
Give me an overview of the `DragAndDrop` class in Unity.
DragAndDrop class in UnityEditor Description Editor drag & drop operations. Static Properties Property Description activeControlID Get or set ID of currently active drag and drop control. objectReferences References to objects being dragged. paths The file names being dragged. visualMode The visual indicati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb4208a10ca6
unity_docs
rendering
Show me a Unity C# example demonstrating `Camera.RenderToCubemap`.
default value 63 has six lowest bits on). This function will return false if rendering to cubemap fails. Some graphics hardware does not support the functionality. Note also that ReflectionProbes are a more advanced way of performing real-time reflections. Cubemaps can be created in the editor by selecting the Create...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bdef35fa29aa
unity_docs
math
What is `Mesh.bindposes` in Unity? Explain its purpose and usage.
Mesh.bindposes public Matrix4x4[] bindposes ; Description The bind poses. The bind pose at each index refers to the bone with the same index. Each matrix in bindposes is the inverse of the transformation matrix of the bone, calculated when the bone is in its base state (its bind pose). Note: See the Mesh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5a96d505beaf
unity_docs
rendering
Explain 'Using the Built-In Render Pipeline' in Unity.
Unity’s Built-in Render Pipeline is Unity’s older render pipeline. It’s not based on the Scriptable Render Pipeline, but you can configure it by choosing between different rendering paths , and extend its functionality with command buffers and callbacks . Page Description Hardware requirements Learn about general hardw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e05254d8d51f
unity_docs
xr
In Unity's 'XR Origin', what is 'XR Origin configurations' and how does it work?
The Unity XR packages provide several XR Origin configurations tailored for different types of XR applications. You can use the GameObject > XR menu to add an XR Origin to the current Scene. The available options depend on which packages you have added to your project. Important: You should never have more than one act...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea5579996130
unity_docs
ui
What is `GUIStyle.onActive` in Unity? Explain its purpose and usage.
GUIStyle.onActive public GUIStyleState onActive ; Description Rendering settings for when the element is turned on and pressed down. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Sets the text color of button to yellow when an // element is turned on and pressed down. void OnGUI() ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8e0b7e53126
unity_docs
math
What is `EditorUtility.DisplayDialog` in Unity? Explain its purpose and usage.
EditorUtility.DisplayDialog Declaration public static bool DisplayDialog (string title , string message , string ok , string cancel = ""); Parameters Parameter Description title The title of the message box. message The text of the message. ok Label displayed on the OK dialog button. cancel Label d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1dabec308320
unity_docs
rendering
Explain 'Version control integrations' in Unity.
Unity has integrations with two version control systems: Perforce and Plastic SCM . To use the version control integrations in Unity, you need to have either a Perforce or Plastic SCM server set up for your Unity Project. ## Setting up version control in Unity Open a Unity Project, go to Edit > Project Settings , and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_814ee0c4414b
unity_docs
scripting
What is `CreateAssetMenuAttribute` in Unity? Explain its purpose and usage.
CreateAssetMenuAttribute class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Mark a ScriptableObject-derived type to be automatically listed in the Assets/Create submenu, so that instances of the type can be easily created and stored in the project as ".asset" files. Properties Property ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d0ce616fe139
unity_docs
physics
In Unity's 'Analyzing Profiler traces', what is 'Dissecting startup traces' and how does it work?
When looking at a trace of start-up times, there are two key methods to inspect: UnityInitApplicationGraphics and UnityLoadApplication . These two methods are the primary places where the configuration, assets, and code of a project can impact start-up time. Note: The start-up time of your application differs from plat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f9ab870966a8
unity_docs
editor
Explain 'Customize the asset package cache location' in Unity.
The Package Manager maintains a cache for asset packages that you get from the Asset Store . Note: This cache is separate from the global cache , which the Package Manager uses for UPM packages . The Package Manager stores the asset package cache in a default location, which you can override. You might want to override...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c881ebadfd23
unity_docs
scripting
What is `Experimental.GraphView.GraphElement.IsAscendable` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphElement.IsAscendable Declaration public bool IsAscendable (); Returns bool Returns true if the GraphElement is automatically brought to front when selected. Returns false otherwise. Description Checks if the GraphE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b57ad7c83fb
unity_docs
ui
What is `GUIStyle.onHover` in Unity? Explain its purpose and usage.
GUIStyle.onHover public GUIStyleState onHover ; Description Rendering settings for when the control is turned on and the mouse is hovering it. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { GUI.skin.button.onHover.textColor = Color.cyan; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6133bdb9740
unity_docs
networking
What is `Android.AndroidColorModeWideColorGamut` in Unity? Explain its purpose and usage.
AndroidColorModeWideColorGamut enumeration Description Options to indicate whether the screen can display wide range of color gamut or not. Additional resources: AndroidConfiguration.colorModeWideColorGamut Properties Property Description Undefined Mirrors the Android property value COLOR_MODE_WIDE_COLOR_GAMU...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79acb7155cbf
unity_docs
scripting
What is `GameObject.SendMessage` in Unity? Explain its purpose and usage.
GameObject.SendMessage Declaration public void SendMessage (string methodName , object value = null, SendMessageOptions options = SendMessageOptions.RequireReceiver); Parameters Parameter Description methodName The name of the MonoBehaviour method to call. value An optional parameter value to pass t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7c59f1b91a24_doc_3
github
scripting
What does `FireKey` do in this Unity script? Explain its purpose and signature.
Function executed when the key is pressed. Signature: ```csharp protected abstract void FireKey(); ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_63ea90959f28
unity_docs
rendering
What is `ParticleSystemVertexStreams` in Unity? Explain its purpose and usage.
Method group is Obsolete ParticleSystemVertexStreams enumeration Obsolete ParticleSystemVertexStreams is deprecated. Please use ParticleSystemVertexStream instead. Description All possible Particle System vertex shader inputs.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5651114f9a24
unity_docs
math
What is `UIElements.NavigationMoveEvent.GetPooled` in Unity? Explain its purpose and usage.
NavigationMoveEvent.GetPooled Declaration public static UIElements.NavigationMoveEvent GetPooled ( Vector2 moveVector , EventModifiers modifiers ); Parameters Parameter Description moveVector The move vector. modifiers The modifier keys held down during the event. Returns NavigationMoveEvent An i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4d55f51be9c
unity_docs
physics
What is `UIElements.RuntimePanelUtils.ResetRenderer` in Unity? Explain its purpose and usage.
RuntimePanelUtils.ResetRenderer Declaration public static void ResetRenderer ( UIElements.IPanel panel ); Description Resets the renderer of the panel. Releases all meshes, rendering commands, and pools owned by the renderer. Call this method to force a defragmentation and reordering of mesh memory. This c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84d8e79b6f09
unity_docs
editor
What is `Rendering.GraphicsFence` in Unity? Explain its purpose and usage.
GraphicsFence struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Used to manage synchronisation between tasks on async compute queues and the graphics queue. Not all platforms support graphics fences. See SystemInfo.supportsGraphicsFence . A GraphicsFence represents a point ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_23ca83024286
unity_docs
scripting
What is `ChangeAssetObjectPropertiesEventArgs.ctor` in Unity? Explain its purpose and usage.
ChangeAssetObjectPropertiesEventArgs Constructor Declaration public ChangeAssetObjectPropertiesEventArgs (GUID guid , int instanceId , SceneManagement.Scene scene ); Parameters Parameter Description guid The GUID of the changed asset. instanceId The instance ID of the modified asset. scene The Sce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db6f2fa1a03a
unity_docs
rendering
What is `AssetPreview.GetMiniTypeThumbnail` in Unity? Explain its purpose and usage.
AssetPreview.GetMiniTypeThumbnail Declaration public static Texture2D GetMiniTypeThumbnail (Type type ); Description Returns the thumbnail for the type. Description Returns the thumbnail for the object's type. Use this instead of GetMiniThumbnail if you don't want preview thumbnails (e.g. thumbnails for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c60add3693b7
unity_docs
editor
Give me an overview of the `PrefabInstanceStatus` class in Unity.
PrefabInstanceStatus enumeration Description Enum with status about whether a Prefab instance is properly connected to its asset. Properties Property Description NotAPrefab The object is not part of a Prefab instance. Connected The Prefab instance is connected to its Prefab Asset. MissingAsset The Prefab inst...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15f6a0851003
unity_docs
math
What is `Quaternion.FromToRotation` in Unity? Explain its purpose and usage.
Quaternion.FromToRotation Declaration public static Quaternion FromToRotation ( Vector3 fromDirection , Vector3 toDirection ); Parameters Parameter Description fromDirection A non-unit or unit vector representing a direction axis to rotate. toDirection A non-unit or unit vector representing the targ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_944190af33e7
unity_docs
scripting
What is `WSA.Toast.Create` in Unity? Explain its purpose and usage.
Toast.Create Declaration public static WSA.Toast Create (string xml ); Declaration public static WSA.Toast Create (string image , string text ); Parameters Parameter Description xml XML document with tile data. image Uri to image to show on a toast, can be empty, in that case text-only notificati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b6ecb89c7ac
unity_docs
scripting
What is `Playables.PlayableExtensions.SetDelay` in Unity? Explain its purpose and usage.
Method group is Obsolete PlayableExtensions.SetDelay Obsolete SetDelay is obsolete; use a custom ScriptPlayable to implement this feature. Declaration public static void SetDelay (U playable , double delay ); Parameters Parameter Description playable The Playable used by this operation. delay The de...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_71a8758df16b
unity_docs
math
What is `Unity.Collections.LowLevel.Unsafe.NativeSliceUnsafeUtility` in Unity? Explain its purpose and usage.
NativeSliceUnsafeUtility class in Unity.Collections.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Contains unsafe methods for working with NativeSlice instances. Static Methods Method Description ConvertExistingDataToNativeSlice Creates a new NativeSlice from existing data. GetAtomicS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e35a9ea49a93
unity_docs
editor
What is `Device.SystemInfo.supportsMultisampledBackBuffer` in Unity? Explain its purpose and usage.
SystemInfo.supportsMultisampledBackBuffer public static bool supportsMultisampledBackBuffer ; Description This property has the same functionality as SystemInfo.supportsMultisampledBackBuffer and it 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_ddc88ad0830d
unity_docs
physics
What is `TerrainTools.IOnPaint` in Unity? Explain its purpose and usage.
IOnPaint interface in UnityEditor.TerrainTools Description Interface that provides parameters and utility functions for the OnPaint event of the terrain paint tools. Additional resources: TerrainPaintTool<T0>.OnPaint . Properties Property Description brushSize Read only. Current brush size in Terrain units (...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b20795a69ba2
unity_docs
math
What is `Vector2.Distance` in Unity? Explain its purpose and usage.
Vector2.Distance Declaration public static float Distance ( Vector2 a , Vector2 b ); Description Returns the distance between a and b . Vector2.Distance(a,b) is the same as (a-b).magnitude .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3c7c62e827b
unity_docs
scripting
What is `Experimental.GraphView.IDropTarget.DragUpdated` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. IDropTarget.DragUpdated Declaration public bool DragUpdated ( UIElements.DragUpdatedEvent evt , IEnumerable<ISelectable> selection , Experimental.GraphView.IDropTarget dropTarget , Experimental.GraphView.ISelection dragS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2cf377772760
unity_docs
rendering
What is `Lightmapping.lightingSettingsDefaults` in Unity? Explain its purpose and usage.
Lightmapping.lightingSettingsDefaults public static LightingSettings lightingSettingsDefaults ; Description Default LightingSettings that Unity uses for Scenes where lightingSettings is not assigned. (Read only) Will throw an exception if data is being altered.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6b5c75159494
unity_docs
rendering
Explain 'Virtual Texturing error material' in Unity.
You can use Streaming Virtual Texturing (SVT) with shaders you create in Shader Graph . To use SVT to stream one or more textures, you need to set up your material and Shader Graph correctly. To learn more, see Using Streaming Virtual Texturing in Shader Graph . When a texture is not set up correctly, Unity can’t rende...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_753c868d2ca8
unity_docs
editor
What is `Android.AndroidProjectFiles.SetBuildGradleFile` in Unity? Explain its purpose and usage.
AndroidProjectFiles.SetBuildGradleFile Declaration public void SetBuildGradleFile (string path , Unity.Android.Gradle.ModuleBuildGradleFile buildGradle ); Parameters Parameter Description path The file path to place the build.gradle file at. This path is relative to the gradle project path. buildGradle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7e74c740623f
unity_docs
networking
In Unity's 'Trusting the web proxy security certificate', what is 'macOS and Linux' and how does it work?
``` export NODE_EXTRA_CA_CERTS=/Users/username/mycert.pem ``` You can find more information about the NODE_EXTRA_CA_CERTS environment variable in the Node.js documentation .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac1424dfac31
unity_docs
scripting
What is `CombineInstance.mesh` in Unity? Explain its purpose and usage.
CombineInstance.mesh public Mesh mesh ; Description Mesh to combine. This property holds the Mesh that will be combined with other Meshes. It is set to null by default. Additional resources: Mesh.CombineMeshes , subMeshIndex , transform .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ce22310e4dae
unity_docs
animation
What is `Tilemaps.TileAnimationData` in Unity? Explain its purpose and usage.
TileAnimationData struct in UnityEngine.Tilemaps / Implemented in: UnityEngine.TilemapModule Description A Struct for the required data for animating a Tile . Properties Property Description animatedSprites The array of sprites that are ordered by appearance in the animation. animationSpeed The animation s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a18348e65a4
unity_docs
rendering
What is `TerrainTools.TerrainPaintUtility.BeginPaintTexture` in Unity? Explain its purpose and usage.
TerrainPaintUtility.BeginPaintTexture Declaration public static TerrainTools.PaintContext BeginPaintTexture ( Terrain terrain , Rect boundsInTerrainSpace , TerrainLayer inputLayer , int extraBorderPixels = 0, bool fillOutsideTerrain = true); Parameters Parameter Description terrain Reference Ter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f0be188fdc18
unity_docs
scripting
In Unity's 'Direct reference asset management', what is 'Direct reference overview' and how does it work?
In Unity, a direct reference is a serialized link from one object to another. When one object holds a direct reference to another, it creates a dependency on that object. When Unity creates a build of your project, it follows all direct references to make sure that all objects that reference each other are included in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d554162110c
unity_docs
scripting
Give me an overview of the `GraphicsBufferHandle` class in Unity.
GraphicsBufferHandle struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Represents the internal handle/id of a GraphicsBuffer . The handle is valid as long as the GraphicsBuffer it has been fetched from has not been disposed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3686f2aaea29
unity_docs
math
What is `GridBrushBase.BoxFill` in Unity? Explain its purpose and usage.
GridBrushBase.BoxFill Declaration public void BoxFill ( GridLayout gridLayout , GameObject brushTarget , BoundsInt position ); Parameters Parameter Description gridLayout Grid used for layout. brushTarget Target of box fill operation. By default the currently selected GameObject. position The bou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9f897d0fb8f8
unity_docs
scripting
Explain 'Create a list view runtime UI' in Unity.
Version : 2022.3+ This example demonstrates how to create a list view runtime UI. This example uses the UXML and USS files directly to create the structure and style of the UI. If You’re new to UI Toolkit and want to use UI Builder to create the UI, refer to Create an example UI with UI Builder . ## Example overview ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6cec64bba5f1
unity_docs
rendering
What is `ParticleSystemJobs.ParticleSystemJobData` in Unity? Explain its purpose and usage.
ParticleSystemJobData struct in UnityEngine.ParticleSystemJobs / Implemented in: UnityEngine.ParticleSystemModule Description This struct specifies all the per-particle data. Properties Property Description aliveTimePercent Specifies how long each particle has been alive. axisOfRotations Specifies an axis o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_13497605d330
unity_docs
physics
What is `RaycastHit2D.distance` in Unity? Explain its purpose and usage.
RaycastHit2D.distance public float distance ; Description The distance the physics query traversed before it detected a Collider2D . When the RaycastHit2D result is returned from a physics query, the distance refers to the distance from the physics query start position to the position the physics query sha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_207ec3f686a4
unity_docs
rendering
What is `Experimental.GraphView.PlacematContainer.UpdateElementsOrder` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PlacematContainer.UpdateElementsOrder Declaration protected void UpdateElementsOrder (); Description Updates the list of collapsed elements. This method is not meant to be called. The purpose of this method is to be overridd...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a27b52b00528
unity_docs
animation
What are the parameters of `Tilemaps.TileBase.GetTileAnimationData` in Unity?
Returns bool Whether the call was successful. Description Retrieves any tile animation data from the scripted tile. Implement this and fill in the TileAnimationData to have the Tilemap run an animation for the tile. ```csharp using UnityEngine; using UnityEngine.Tilemaps;// Tile that plays an animated loops of sprites ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd3c2d24e1f6
unity_docs
animation
Show me a Unity C# example demonstrating `Animations.ParentConstraint.rotationAxis`.
ParentConstraint.rotationAxis public Animations.Axis rotationAxis ; Description The rotation axes affected by the ParentConstraint. Use this property to restrict the rotation of the constrained object on a particular axis. ```csharp using UnityEngine.Animations;public class ConstraintAxis { public void Cons...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.