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_4edf1587389a
unity_docs
ui
What is `Experimental.GraphView.Scope.headerContainer` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Scope.headerContainer public UIElements.VisualElement headerContainer ; Description Returns the header container for the Scope. Use this header container to customizer the header of the Scope.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_771d327172ae
unity_docs
scripting
What is `Experimental.GraphView.IDropTarget.DragExited` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. IDropTarget.DragExited Declaration public bool DragExited (); Returns bool Returns event propagation. Description This method is automatically called when dragging ends and the drag source is not over a valid drop targe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4eb25f5f9c69
unity_docs
rendering
What is `Rendering.BatchRendererGroup.GetRegisteredMaterial` in Unity? Explain its purpose and usage.
BatchRendererGroup.GetRegisteredMaterial Declaration public Material GetRegisteredMaterial ( Rendering.BatchMaterialID material ); Parameters Parameter Description material BatchRendererGroup Material ID. Returns Material Unity Material. Description Returns the previously registered Material assoc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_337765457029
unity_docs
math
What is `AndroidJNI.NewShortArray` in Unity? Explain its purpose and usage.
AndroidJNI.NewShortArray Declaration public static IntPtr NewShortArray (int size ); Description Constructs a new primitive array object. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83fd4f6f4265
unity_docs
xr
What is `Search.SearchService.GetItems` in Unity? Explain its purpose and usage.
SearchService.GetItems Declaration public static List<SearchItem> GetItems ( Search.SearchContext context , Search.SearchFlags options ); Parameters Parameter Description context The current search context. options Options defining how the query is performed. Returns List<SearchItem> A list of sear...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a2d8f7144640
unity_docs
ui
In Unity's 'Matchmaker Session Building Block', what is 'Introduction' and how does it work?
The Matchmaker Session Building Block helps you integrate Unity’s Matchmaker into your project to connect players together. This Building Block can serve as a starting point for your multiplayer projects, or as a quick integration of Matchmaker throughout development. This Building Block demonstrates how to do the foll...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2b84338f86a
unity_docs
editor
What is `VersionControl.Asset` in Unity? Explain its purpose and usage.
Asset class in UnityEditor.VersionControl Description This class containes information about the version control state of an asset. Properties Property Description assetPath Gets the path of the Asset relative to the project root. If the Asset is a meta file, the path to the meta file is returned. fullName Ge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78887043dc26
unity_docs
scripting
What is `ColorUtility` in Unity? Explain its purpose and usage.
ColorUtility class in UnityEngine / Implemented in: UnityEngine.CoreModule Description A collection of common color functions. Static Methods Method Description ToHtmlStringRGB Returns the color as a hexadecimal string in the format "RRGGBB". ToHtmlStringRGBA Returns the color as a hexadecimal string in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bdf692ab12cc
unity_docs
physics
What is `LazyLoadReference_1.operator_int` in Unity? Explain its purpose and usage.
LazyLoadReference<T0>.LazyLoadReference<T> Parameters Parameter Description instanceID The asset instance ID. Description Implicit conversion from instance ID to LazyLoadReference. Calling this never triggers a load.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2cf615c3e72b
unity_docs
rendering
What is `ShaderUtil.GetRayTracingShaderMessages` in Unity? Explain its purpose and usage.
ShaderUtil.GetRayTracingShaderMessages Declaration public static ShaderMessage[] GetRayTracingShaderMessages ( Rendering.RayTracingShader s ); Parameters Parameter Description s The RayTracingShader instance to check for messages. Returns ShaderMessage[] An array of ShaderMessage structs containing ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6448052ec649
unity_docs
scripting
What is `ScriptableObject.Reset` in Unity? Explain its purpose and usage.
ScriptableObject.Reset() Description Reset to default values. Reset is called when the user hits the Reset button in the Inspector's context menu or when adding the component the first time. This function is only called in editor mode. Reset is most commonly used to give good default values in the Inspector. ```c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63dc1aae79c6
unity_docs
ui
What is `UIElements.BindingExtensions.TrackSerializedObjectValue` in Unity? Explain its purpose and usage.
BindingExtensions.TrackSerializedObjectValue Declaration public static void TrackSerializedObjectValue ( UIElements.VisualElement element , SerializedObject obj , Action<SerializedObject> callback ); Parameters Parameter Description element VisualElement tracking an object. obj The SerializedObject to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2297bd7ad24
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUILayout.PrefixLabel`.
at can be specified as one of the parameters. PrefixLabel can be used when there is no such built-in label available, or when you're creating your own editor control from scratch. PrefixLabel also ensures that when the label is clicked, the linked control will get keyboard focus (if the control supports keyboard focus...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9dfcab6b03a1
unity_docs
rendering
Explain 'Conservative command in ShaderLab reference' in Unity.
Enables or disables conservative rasterization . ## Render pipeline compatibility Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline Conservative Yes Yes Yes Yes ## Syntax This command makes a change to the render state. Use it in a Pass block to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1002f3f2376a
unity_docs
rendering
In Unity's 'LOD Group component reference', what is 'LOD Group selection bar' and how does it work?
The LOD Group selection bar represents the different LOD levels as colored boxes. The percentage that appears in each LOD level box represents the threshold at which that level becomes active, based on the ratio of the GameObject’s screen space height to the total screen height. For example, if the threshold for LOD 1 ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_6
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive seven arguments as part of its initialization process.-derived classes that implement this interface can be instantiated with their dependency using the function.-derived classes that implement this interface can be added to a with their dependency using the function.If the class...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_6ba9d8ec5e45
unity_docs
animation
What is `Animator.runtimeAnimatorController` in Unity? Explain its purpose and usage.
Animator.runtimeAnimatorController public RuntimeAnimatorController runtimeAnimatorController ; Description The runtime representation of AnimatorController that controls the Animator. Swapping Animator.runtimeAnimatorController with an AnimatorOverrideController based on the same AnimatorController at...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_832c56de57fe
unity_docs
scripting
Show me a Unity C# example demonstrating `Application.temporaryCachePath`.
Application.temporaryCachePath public static string temporaryCachePath ; Description Contains the path to a temporary data / cache directory (Read Only). This path is unique per Unity project, but it isn't unique for multiple concurrent instances of the same project. To obtain unique temporary paths, use File...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_be9c2e627873
unity_docs
physics
In Unity's 'Character Joint component reference', what is 'Limit Spring properties' and how does it work?
The following limit spring properties are available for Twist Limit Spring and Swing Limit Spring . Values apply to force for linear motion, and torque for rotational motion. Property Function Spring The elasticity of the limit. Set this value to zero to make the limit impassable. A value other than zero makes the limi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_228eece20793
unity_docs
rendering
What is `Lightmapping.SetLightingSettingsForScene` in Unity? Explain its purpose and usage.
Lightmapping.SetLightingSettingsForScene Declaration public static void SetLightingSettingsForScene ( SceneManagement.Scene scene , LightingSettings lightingSettings ); Parameters Parameter Description scene The Scene object. If the Scene.isLoaded property is false , the method does not apply the se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d5a883064d6e
unity_docs
rendering
Explain 'Self-Illuminated Parallax Diffuse' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces this shader . ## Self-Illuminated Properties Note. Unity 5 introduced the Standard Shader which replaces this shader. This shader allows you to define bright and dark parts of the object. The alpha channel of a secondary texture will define areas of the obje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1723d988fe26
unity_docs
physics
What is `Rendering.RayTracingAccelerationStructure.UpdateInstanceMask` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.UpdateInstanceMask Declaration public void UpdateInstanceMask ( Renderer renderer , uint mask ); Parameters Parameter Description renderer The Renderer associated with the ray tracing instance. mask The new mask. Description Updates the instance mask of a ray tracing ins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6d6ede928b2
unity_docs
rendering
What is `Rendering.RendererListParams` in Unity? Explain its purpose and usage.
RendererListParams struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Struct holding the arguments that are needed to create a renderers RendererList . Static Properties Property Description Invalid Returns an empty RendererListParams. Properties Property Description cu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7676a971ac04
unity_docs
xr
Show me a Unity C# example demonstrating `Search.SearchFlags.Synchronous`.
SearchFlags.Synchronous Description Search items are fetched synchronously. This can take a long time for some SearchProvider (like asset). Use at your own risk. ```csharp using UnityEditor; using UnityEditor.Search; using UnityEngine; public class SearchFlags_Synchronous { [MenuItem("Examples/SearchFlags/Synch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_449f4c9b4e35
unity_docs
xr
What is `HDROutputSettings.RequestHDRModeChange` in Unity? Explain its purpose and usage.
HDROutputSettings.RequestHDRModeChange Declaration public void RequestHDRModeChange (bool enabled ); Parameters Parameter Description enabled Indicates whether HDR should be enabled. Description Use this function to request a change in the HDR Output Mode and in the value of HDROutputSettings.active . Wh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_aa4a514bff85
unity_docs
scripting
In Unity's 'Deep linking', what is 'Test a deep link' and how does it work?
To test a deep link, use the following steps: Create a HTML file that includes the deep link to test. Host the HTML file on a local web server. Open the HTML file from a web browser on your device and click the deep link.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69e7dd449093
unity_docs
physics
Show me a Unity C# example demonstrating `Awaitable.WaitForSecondsAsync`.
it. This aborts the wait rather than interrupting it and continuing. If you use cancellation to indicate that a task has completed early and expect execution to proceed to subsequent statements, you must handle the exception explicitly or avoid passing a token here. Otherwise, code that awaits a delay with a token and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_046de4eaf851
unity_docs
animation
What is `Animations.LookAtConstraint.useUpObject` in Unity? Explain its purpose and usage.
LookAtConstraint.useUpObject public bool useUpObject ; Description Determines how the up vector is calculated. When set to true, the constraint uses LookAtConstraint.worldUpObject to calculate the up vector. When set to false, the constraint uses the world's Y axis rotated by LookAtConstraint.roll as the u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_80c5ddc91d80
unity_docs
xr
Show me a Unity code example for 'Unity Accelerator downloads'.
, more focused agent. Install from external disk (macOS): Installer can run from an external disk. Uninstallation improvements: Enhanced the process to handle cases where the config folder and storage folder differ. App entries cleanup: Ensured proper clean-up of installed app entries during uninstallation or upgrade. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e4de32d0fb8
unity_docs
scripting
What is `UIElements.UxmlTypeAttributeDescription_1` in Unity? Explain its purpose and usage.
UxmlTypeAttributeDescription<T0> class in UnityEngine.UIElements / Inherits from: UIElements.TypedUxmlAttributeDescription_1 / Implemented in: UnityEngine.UIElementsModule Description Describes an XML System.Type attribute. Properties Property Description defaultValueAsString The default value for t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_60cf9626d3f0
unity_docs
scripting
Explain 'Integrating Unity into native iOS applications' in Unity.
This page describes how to integrate the Unity Runtime Library into iOS native applications with the Unity as a Library feature. You can use this feature to include Unity-powered features, such as 3D/2D Real-Time Rendering, AR Experience, 3D model interaction, or 2D mini-games, in your native application. The Unity Run...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac1a44774aad
unity_docs
scripting
What is `Compilation.CompilationPipeline.AssemblyDefinitionReferenceGUIDToGUID` in Unity? Explain its purpose and usage.
CompilationPipeline.AssemblyDefinitionReferenceGUIDToGUID Declaration public static string AssemblyDefinitionReferenceGUIDToGUID (string reference ); Parameters Parameter Description reference Assembly Definition File GUID reference. Returns string A GUID string. Description Converts an assembly defi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c5bc165208b7
unity_docs
rendering
In Unity's 'Virtual Texturing error material', what is 'Validation errors' and how does it work?
A Texture Stack is a group of textures that Unity samples at the same time, using the same UV coordinates. A validation error occurs when the Texture Stack or a texture in the Texture Stack is not in a valid state. You can see the validation error in the Material Inspector : This validation error example is caused by a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a11f471b4c50
unity_docs
input
What is `EventType.KeyDown` in Unity? Explain its purpose and usage.
EventType.KeyDown Description A keyboard key was pressed. Use Event.character to find out what has been typed. Use Event.keyCode to handle arrow, home/end or other function keys, or to find out which physical key has been pressed. This event is sent repeatedly depending on the end user's keyboard repeat setting...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_785a0bbb6ea4
unity_docs
animation
What is `Animation.AddClip` in Unity? Explain its purpose and usage.
Animation.AddClip Declaration public void AddClip ( AnimationClip clip , string newName ); Description Adds a clip to the animation with name newName . Declaration public void AddClip ( AnimationClip clip , string newName , int firstFrame , int lastFrame , bool addLoopFrame = false); Parameter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_418b5c082615
unity_docs
rendering
What is `ReflectionProbe.hdr` in Unity? Explain its purpose and usage.
ReflectionProbe.hdr public bool hdr ; Description Should this reflection probe use HDR rendering? When baked HDR reflection probe range [0;8] is packed to [0;1] with multiplier stored in the alpha channel. Additional resources: texture assets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_862863ac4250
unity_docs
ui
What is `Networking.PlayerConnection.PlayerConnectionGUILayout` in Unity? Explain its purpose and usage.
PlayerConnectionGUILayout class in UnityEditor.Networking.PlayerConnection Description This class contains methods to draw and automatically layout IMGUI Editor UI that relates to the Player Connection. Use the methods in this class to automatically lay out UI elements. For manual positioning, use the correspondi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80d7b2995e27
unity_docs
editor
What is `PlayerSettings.Android.maxAspectRatio` in Unity? Explain its purpose and usage.
PlayerSettings.Android.maxAspectRatio public static float maxAspectRatio ; Description Maximum aspect ratio supported by the application. This value is expressed as (longer dimension / shorter dimension) in decimal form. It can't be set to a value lower than 1.86 which approximately matches the older widescr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d77cb2af5d1b
unity_docs
animation
What is `Animator.rootRotation` in Unity? Explain its purpose and usage.
Animator.rootRotation public Quaternion rootRotation ; Description The root rotation, the rotation of the game object. You should only set this value from within an OnAnimatorIK() function call.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74cd107f6aa9
unity_docs
physics
What is `Rigidbody.interpolation` in Unity? Explain its purpose and usage.
Rigidbody.interpolation public RigidbodyInterpolation interpolation ; Description Interpolation provides a way to manage the appearance of jitter in the movement of your Rigidbody GameObjects at run time. Interpolation calculates the pose of a Rigidbody in frames that fall between physics timestep updates, t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a95954a0b763
unity_docs
math
What are the parameters of `AudioListener.GetSpectrumData` in Unity?
Description Provides a block of the listener (master)'s spectrum data. The array given in the samples parameter will be filled with the requested data. Number of values (the length of the samples array) must be a power of 2. (ie 128/256/512 etc). Min = 64. Max = 8192. Use window to reduce leakage between frequency bins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2288492886a3
unity_docs
rendering
Explain 'Reuse HLSL code' in Unity.
To tell the compiler to include existing High-Level Shader Language (HLSL) code in another file or section, use the following methods: Include an HLSL file in another, using the standard HLSL #include directive. Duplicate HLSL in multiple places using the HLSLINCLUDE and ENDHLSL macros. Apply a #pragma directive to mul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8b34c5546c46
unity_docs
rendering
Explain 'Access DOTS Instancing properties in a custom shader' in Unity.
To access DOTS Instanced properties, your shader can use one of the access macros that Unity provides. The access macros assume that instance data in unity_DOTSInstanceData uses the following layout: The 31 least significant bits of the metadata value contain the byte address of the first instance in the batch within t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75b7ae49506c
unity_docs
physics
What is `ParticleSystem.trigger` in Unity? Explain its purpose and usage.
ParticleSystem.trigger public ParticleSystem.TriggerModule trigger ; Description Script interface for the TriggerModule of a Particle System. This module is useful for killing particles when they touch a set of collision shapes, or for calling a script command to let you apply custom particle behaviors when ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34a8837ac24e
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetDatabase.CopyAsset`.
eters Parameter Description path Filesystem path of the source asset. newPath Filesystem path of the new asset to create. Returns bool Returns true if the copy operation is successful or false if part of the process fails. Description Duplicates the asset at path and stores it at newPath . All paths a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56a583d22af0
unity_docs
animation
What is `Keyframe` in Unity? Explain its purpose and usage.
Keyframe struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description A single keyframe that can be injected into an animation curve. Properties Property Description inTangent Sets the incoming tangent for this key. The incoming tangent affects the slope of the curve from the previous key to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ee4f71fd3eb
unity_docs
input
What is `UIElements.DoubleField` in Unity? Explain its purpose and usage.
DoubleField class in UnityEngine.UIElements / Inherits from: UIElements.TextValueField_1 / Implemented in: UnityEngine.UIElementsModule Description Makes a text field for entering doubles. Static Properties Property Description inputUssClassName USS class name of input elements in elements of this typ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47920b65f692
unity_docs
physics
What is `Tilemaps.Tilemap.GetColliderType` in Unity? Explain its purpose and usage.
Tilemap.GetColliderType Declaration public Tilemaps.Tile.ColliderType GetColliderType ( Vector3Int position ); Parameters Parameter Description position Position of the Tile on the Tilemap . Returns ColliderType Collider type of the Tile at the XYZ coordinate. Description Gets the Collider type...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_09813737d2e3
unity_docs
rendering
In Unity's 'Control occlusion in areas with Occlusion Portals', what is 'Setting up an Occlusion Portal in your Scene' and how does it work?
Choose a suitable GameObject in your Scene to act as an Occlusion Portal. Good candidates for Occlusion Portals are medium to large solid GameObjects, such as a door. Ensure that the GameObject is not marked as Occluder Static or Occludee Static. Add an Occlusion Portal component to the GameObject. Bake the occlusion d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a156a3a4e84
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.MainModule.maxParticles`.
ParticleSystem.MainModule.maxParticles public int maxParticles ; Description The maximum number of particles to emit. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBehaviour { public float hSliderValue = 0.0F; private Particle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_424a7cb357a0
unity_docs
math
What is `AssetBundleManifest.GetAllAssetBundles` in Unity? Explain its purpose and usage.
AssetBundleManifest.GetAllAssetBundles Declaration public string[] GetAllAssetBundles (); Returns string[] An array of asset bundle names. Description Get all the AssetBundles in the manifest.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ac3fe3f9ad3
unity_docs
physics
What is `SerializedObject.forceChildVisibility` in Unity? Explain its purpose and usage.
SerializedObject.forceChildVisibility public bool forceChildVisibility ; Description Controls the visibility of the child hidden fields. A boolean value that controls the visibility of the child hidden fields. True means that any hidden fields are displayed. False means that any hidden fields are not displayed....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4ca2719db69
unity_docs
rendering
What is `SystemInfo.supportsIndirectDispatchRays` in Unity? Explain its purpose and usage.
SystemInfo.supportsIndirectDispatchRays public static bool supportsIndirectDispatchRays ; Description Returns true if the graphics system supports indirect ray tracing dispatch. (Read Only) This feature enables scenarios where shaders generate ray tracing data (for example ray buffers) and call arguments for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_057ca2ffbe3d
unity_docs
physics
What is `MPE.ChannelService.DispatchMessages` in Unity? Explain its purpose and usage.
ChannelService.DispatchMessages Declaration public static void DispatchMessages (); Description Dispatches any messages that have been received since the last dispatch. This happens automatically every editor tick, but this method can be used to force dispatching to occur during thread-blocking operations.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_afcbbac1b9a0
unity_docs
editor
What is `EditorUtility.OpenFolderPanel` in Unity? Explain its purpose and usage.
EditorUtility.OpenFolderPanel Declaration public static string OpenFolderPanel (string title , string folder , string defaultName ); Description Displays the "open folder" dialog and returns the selected path name. Additional resources: OpenFilePanel , SaveFolderPanel functions. ```csharp using UnityEdit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_319fff23b371
unity_docs
scripting
In Unity's 'Create a Video Player component', what is 'Drag a video clip into the scene' and how does it work?
The quickest way to create a Video Player component is to drag your video clip into the scene: Locate the video file in your Asset folder in Unity. Click and drag your file into an empty spot in the Scene Hierarchy, in the Scene view , or in the Inspector. As a result, Unity creates a GameObject that contains a Video P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8642fae1b433
unity_docs
scripting
What is `AndroidJavaObject.GetRawClass` in Unity? Explain its purpose and usage.
AndroidJavaObject.GetRawClass Declaration public IntPtr GetRawClass (); Description Retrieves the raw jclass pointer to the Java class. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26644505aec0
unity_docs
audio
What is `Video.VideoPlayer.GetTargetAudioSource` in Unity? Explain its purpose and usage.
VideoPlayer.GetTargetAudioSource Declaration public AudioSource GetTargetAudioSource (ushort trackIndex ); Parameters Parameter Description trackIndex Index of the audio track for which the AudioSource is wanted. Returns AudioSource The source associated with the audio track. Description Gets the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91ab142d2361
unity_docs
editor
What is `Debug` in Unity? Explain its purpose and usage.
Debug class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Class containing methods to ease debugging while developing a game. Static Properties Property Description developerConsoleEnabled Allows you to enable or disable the developer console. developerConsoleVisible Controls whether ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c8f05b21b00
unity_docs
rendering
What is `ParticleSystemRenderer.activeVertexStreamsCount` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.activeVertexStreamsCount public int activeVertexStreamsCount ; Description The number of currently active custom vertex streams. Additional resources: ParticleSystemRenderer.SetActiveVertexStreams , ParticleSystemRenderer.GetActiveVertexStreams .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20750b2f0b65
unity_docs
rendering
What is `Shader.SetGlobalMatrixArray` in Unity? Explain its purpose and usage.
Shader.SetGlobalMatrixArray Declaration public static void SetGlobalMatrixArray (string name , Matrix4x4[] values ); Declaration public static void SetGlobalMatrixArray (int nameID , Matrix4x4[] values ); Declaration public static void SetGlobalMatrixArray (string name , List<Matrix4x4> values ); D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_431c966c2a1d
unity_docs
rendering
Explain 'Detect asynchronous shader compilation' in Unity.
You can use C# APIs to monitor the state of asynchronous shader compilation, and perform operations when this state changes. This is most likely useful in advanced rendering ; if the placeholder shader pollutes your generated data, you can wait until compilation is complete, discard the polluted data, and regenerate a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d6a60522bb8
unity_docs
rendering
What is `Experimental.GlobalIllumination.LightmapperUtils.ExtractInnerCone` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LightmapperUtils.ExtractInnerCone Declaration public static float ExtractInnerCone ( Light l ); Description Extracts the inner cone angle of spot lights.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21452e4b739a
unity_docs
physics
What is `PhysicsVisualizationSettings.GetShowRigidbodies` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.GetShowRigidbodies Declaration public static bool GetShowRigidbodies (); Description Should any Rigidbodies be considered by the display filter. Kinematic Rigidbodies can be further filtered by SetShowKinematicBodies . Sleeping Rigidbodies can be further filtered by SetShowSleepin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a2da2805cbc
unity_docs
math
Show me a Unity C# example demonstrating `Collider.ClosestPointOnBounds`.
Collider.ClosestPointOnBounds Declaration public Vector3 ClosestPointOnBounds ( Vector3 position ); Description The closest point to the bounding box of the attached collider. This can be used to calculate hit points when applying explosion damage. ```csharp using UnityEngine; using System.Collections;publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0cd4d447bf3
unity_docs
math
What is `SceneVisibilityManager.Hide` in Unity? Explain its purpose and usage.
SceneVisibilityManager.Hide Declaration public void Hide ( GameObject gameObject , bool includeDescendants ); Declaration public void Hide (GameObject[] gameObjects , bool includeDescendants ); Parameters Parameter Description gameObject GameObject to hide. gameObjects Array of GameObjects to hide....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6990ef1f76a2
unity_docs
scripting
What is `PrimitiveType.Capsule` in Unity? Explain its purpose and usage.
PrimitiveType.Capsule Description A capsule primitive. Additional resources: GameObject.CreatePrimitive . ```csharp using UnityEngine; using System.Collections;// Creates a capsule primitivepublic class ExampleClass : MonoBehaviour { void Start() { GameObject capsule = GameObject.CreatePrimitive(PrimitiveType....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc8723d83ed5
unity_docs
ui
What is `UIElements.VisualElement.Hierarchy.Equals` in Unity? Explain its purpose and usage.
VisualElement.Hierarchy.Equals Declaration public bool Equals ( UIElements.VisualElement.Hierarchy other ); Parameters Parameter Description other The structure to compare with. Returns bool Returns true if the two instances refer to the same element, false otherwise. Description Compares instances...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64e52a0f1351
unity_docs
math
What is `Rendering.RayTracingAccelerationStructure.BuildSettings.relativeOrigin` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.BuildSettings.relativeOrigin public Vector3 relativeOrigin ; Description The relative origin of ray tracing instances. This value is subtracted from the original instance position to get the final instance position. If you do camera-relative ray tracing, you can use relativeOr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_43142d5751bb
unity_docs
math
Explain 'BoundsField' in Unity.
The BoundsField lets users enter a Bounds value in a UI. Note : To align an element with other fields in an Inspector window, simply apply the.unity-base-field__aligned USS class to it. For more information, refer to BaseField . ## Create a BoundsField You can create a BoundsField with UI Builder, UXML, or C#. The fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e63ed30a3d4
unity_docs
xr
What is `Camera.ResetStereoProjectionMatrices` in Unity? Explain its purpose and usage.
Camera.ResetStereoProjectionMatrices Declaration public void ResetStereoProjectionMatrices (); Description Reset the camera to using the Unity computed projection matrices for all stereoscopic eyes. If Camera.SetStereoProjectionMatrices or Camera.SetStereoProjectionMatrix were used to provide custom projecti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_761feddcf534
unity_docs
editor
What is `AssetImporter.SaveAndReimport` in Unity? Explain its purpose and usage.
AssetImporter.SaveAndReimport Declaration public void SaveAndReimport (); Description Save asset importer settings if asset importer is dirty. Under the hood this calls AssetDatabase.ImportAsset . Additional resources: EditorUtility.SetDirty . ```csharp using UnityEngine; using UnityEditor; public class Save...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6482ef24fb0c
unity_docs
scripting
What is `UIElements.UxmlIntAttributeDescription.TryGetValueFromBag` in Unity? Explain its purpose and usage.
UxmlIntAttributeDescription.TryGetValueFromBag Declaration public bool TryGetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc , ref int value ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. value The value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ddfb0364499c
unity_docs
performance
What is `Rendering.CommandBuffer.name` in Unity? Explain its purpose and usage.
CommandBuffer.name public string name ; Description Name of this command buffer. This can be used for debugging, so that command buffer activity in Profiler or Frame Debugger can be seen easier. The name does not affect rendering at all.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_909b705326b7
unity_docs
ui
What is `Experimental.GraphView.FreehandSelector.UnregisterCallbacksFromTarget` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. FreehandSelector.UnregisterCallbacksFromTarget Declaration protected void UnregisterCallbacksFromTarget (); Description Unregister callbacks on target VisualElement.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_947cc59467b9
unity_docs
scripting
What is `UIElements.Angle.ctor` in Unity? Explain its purpose and usage.
Angle Constructor Declaration public Angle (float value ); Description Creates an Angle from a float and an optionnal AngleUnit . AngleUnit.Degree is the default unit. Declaration public Angle (float value , UIElements.AngleUnit unit ); Description Creates an Angle from a float and an optionn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8128133f00b0
unity_docs
networking
What is `Android.AndroidColorModeWideColorGamut.Undefined` in Unity? Explain its purpose and usage.
AndroidColorModeWideColorGamut.Undefined Description Mirrors the Android property value COLOR_MODE_WIDE_COLOR_GAMUT_UNDEFINED . For information about the property value, refer to the Android developer documentation on COLOR_MODE_WIDE_COLOR_GAMUT_UNDEFINED .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ebf08782c3d
unity_docs
rendering
What is `ParticleSystemTrailMode` in Unity? Explain its purpose and usage.
ParticleSystemTrailMode enumeration Description Choose how Particle Trails are generated. Properties Property Description PerParticle Makes a trail behind each particle as the particle moves. Ribbon Draws a line between each particle, connecting the youngest particle to the oldest.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f7472789107
unity_docs
scripting
What is `Random.State` in Unity? Explain its purpose and usage.
State struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Serializable structure used to hold the full internal state of the random number generator. Additional resources: Random.state .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_909440b784ca
unity_docs
scripting
In Unity's 'Load SSH keys automatically on Windows (OpenSSH)', what is 'Before you begin' and how does it work?
Check if you have any existing SSH keys. Refer to the GitHub Docs article, Checking for existing SSH keys . If you don’t have an SSH key: Create one by following the GitHub Docs article, Generating a new SSH key . Add the new SSH key to your GitHub account, by following the GitHub Docs article, Adding a new SSH key to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9bb1b45af6a
unity_docs
editor
What is `EditorGUI.EndChangeCheck` in Unity? Explain its purpose and usage.
EditorGUI.EndChangeCheck Declaration public static bool EndChangeCheck (); Returns bool Returns true if GUI state changed since the call to EditorGUI.BeginChangeCheck , otherwise false. Description Ends a code block and checks for any GUI changes. Use this in combination with EditorGUI.BeginChangeCheck...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d11a6be7ec50
unity_docs
scripting
What is `Experimental.GraphView.Port.Disconnect` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Port.Disconnect Declaration public void Disconnect ( Experimental.GraphView.Edge edge ); Parameters Parameter Description edge The edge to disconnect. Description Disconnect edge from port.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30496c0f6d69
unity_docs
math
What is `HumanLimit.max` in Unity? Explain its purpose and usage.
HumanLimit.max public Vector3 max ; Description The maximum rotation away from the initial value that this muscle can apply. The center property specifies the rotation of the bone when the muscle is at "rest". The max value specfies the maximum rotation in degrees away from the rest value that the muscle ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c813d6649b81
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.AddBuildProperty` in Unity?
Description Adds a value to the build property list in all the build configurations for the specified target(s). Duplicate build properties are ignored. Values for names LIBRARY_SEARCH_PATHS and FRAMEWORK_SEARCH_PATHS are quoted if they contain spaces. ```csharp using UnityEngine; using UnityEditor; using UnityEditor.i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5fc46dd77525
unity_docs
editor
What is `Device.SystemInfo.operatingSystemFamily` in Unity? Explain its purpose and usage.
SystemInfo.operatingSystemFamily public static OperatingSystemFamily operatingSystemFamily ; Description This has the same functionality as SystemInfo.operatingSystemFamily 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_e8ecf59d4284
unity_docs
audio
What is `Playables.DirectorUpdateMode` in Unity? Explain its purpose and usage.
DirectorUpdateMode enumeration Description Defines what time source is used to update a Director graph. Properties Property Description DSPClock Update is based on DSP (Digital Sound Processing) clock. Use this for graphs that need to be synchronized with Audio. GameTime Update is based on Time.time. Use this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_168b46b3aeb2
unity_docs
scripting
What are the parameters of `ShortcutManagement.ReserveModifiersAttribute.ctor` in Unity?
Description Creates an attribute that reserves a modifier for a single shortcut. ```csharp using UnityEditor; using UnityEditor.ShortcutManagement; using UnityEngine;public class CustomSceneViewNavigation : ScriptableSingleton<CustomSceneViewNavigation> { bool moveForward; bool moveBack; bool boost; [Clu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfcc47e946ef
unity_docs
scripting
What is `Search.AssetIndexChangeSet.ctor` in Unity? Explain its purpose and usage.
AssetIndexChangeSet Constructor Declaration public AssetIndexChangeSet (string[] updated , string[] removed ); Declaration public AssetIndexChangeSet (IEnumerable<string> updated , IEnumerable<string> removed , IEnumerable<string> moved , Func<string,bool> predicate ); Declaration public AssetIndexChan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a754abca3c0f
unity_docs
editor
What is `StaticOcclusionCulling` in Unity? Explain its purpose and usage.
StaticOcclusionCulling class in UnityEditor Description StaticOcclusionCulling lets you perform static occlusion culling operations. Static Properties Property Description doesSceneHaveManualPortals Does the Scene contain any occlusion portals that were added manually rather than automatically? isRunning Used...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fccffeb3b931
unity_docs
rendering
Explain 'Navigating the Profiler window' in Unity.
To open the Profiler, go to Window > Analysis > Profiler or use the keyboard shortcut Ctrl+7 (Command+7 on macOS). Use the Profiler module charts to inspect and analyze Profiler data. ## Selecting and inspecting a frame To select and inspect a frame: Click on the area of a Profiler module’s chart that you want to ins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_886dbf1a9eb4
unity_docs
scripting
What is `SerializedPropertyType.Enum` in Unity? Explain its purpose and usage.
SerializedPropertyType.Enum Description Represents an enumeration property. SerializedProperty.numericType can be used to determine the type of the constant values of the enum used to access the enum type (typically int). Use SerializedProperty.intValue to access the numeric value, unless the enum type is uint,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d9da49fae9f9
unity_docs
ui
In Unity's 'Avatar Muscle & Settings tab reference', what is 'Previewing changes' and how does it work?
For the settings in the Muscle Group Preview and Per-Muscle Settings areas, you can preview the changes right in the Scene view. You can drag the sliders left and right to see the range of movement for each setting applied to your character: You can see the bones of the skeleton through the Mesh .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e753a319c4b
unity_docs
math
What is `Rendering.AttachmentIndexArray.MaxAttachments` in Unity? Explain its purpose and usage.
AttachmentIndexArray.MaxAttachments public static int MaxAttachments ; Description Maximum number of indices this struct can hold. This is directly tied to the maximum number of attachments in a native render pass (8).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f5b161209074
unity_docs
scripting
In Unity's 'Create a property visitor with the PropertyVisitor class', what is 'Get the top-level properties' and how does it work?
Inside the ObjectVisitor class, override the VisitProperty method to visit each property of an object and log the property name. The PropertyVisitor doesn’t require any members to implement and by default, it simply visits every property and performs no action. Inside the ObjectVisitor class, add the following override...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ab2942c17aa
unity_docs
physics
Give me an overview of the `RigidbodySleepMode2D` class in Unity.
RigidbodySleepMode2D enumeration Description Settings for a Rigidbody2D's initial sleep state. Properties Property Description NeverSleep Rigidbody2D never automatically sleeps. StartAwake Rigidbody2D is initially awake. StartAsleep Rigidbody2D is initially asleep.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbd4a2042847
unity_docs
animation
What is `Animator.rootPosition` in Unity? Explain its purpose and usage.
Animator.rootPosition public Vector3 rootPosition ; Description The root position, the position of the game object. You should only set this value from within an OnAnimatorIK() function call.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e4f8aad946ff
unity_docs
rendering
What is `Rendering.BatchRendererGroup.SetEnabledViewTypes` in Unity? Explain its purpose and usage.
BatchRendererGroup.SetEnabledViewTypes Declaration public void SetEnabledViewTypes (BatchCullingViewType[] viewTypes ); Parameters Parameter Description viewTypes The BatchCullingViewType array. Description Set the combination of BatchCullingViewType for which this BatchRendererGroup should receive a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bc5378ea0805
unity_docs
rendering
What is `CustomRenderTexture.EnsureDoubleBufferConsistency` in Unity? Explain its purpose and usage.
CustomRenderTexture.EnsureDoubleBufferConsistency Declaration public void EnsureDoubleBufferConsistency (); Description Updates the internal Render Texture that a Custom Render Texture uses for double buffering, so that it matches the size and format of the Custom Render Texture. Use this if you are implementi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4fcdcc243e2e
unity_docs
scripting
Show me a Unity C# example demonstrating `Compass.magneticHeading`.
Compass.magneticHeading public float magneticHeading ; Description The heading in degrees relative to the magnetic North Pole. (Read Only) The value in this property is always measured relative to the top of the screen in its current orientation. The heading of magnetic north is not exactly the same as true g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10f4b8c9ed57
unity_docs
ui
What is `UIElements.TreeView.destroyItem` in Unity? Explain its purpose and usage.
TreeView.destroyItem public Action<VisualElement> destroyItem ; Description Callback invoked when a VisualElement created via makeItem is no longer needed and will be destroyed. The method called by this callback receives the VisualElement that will be destroyed from the pool.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.