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_b55b1811def1
unity_docs
scripting
What is `Build.Reporting.PackedAssetInfo.sourceAssetPath` in Unity? Explain its purpose and usage.
PackedAssetInfo.sourceAssetPath public string sourceAssetPath ; Description The file path to the source Asset that the build process used to generate the package Asset, relative to the Project directory. Note: Some packed Assets might not have a source Asset, such as a Sprite Atlas that is generated at build ti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cba5bcd70129
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.RemoveFileFromBuild` in Unity?
Description Removes the given file from the list of files to build for the given target. ```csharp using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode;public class Sample_RemoveFileFromBuild { [PostProcessBuild] public static void OnPostprocessBuild(BuildTarget buildTa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f455c1b661a0
unity_docs
rendering
What is `TerrainTools.PaintContext.destinationRenderTexture` in Unity? Explain its purpose and usage.
PaintContext.destinationRenderTexture public RenderTexture destinationRenderTexture ; Description (Read Only) RenderTexture that an edit operation writes to modify the data. This RenderTexture stores the modified data represented by a PaintContext. A terrain tool will typically read from sourceRenderTextur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_637d36a0d305
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGBA_ASTC8X8_UFloat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGBA_ASTC8X8_UFloat Description A four-component, ASTC compressed format where each 128-bit compressed texel block encodes an 8×8 rectangle of float RGBA texel data.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_15b1fcced410
unity_docs
scripting
Show me a Unity code example for 'Move Light Probes at runtime'.
esForScene API instead if you need to read the positions of the Light Probes in a scene, but not move them. ## Example The following code moves the Light Probes in the current scene to a new position each frame. Attach the script to any object in a scene. When you run the project, select any object that uses Light Pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb278a065c55
unity_docs
math
What is `XR.Eyes.TryGetRightEyePosition` in Unity? Explain its purpose and usage.
Eyes.TryGetRightEyePosition Declaration public bool TryGetRightEyePosition (out Vector3 position ); Parameters Parameter Description positionOut A Vector3 struct to receive the right eye position. Returns bool true if eyes can be queried for the right eye position; otherwise false. Description Gets...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb818bc754b7
unity_docs
rendering
What is `GL` in Unity? Explain its purpose and usage.
GL class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Low-level graphics library. Use this class to manipulate active transformation matrices, issue rendering commands similar to OpenGL's immediate mode and do other low-level graphics tasks. Note that in almost all cases using Graphics.R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5420014ada46
unity_docs
animation
What is `Animations.AnimationHumanStream.SetGoalWeightRotation` in Unity? Explain its purpose and usage.
AnimationHumanStream.SetGoalWeightRotation Declaration public void SetGoalWeightRotation ( AvatarIKGoal index , float value ); Parameters Parameter Description index The AvatarIKGoal that is queried. value The rotation weight of the IK goal. Description Sets the rotation weight of the IK goal. Additio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_13fbba956ca4
github
scripting
Write a Unity C# script called Vector3Property
```csharp using UnityEngine; namespace LeakyAbstraction.ReactiveScriptables { [CreateAssetMenu(menuName = "Game Properties/Vector3 Property")] public class Vector3Property : GameProperty<Vector3> { } } ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_cd5b858d913c
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.GetComponentsInChildren`.
en call GetComponentsInChildren on that reference. Note : If the type you request is a derivative of MonoBehaviour and the associated script can't be loaded then this function will return null for that component. The following example gets a reference to all hinge joint components on the same GameObject as the scri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da82e10d371a
unity_docs
ui
What is `UIElements.ToolbarSearchField.cancelButtonOffVariantUssClassName` in Unity? Explain its purpose and usage.
ToolbarSearchField.cancelButtonOffVariantUssClassName public static string cancelButtonOffVariantUssClassName ; Description USS class name of cancel buttons in elements of this type, when they are off.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_22c48f0f93d7_doc_3
github
scripting
What does `Unregister` do in this Unity script? Explain its purpose and signature.
Unregister , so its update job is not scheduled anymore.Unregistering job provider objects is O(1).Unregistering an object that wasn't registered is a no-op. Signature: ```csharp public void Unregister(TDataProvider provider) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_e5327c566c12
unity_docs
math
Show me a Unity C# example demonstrating `Physics.BoxCast`.
. orientation Rotation of the box. maxDistance The max length of the cast. layerMask A Layer mask that is used to selectively ignore colliders when casting a capsule. queryTriggerInteraction Specifies whether this query should hit Triggers. Returns bool True, if any intersections were found. Descriptio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c6eb50b2934
unity_docs
rendering
What is `Rendering.GraphicsSettings.transparencySortMode` in Unity? Explain its purpose and usage.
GraphicsSettings.transparencySortMode public static TransparencySortMode transparencySortMode ; Description Transparent object sorting mode. This is the default TransparencySortMode that the rendering pipeline uses for all Cameras unless the settings are overridden for a specific Camera. Additional resourc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f329715f564e
unity_docs
physics
What is `ShaderKeywordFilter.ApplyRulesIfGraphicsAPIAttribute` in Unity? Explain its purpose and usage.
ApplyRulesIfGraphicsAPIAttribute class in UnityEditor.ShaderKeywordFilter / Inherits from: ShaderKeywordFilter.GraphicsAPIConstraintAttribute Description Enable or disable shader keyword filter attributes based on the graphics API. If you use this attribute, Unity enables filter attributes if the current buil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_260020d55668
unity_docs
ui
What is `iOS.SystemGestureDeferMode` in Unity? Explain its purpose and usage.
SystemGestureDeferMode enumeration Description Bit-mask used to control the deferring of system gestures on iOS. On iPhone X the home button is implemented as a system gesture (swipe up from the lower edge of the screen). Other gestures are implemented as swipes from other screen edges. Note, this may interfere wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a346f66d061
unity_docs
scripting
What is `Experimental.GraphView.PlacematContainer.Placemats` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PlacematContainer.Placemats public IEnumerable<Placemat> Placemats ; Description The enumeration of the placemats in this PlacematContainer.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b7fc0b36b51
unity_docs
physics
What is `Rendering.CommandBuffer.InvokeOnRenderObjectCallbacks` in Unity? Explain its purpose and usage.
CommandBuffer.InvokeOnRenderObjectCallbacks Declaration public void InvokeOnRenderObjectCallbacks (); Description Schedules an invocation of the OnRenderObject callback for MonoBehaviour scripts. This method triggers MonoBehaviour.OnRenderObject . Call this function to issue the OnRenderObject callback from yo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3efb3fa972d6
unity_docs
physics
What is `PhysicsVisualizationSettings.useContactFiltering` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.useContactFiltering public static bool useContactFiltering ; Description Whether PhysicsDebugWindow takes the PhysicsVisualizationSettings filtering settings into account when visualizing contacts. If you set this property to true, the PhysicsDebugWindow takes PhysicsVisualiz...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e78246df83c
unity_docs
scripting
What is `HumanDescription.lowerLegTwist` in Unity? Explain its purpose and usage.
HumanDescription.lowerLegTwist public float lowerLegTwist ; Description Defines how the lower leg's roll/twisting is distributed between the knee and ankle. When the lower leg needs to twist or roll based on IK, lowerLegTwist (a weighted range of 0..1) determines how much rotation is applied to the knee and a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c399312b18d8
unity_docs
scripting
What is `Search.SearchSettings.AddItemFavorite` in Unity? Explain its purpose and usage.
SearchSettings.AddItemFavorite Declaration public static void AddItemFavorite ( Search.SearchItem item ); Parameters Parameter Description item Item to be marked as a favorite. Description Mark a search item as a favorite. Favorite items always show up first in the search view. These items are assigned a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1d4fd27fb5f1
unity_docs
networking
Explain 'Diagnose network issues' in Unity.
Use the Unity Package Manager Diagnostics tool to help diagnose common network issues associated with Unity Package Manager. The Diagnostics tool runs some basic network tests and creates files that the Unity support team needs to diagnose common network problems. After you run the tool, you can share the results with ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56fabc7467ca
unity_docs
editor
What is `FileUtil.MoveFileOrDirectory` in Unity? Explain its purpose and usage.
FileUtil.MoveFileOrDirectory Declaration public static void MoveFileOrDirectory (string source , string dest ); Description Moves a file or a directory from a given path to another path. This function's path is relative to the project root folder but it can also accept absolute paths. All file separators shou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63947d3adb11
unity_docs
rendering
What is `CustomRenderTexture.initializationMaterial` in Unity? Explain its purpose and usage.
CustomRenderTexture.initializationMaterial public Material initializationMaterial ; Description The Material that Unity uses to initialize a Custom Render Texture. Initialization texture and color are ignored if you have set this parameter.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f11e4f844ad
unity_docs
math
What is `AndroidJNI.FromLongArray` in Unity? Explain its purpose and usage.
AndroidJNI.FromLongArray Declaration public static long[] FromLongArray (IntPtr array ); Description Converts a Java array of long to a managed array of System.Int64. Additional resources: AndroidJNI.GetFloatArrayElement , AndroidJNI.GetArrayLength .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2591a2257b91
unity_docs
editor
What is `MouseCursor.Pan` in Unity? Explain its purpose and usage.
MouseCursor.Pan Description Cursor with a dragging hand for pan. ```csharp //Create a folder and name it “Editor” if this doesn’t already exist //Put this script in the folder//This script creates a new menu (“Examples”) and a menu item (“Mouse Cursor”). Click on this option. This displays a small window that has a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7f45a86b4221
unity_docs
editor
In Unity's 'Profiling tools reference', what is 'Android' and how does it work?
Tool Description Android GPU Inspector A tool by Google for general Android GPU profiling. Streamline Performance Analyzer A tool by ARM to analyze devices with ARM CPUs. Arm Performance Studio A selection of tools by ARM to analyze Mali GPU devices. PVRTune A tool by Imagination Technologies for Imagination PowerVR GP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c232a29defe
unity_docs
networking
What is `Networking.DownloadHandler.GetData` in Unity? Explain its purpose and usage.
DownloadHandler.GetData Declaration protected byte[] GetData (); Returns byte[] Byte array to return as the value of the data property. Description Callback, invoked when the data property is accessed. The return value of this method will be returned as the value of the data property. This method will be ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85bc8bb86416
unity_docs
scripting
What is `AvatarBuilder.BuildGenericAvatar` in Unity? Explain its purpose and usage.
AvatarBuilder.BuildGenericAvatar Declaration public static Avatar BuildGenericAvatar ( GameObject go , string rootMotionTransformName ); Parameters Parameter Description go Root object of your transform hierarchy. rootMotionTransformName Transform name of the root motion transform. If empty no root mot...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5275330b4bff
unity_docs
physics
What is `BuoyancyEffector2D.surfaceLevel` in Unity? Explain its purpose and usage.
BuoyancyEffector2D.surfaceLevel public float surfaceLevel ; Description Defines an arbitrary horizontal line that represents the fluid surface level. The Collider2D used by the effector only defines the overall area of effect for the buoyancy forces, but not the actual surface level of the fluid. Any 2D colli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e53eede25361
unity_docs
rendering
What are the parameters of `Texture2D.GetPixels` in Unity?
Returns Color[] An array that contains the pixel colors. Description Gets the pixel color data for a mipmap level as Color structs. This method gets pixel data from the texture in CPU memory. Texture.isReadable must be true . The array contains the pixels row by row, starting at the bottom left of the texture. The size...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f8c8a61f9840
unity_docs
scripting
Explain 'Modify Gradle project files with Android Studio' in Unity.
If you don’t want to modify Gradle project files within Unity, you can export your Unity project as a Gradle project and manually modify the Gradle project files within Android Studio. From Android Studio, you can view and modify the final Gradle project files that Gradle uses to build your application. To modify Gradl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb3954dfc375
unity_docs
ui
What is `UIElements.VisualElement.contentContainer` in Unity? Explain its purpose and usage.
VisualElement.contentContainer public UIElements.VisualElement contentContainer ; Description Child elements are added to it, usually this is the same as the element itself. When iterating over the VisualElement.Children of an element, the element's content container hierarchy is used instead of the el...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac281d220285
unity_docs
scripting
Show me a Unity C# example demonstrating `Color.clear`.
Color.clear public static Color clear ; Description Completely transparent. RGBA is (0, 0, 0, 0). ```csharp //Attach this script to a GameObject with a Renderer (go to Create>3D Object and select one of the first 6 options to create a GameObject with a Renderer automatically attached). //This script changes t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5213fab73951
unity_docs
editor
What is `BuildAssetBundlesParameters` in Unity? Explain its purpose and usage.
BuildAssetBundlesParameters struct in UnityEditor Description Provide various options to control the behavior of BuildPipeline.BuildAssetBundles . Additional resources: BuildPipeline , EditorUserBuildSettings , EditorBuildSettings , BuildPlayerOptions Properties Property Description bundleDefinitions Arr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2399f6ab3892
unity_docs
scripting
In Unity's 'Warm up PSOs', what is 'Warm up a collection' and how does it work?
Once you’ve traced a PSO data collection , you can warm up the cached PSOs to disk. Note : The recommended best practice is to prewarm your collection during application or scene loading sequences. To warm up a PSO data collection, you can use two API methods: GraphicsStateCollection.WarmUp schedules the creation of al...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c55ff60c65a8
unity_docs
math
What is `ShaderUtil.GetShaderPlatformKeywordsForBuildTarget` in Unity? Explain its purpose and usage.
ShaderUtil.GetShaderPlatformKeywordsForBuildTarget Declaration public static BuiltinShaderDefine[] GetShaderPlatformKeywordsForBuildTarget ( Rendering.ShaderCompilerPlatform shaderCompilerPlatform , BuildTarget buildTarget , Rendering.GraphicsTier tier ); Declaration public static BuiltinShaderDefine[] G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b71fcc101f6f
unity_docs
scripting
Explain 'Search external sources' in Unity.
The external search providers search online for assets and packages. Provider Description Search the Unity Asset Store Finds assets in the Unity Asset Store . Search for packages Finds packages in the Unity Package Manager.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cf8f2a21c1b1
unity_docs
rendering
In Unity's 'Add a shader pass in a custom shader', what is 'Example' and how does it work?
This example code demonstrates the syntax for creating a Shader object that contains a single SubShader, which in turn contains a single Pass. ``` Shader "Examples/SinglePass" { SubShader { Pass { Name "ExamplePassName" Tags { "ExampleTagKey" = "ExampleTagValue" } // ShaderLab commands go here. // HLSL code ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e63c487b611a
unity_docs
math
Show me a Unity C# example demonstrating `SerializedProperty.Next`.
the properties of that referenced object. One way to visit a referenced object is to retrieve the object with SerializedProperty.objectReferenceValue and construct a new SerializedObject instance for that target. If there are no further properties in the SerializedObject, this method will return false, and the Serial...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_801554d8e15f
unity_docs
scripting
What is `TerrainData.treePrototypes` in Unity? Explain its purpose and usage.
TerrainData.treePrototypes public TreePrototype[] treePrototypes ; Description The list of TreePrototype s available in the inspector. If you change any value here, you should call TerrainData.RefreshPrototypes so the changes take effect.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ff6d49dd2ec
unity_docs
rendering
What is `Build.Content.ContentBuildInterface.GetGlobalUsageFromActiveScene` in Unity? Explain its purpose and usage.
ContentBuildInterface.GetGlobalUsageFromActiveScene Declaration public static Build.Content.BuildUsageTagGlobal GetGlobalUsageFromActiveScene ( BuildTarget target ); Parameters Parameter Description target The target platform. Returns BuildUsageTagGlobal An object containing the lighting and fog setti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac834b4ad303
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.BaseAttributesContainer` in Unity? Explain its purpose and usage.
BaseAttributesContainer class in Unity.Android.Gradle.Manifest / Implemented in: Unity.Android.Gradle Description The base attributes container for all elements. Properties Property Description ToolsNode The C# definition of the tools:node Android Manifest attribute. ToolsRemove The C# definition of the too...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4f2b5e10d3cd
unity_docs
rendering
What is `RenderTextureFormat.ARGB64` in Unity? Explain its purpose and usage.
RenderTextureFormat.ARGB64 Description Four color render texture format, 16 bits per channel, fixed point, unsigned normalized. Note that not all graphics cards support this format. Use SystemInfo.SupportsRenderTextureFormat to check for support. Additional resources: RenderTexture class, SystemInfo.SupportsRe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_749192535ee6
unity_docs
scripting
Show me a Unity C# example demonstrating `AudioType`.
.ogg, AudioType.OGGVORBIS)); . The format types in this enumeration are the types Unity supports natively. For other or unknown format types, use AudioType.UNKNOWN , but note that Unity might not support them. If you use the wrong format, the audio might not play correctly and Unity might throw an error. Additional ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2f9bd38a65f7
unity_docs
rendering
Give me an overview of the `ParticleSystemCurveMode` class in Unity.
ParticleSystemCurveMode enumeration Description The particle curve mode. This is used by MinMaxCurve to determine which mode to evaluate curves in. Properties Property Description Constant Use a single constant for the MinMaxCurve. Curve Use a single curve for the MinMaxCurve. TwoCurves Use a random value ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c89464fdd2d
unity_docs
editor
What is `Device.SystemInfo.supportsAnisotropicFilter` in Unity? Explain its purpose and usage.
SystemInfo.supportsAnisotropicFilter public static bool supportsAnisotropicFilter ; Description This has the same functionality as SystemInfo.supportsAnisotropicFilter 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_2bb17a37bf5e
unity_docs
scripting
What is `SearchService.ProjectSearch.EngineScope` in Unity? Explain its purpose and usage.
ProjectSearch.EngineScope public static SearchService.SearchEngineScope EngineScope ; Description A enum that indicates the search scope for ProjectSearch engines. It is used by ProjectSearchContext . Additional resources: ISearchContext.engineScope .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_631922c40522_doc_12
github
scripting
What does `LoadAsyncUniTask` do in this Unity script? Explain its purpose and signature.
Load the asset asynchronously with UniTask and cancellation token. Signature: ```csharp public UniTask<T> LoadAsyncUniTask(CancellationToken cancellationToken) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_957dd01cb725
unity_docs
rendering
What is `TextureImporterPlatformSettings.overridden` in Unity? Explain its purpose and usage.
TextureImporterPlatformSettings.overridden public bool overridden ; Description Set to true in order to override the Default platform parameters by those provided in the TextureImporterPlatformSettings structure.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95247383aef3
unity_docs
rendering
Give me an overview of the `QualitySettings` class in Unity.
QualitySettings class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description This represents the script interface for Quality Settings . Use the QualitySettings class to change the current quality level at runtime. You can check the details of quality settings in your...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b458d30cef6
unity_docs
rendering
Show me a Unity C# example demonstrating `Media.H264EncoderAttributes`.
H264EncoderAttributes struct in UnityEditor.Media Description Descriptor for H.264 encoder attributes. ```csharp using UnityEditor.Media; using UnityEngine; using UnityEditor; using Unity.Collections; using System.IO;public class Recorder { static public void RecordMovie() { H264EncoderAttributes h264Attr = ne...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2b272970dc41
unity_docs
animation
What is `Animator.deltaRotation` in Unity? Explain its purpose and usage.
Animator.deltaRotation public Quaternion deltaRotation ; Description Gets the avatar delta rotation for the last evaluated frame. Animator.applyRootMotion must be enabled for deltaRotation to be calculated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d13e3a1dd68
unity_docs
physics
Show me a Unity C# example demonstrating `HingeJoint.spring`.
the target position faster. The JointSpring.damper force dampens the angular velocity. A larger value makes the spring reach the goal slower. The spring reaches for the JointSpring.targetPosition angle in degrees relative to the rest angle. The rest angle between the bodies is always zero at the beginning of the si...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f516f5b2055
unity_docs
physics
What is `CapsulecastCommand.ScheduleBatch` in Unity? Explain its purpose and usage.
CapsulecastCommand.ScheduleBatch Declaration public static Unity.Jobs.JobHandle ScheduleBatch (NativeArray<CapsulecastCommand> commands , NativeArray<RaycastHit> results , int minCommandsPerJob , int maxHits , Unity.Jobs.JobHandle dependsOn ); Parameters Parameter Description commands A NaviveArray o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bbb9a03964bc
unity_docs
scripting
What is `UIElements.TimerState` in Unity? Explain its purpose and usage.
TimerState struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Contains timing information of scheduler events. Properties Property Description deltaTime Time difference in milliseconds between now and the previous callback. now Current time in milliseconds. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fd8f8af43159
unity_docs
ui
Explain 'Web template structure and instantiation' in Unity.
Use custom user variables in a template’s index.html file and create a new instance of your content with createUnityInstance() . For information about template variables, JavaScript macros, and conditional directives, refer to Web template variables . To add a custom Web template, refer to Add a custom Web template . ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_945b8868f58b
github
scripting
Write a Unity C# script called Application Utils
```csharp using UnityEngine; namespace Gilzoide.UpdateManager { public static class ApplicationUtils { public static bool IsQuitting { get; private set; } [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.SubsystemRegistration)] private static void InitializeMethod() { ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_091103df3d2d
unity_docs
xr
Show me a Unity C# example demonstrating `Search.SearchService`.
SearchService class in UnityEditor.Search Description Principal Search API to initiate searches and fetch results. Make sure to check SearchService.Request for a complete list of all the different ways to execute a search request. ```csharp using System.Linq; using System.Collections.Generic; using UnityEditor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8b0bd9e3d69
unity_docs
scripting
What is `GenericMenu.DropDown` in Unity? Explain its purpose and usage.
GenericMenu.DropDown Declaration public void DropDown ( Rect position ); Parameters Parameter Description position The position at which to show the menu. Description Show the menu at the given screen rect. Additional resources: GenericMenu.ShowAsContext .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_536acd2cca5d
unity_docs
physics
Show me a Unity C# example demonstrating `PhysicsMaterial.ctor`.
PhysicsMaterial Constructor Declaration public PhysicsMaterial (); Description Creates a new material. Note that although this function lets you create a new physics material from a script, it is generally easier to create and assign the material from the editor. ```csharp using UnityEngine;public class Examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1d77bfbb123
unity_docs
rendering
What is `ParticleSystemBakeMeshOptions` in Unity? Explain its purpose and usage.
ParticleSystemBakeMeshOptions enumeration Description Configure how a Particle System is baked into a mesh. Properties Property Description BakeRotationAndScale Bake the Transform rotation and scale into the mesh. BakePosition Bake the Transform position into the mesh. Default The default baking options.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c300c2390e7
unity_docs
physics
What is `CollisionDetectionMode.Continuous` in Unity? Explain its purpose and usage.
CollisionDetectionMode.Continuous Description Continuous collision detection is on for colliding with static mesh geometry. Collisions will be detected for any static mesh geometry in the path of this Rigidbody, even if the collision occurs between two FixedUpdate steps. Static mesh geometry is any MeshCollider whi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abb80f0497c8
unity_docs
scripting
What is `PlayerSettings.useHDRDisplay` in Unity? Explain its purpose and usage.
PlayerSettings.useHDRDisplay public static bool useHDRDisplay ; Description Switch the main display to HDR mode (if available). Enabling this setting will also enable PlayerSettings.allowHDRDisplaySupport to make sure all the resources required for using HDR Displays are included in the build. Additional res...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69862503c8c6
unity_docs
input
What is `UIElements.KeyDownEvent` in Unity? Explain its purpose and usage.
KeyDownEvent class in UnityEngine.UIElements / Inherits from: UIElements.KeyboardEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description This event is sent when a key is pressed. This event trickles down and bubbles up. Inherited Members Properties Property Description bubbles Return...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78ff766b8cf9
unity_docs
scripting
What is `Unity.Properties.TypeTraits` in Unity? Explain its purpose and usage.
TypeTraits class in Unity.Properties / Implemented in: UnityEngine.PropertiesModule Description Helper class to avoid paying the cost of runtime type lookups. Static Methods Method Description IsContainer Returns true if the given type can be treated as a container. i.e. not primitive, pointer, enum or ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0cf3a0136235
unity_docs
editor
What is `UIElements.AssetMonitoringUtilities` in Unity? Explain its purpose and usage.
AssetMonitoringUtilities class in UnityEditor.UIElements Description Utility that manages asset monitoring features of UI Toolkit panels. Static Methods Method Description GetResetPanelRenderingOnAssetChange Gets the state that controls if the panel of the EditorWindow should reset its rendering data when an a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a84e2cbdea79
unity_docs
scripting
In Unity's 'Custom Unity Editor tools', what is 'Global tools' and how does it work?
A global tool affects any GameObject. A global tool is always available regardless of the type of GameObject you select. For example, you can always access a Transform tool because the Transform tool works with any GameObject. The Tools overlay displays global tools in the section after the built-in Transform tools, su...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_664370d31da4
unity_docs
physics
Give me an overview of the `RigidbodyType2D` class in Unity.
RigidbodyType2D enumeration Description The physical behaviour type of the Rigidbody2D . Controls the physical behaviour of a Rigidbody2D in how it should move, react to forces and interact with the rest of the physics simulation. Additional resources: Rigidbody2D.bodyType . Properties Property Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c4f8fa71198
unity_docs
rendering
What is `LightTransport.PostProcessing.RadeonRaysProbePostProcessor.WindowSphericalHarmonicsL2` in Unity? Explain its purpose and usage.
RadeonRaysProbePostProcessor.WindowSphericalHarmonicsL2 Declaration public bool WindowSphericalHarmonicsL2 ( LightTransport.IDeviceContext context , BufferSlice<SphericalHarmonicsL2> shIn , BufferSlice<SphericalHarmonicsL2> shOut , int probeCount ); Parameters Parameter Description context Device context...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3bb181c66b36
unity_docs
xr
Explain 'XR Origin' in Unity.
The XR Origin serves as the center of tracking space in an XR scene . An XR Origin is a set of GameObjects and components that work together to transform XR tracking data into the scene world space. The following topics discuss the XR Origin and how to use it in your project: Topic Description XR tracking space Describ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16497a4165de
unity_docs
rendering
What is `Rendering.ShaderCompilerMessageSeverity` in Unity? Explain its purpose and usage.
ShaderCompilerMessageSeverity enumeration Description Indicates the severity of a message returned by the Unity Shader Compiler. Used in the ShaderMessage class. Properties Property Description Error Indicates that a message returned by the Unity Shader Compiler is an error and the compilation failed. Warni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_955902a54b4b
unity_docs
scripting
What is `Vector3.Index_operator` in Unity? Explain its purpose and usage.
Vector3.this[int] public float this[int] ; Description Access the x, y, z components using [0], [1], [2] respectively. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public Vector3 p; void Example() { // set p.y as 5.0f p[1] = 5.0f; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c1fae5f432a4
github
scripting
Write a Unity C# UI script for Vertex Shake A
```csharp using UnityEngine; using System.Collections; namespace TMPro.Examples { public class VertexShakeA : MonoBehaviour { public float AngleMultiplier = 1.0f; public float SpeedMultiplier = 1.0f; public float ScaleMultiplier = 1.0f; public float RotationMultiplier = 1.0f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9dbcd0acebe2
unity_docs
scripting
What is `Overlays.Overlay.displayedChanged` in Unity? Explain its purpose and usage.
Overlay.displayedChanged Parameters Parameter Description value A callback accepting the new diplayed state of this overlay. Description This callback is invoked when the Overlay.displayed value has been changed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1069fa757d87
unity_docs
input
What is `TouchScreenKeyboard.selection` in Unity? Explain its purpose and usage.
TouchScreenKeyboard.selection public RangeInt selection ; Description Gets or sets the character range of the selected text within the string currently being edited. For example: if the keyboard is editing a text "abcdef" and the "cde" substring is selected, the return value is a RangeInt with the RangeI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d44c0171d92b
unity_docs
scripting
What is `ScriptableObject.OnDestroy` in Unity? Explain its purpose and usage.
ScriptableObject.OnDestroy() Description This function is called when the scriptable object will be destroyed. An example is given below. This example has two scripts. The first shown is the ScriptableObject script. This implements code which is separate from MonoBehaviour . The second is a small MonoBehaviour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4705d3813e12
unity_docs
animation
Give me an overview of the `PlayMode` class in Unity.
PlayMode enumeration Description Used by Animation.Play function. Properties Property Description StopSameLayer Will stop all animations that were started in the same layer. This is the default when playing animations. StopAll Will stop all animations that were started with this component before playing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86b9033563f7
unity_docs
scripting
What is `Unity.Hierarchy.HierarchyCommandList` in Unity? Explain its purpose and usage.
HierarchyCommandList class in Unity.Hierarchy / Implemented in: UnityEngine.HierarchyCoreModule Description Represents a list of commands that modify a hierarchy. Properties Property Description Capacity The capacity in bytes for storing commands in the command list. IsCreated Determines if this ob...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e370cb8af42
unity_docs
scripting
What is `AwaitableCompletionSource` in Unity? Explain its purpose and usage.
AwaitableCompletionSource class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Objects allowing to control completion of an Awaitable object from user code. Properties Property Description Awaitable Get the awaitable controlled by the completion source. Public Methods Method Descripti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d480738ffe83
github
scripting
Write a Unity C# ScriptableObject for Curve Data
```csharp namespace CurvePickerTool.Samples { using UnityEngine; [CreateAssetMenu] public class CurveData : ScriptableObject { [SerializeField] private CurvePicker curvePicker1 = new CurvePicker(4); [SerializeField] private CurvePicker curvePicker2 = new CurvePicker(6); [Serial...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_47e6a0189e64
unity_docs
scripting
Explain 'Programming with gizmos and handles' in Unity.
The Gizmos and Handles classes allow you to draw lines and shapes in the Scene view and Game view, as well as interactive handles and controls. These two classes together provide a way for you to extend what is shown in these views and build interactive tools to edit your project in any way you like. For example, rathe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a78fc79e0a50
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.GetComponentAtIndex`.
d index of the GameObject's array of components. Using GetComponentAtIndex is a stable way to access components on a GameObject because the index of a component stays the same unless components are added or removed. An example use case for this is during UI development. This method throws an exception if the index i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57de7253bb06
unity_docs
editor
Show me a Unity C# example demonstrating `Time.realtimeSinceStartupAsDouble`.
ome zero). On desktop, web, XR, and mobile platforms, the returned value includes time that elapsed while the system is in sleep mode. On console platforms, this behavior differs. For more information, refer to the platform-specific documentation. NOTE: There is a known issue where realtimeSinceStartup and r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5da269038ea4
unity_docs
scripting
Explain 'Introduction to Unity Building Blocks' in Unity.
Unity Building Blocks are a starting point to quickly add functional features to your project. Each Building Block contains assets and scripts that give you an example of how a series of features work to achieve an outcome. You can download Building Blocks from the Asset Store . You can add a Building Block to your pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e3b282cb700e
unity_docs
xr
In Unity's 'Submit a license request from a command line and browser (Windows)', what is 'Before you begin' and how does it work?
See Manual license activation to make sure you understand the scenario for using this procedure, its limitations, and its internet connectivity requirements. Make sure you know the path where you installed the Unity Editor. Use the Unity Hub to determine the path. Open the Unity Hub and select Installs from the side me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c7bd26a9337
unity_docs
editor
What is `EditorGUILayout.ScrollViewScope.ctor` in Unity? Explain its purpose and usage.
EditorGUILayout.ScrollViewScope Constructor Declaration public EditorGUILayout.ScrollViewScope ( Vector2 scrollPosition , params GUILayoutOption[] options ); Declaration public EditorGUILayout.ScrollViewScope ( Vector2 scrollPosition , bool alwaysShowHorizontal , bool alwaysShowVertical , params GUILayout...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fba50bf8d023
unity_docs
rendering
In Unity's 'Get the current framebuffer with the GrabPass command in the Built-In Render Pipeline', what is 'Provide fragment color as input' and how does it work?
Some GPUs (most notably PowerVR-based ones on iOS) allow you to do a form of programmable blending by providing current fragment color as input to the Fragment Shader (refer to EXT_shader_framebuffer_fetch on khronos.org ). This process is sometimes called framebuffer fetch. To do this, use the inout color argument whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_029e169d5b56
unity_docs
scripting
What is `UIElements.HelpBox.ctor` in Unity? Explain its purpose and usage.
HelpBox Constructor Declaration public HelpBox (); Description Creates a new HelpBox. Declaration public HelpBox (string text , UIElements.HelpBoxMessageType messageType ); Parameters Parameter Description text The message text. messageType The type of message. Description Creates a new Help...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2f737deae3e
unity_docs
scripting
What is `SceneVisibilityManager.IsPickingDisabled` in Unity? Explain its purpose and usage.
SceneVisibilityManager.IsPickingDisabled Declaration public bool IsPickingDisabled ( GameObject gameObject , bool includeDescendants ); Parameters Parameter Description gameObject GameObject to check. includeDescendants Specify true to check the GameObject and all its descendants. Set to false to check t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4ea561bc1897
unity_docs
ui
In Unity's 'Import and preview video clips', what is 'Preview your video clip' and how does it work?
To preview your video clip in Unity: Select the video clip to open the Inspector window. Go to the preview pane at the bottom of the Inspector window. Click the Play button in the top-right corner of the preview pane. After you click the Play button, a preview of the video clip and its first audio track plays.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7192fc659d2
unity_docs
scripting
What is `Build.Content.ContentBuildInterface.GetPlayerObjectIdentifiersInSerializedFile` in Unity? Explain its purpose and usage.
ContentBuildInterface.GetPlayerObjectIdentifiersInSerializedFile Declaration public static ObjectIdentifier[] GetPlayerObjectIdentifiersInSerializedFile (string filePath , BuildTarget target ); Description Returns a list of objects directly contained inside of a loose serialized file. Internal use only. See...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2405edc774a9
unity_docs
math
What is `Snapping.Snap` in Unity? Explain its purpose and usage.
Snapping.Snap Declaration public static float Snap (float val , float snap ); Parameters Parameter Description val The value to round. snap The increment to round to. Returns float The rounded value. Description Rounds value to the closest multiple of snap . Declaration public static Vector2 ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29e7c0f6596a
unity_docs
scripting
What is `DragAndDrop.visualMode` in Unity? Explain its purpose and usage.
DragAndDrop.visualMode public static DragAndDropVisualMode visualMode ; Description The visual indication of the drag. Default is DragAndDropVisualMode.Link . ```csharp using UnityEngine; using UnityEditor;public class Example : MonoBehaviour { void OnGUI() { EventType eventType = Event.current.type; if...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b763f15ea1d6
unity_docs
rendering
What is `QualitySettings.pixelLightCount` in Unity? Explain its purpose and usage.
QualitySettings.pixelLightCount public static int pixelLightCount ; Description The maximum number of pixel lights that should affect any object. If there are more lights illuminating an object, the dimmest ones will be rendered as vertex lights. Use this from scripting if you want to have finer control than o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a88b9830d64d
unity_docs
xr
What are the parameters of `RenderTexture.GetTemporary` in Unity?
Description Allocate a temporary render texture. This function is optimized for when you need a quick RenderTexture to do some temporary calculations. Release it using ReleaseTemporary as soon as you're done with it, so another call can start reusing it if needed. Internally Unity keeps a pool of temporary render textu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3e15bbc2f99e
unity_docs
rendering
Explain 'Sample a 3D texture in a shader' in Unity.
To use a 3D texture in a custom shader , you can use the following: The 3D material property declaration to add a 3D texture property. For example _MainTex ("Example 3D texture", 3D) = "white" {}; The sampler3D sampler state to use the 3D texture as a shader input. For example sampler3D _MainTex; The tex3D HLSL method ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9aa9f9f5004e
unity_docs
rendering
Explain 'Set the depth testing mode in a shader' in Unity.
Depth testing allows GPUs that have “Early-Z” functionality to reject geometry early in the pipeline, and also ensures correct ordering of the geometry. You can change the conditions of depth testing to achieve visual effects such as object occlusion. ## Examples This example code demonstrates the syntax for using th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4cdbed9e350e
unity_docs
audio
Explain 'Audio in Web' in Unity.
This page only provides information about audio capabilities in the Web platform. To learn how to use audio in your Unity project, refer to Audio Overview . Because Unity uses FMOD to manage audio for platforms, the Web platform supports limited audio functionality, which only includes the basic features. FMOD relies o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc017daa3689
unity_docs
rendering
What is `ShaderUtil.GetComputeShaderMessages` in Unity? Explain its purpose and usage.
ShaderUtil.GetComputeShaderMessages Declaration public static ShaderMessage[] GetComputeShaderMessages ( ComputeShader s ); Parameters Parameter Description s The ComputeShader instance to check for messages. Returns ShaderMessage[] An array of ShaderMessage structs containing the generated messages...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.