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_d9e7287565a4
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUI.LayerField`.
abel , int layer , GUIStyle style = EditorStyles.popup); Parameters Parameter Description position Rectangle on the screen to use for the field. label Optional label in front of the field. layer The layer shown in the field. style Optional GUIStyle . Returns int The layer selected by the user. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c372f42b836b
unity_docs
performance
What is `Unity.Jobs.JobHandle.CombineDependencies` in Unity? Explain its purpose and usage.
JobHandle.CombineDependencies Declaration public static Unity.Jobs.JobHandle CombineDependencies ( Unity.Jobs.JobHandle job0 , Unity.Jobs.JobHandle job1 ); Declaration public static Unity.Jobs.JobHandle CombineDependencies ( Unity.Jobs.JobHandle job0 , Unity.Jobs.JobHandle job1 , Unity.Jobs.JobHan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4459c28cbbba
unity_docs
scripting
What is `TreePrototype.navMeshLod` in Unity? Explain its purpose and usage.
TreePrototype.navMeshLod public int navMeshLod ; Description The LOD index of a Tree LODGroup that Unity uses to generate a NavMesh. It uses this value only for Trees with a LODGroup, and ignores this value for regular Trees.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b6ba60008ea0
unity_docs
editor
Explain 'Set up the Android SDK Target API' in Unity.
Configure the Android SDK Target API level for your application. The Unity Hub installs the latest version of the Android SDK Target API that Google Play requires. If you need to use a more recent version, you can change it in the Android Player Settings . ## Configure Target API version To configure the Android SDK ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ef6d333f0f93
unity_docs
rendering
In Unity's 'Create a shader variant collection', what is 'Prewarm a shader variant collection' and how does it work?
To avoid visible stalls at performance-intensive times, Unity can ask the graphics driver to create GPU representations of shader variants before they are first needed. This is called prewarming . For more information on prewarming the shader variants in a shader variant collection, see Shader loading: Prewarming shade...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b0be290258e7
unity_docs
scripting
In Unity's 'Create and manage build profiles', what is 'Manage build profiles' and how does it work?
To manage build profiles, right-click on any build profile name. These options allow you to do the following: Copy to a new build profile. Rename a build profile. Delete a build profile. Note : There are no limits to how many build profiles you can have in a project.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b45a7d6c4418
unity_docs
animation
What is `UIElements.IStyle` in Unity? Explain its purpose and usage.
IStyle interface in UnityEngine.UIElements Description This interface provides access to a VisualElement inline style data. Reading properties from this object will read from the inline style data for this element. To read the style data computed for the element use IComputedStyle interface. Writing to a pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20535e44c0ee
unity_docs
editor
Show me a Unity C# example demonstrating `AssetImporters.AssetImportContext.DependsOnArtifact`.
t that has been marked as a dependency, all Assets which depend on it will also get reimported (after the dependency has been imported). Note: If you specify an Asset as a dependency that doesn't exist or hasn't yet been imported, the dependency is still registered. It is registered as an un-imported Asset. When the As...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb246f6b93df
unity_docs
scripting
What is `UIElements.UxmlFloatAttributeDescription.TryGetValueFromBag` in Unity? Explain its purpose and usage.
UxmlFloatAttributeDescription.TryGetValueFromBag Declaration public bool TryGetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc , ref float value ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. value The va...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e86ebf2b0978_doc_9
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Releases all objects in the MonoBehaviour-based pool.The type of MonoBehaviour objects to release. Signature: ```csharp public void ReleaseAllMono<T>() where T : MonoBehaviour, IPoolable => GetPool<MonoPool<T>, T>(_monoPools).ReleaseAll(); ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_d2b17f7e1f38
unity_docs
scripting
In Unity's 'Create a native plug-in for iOS', what is 'Define an extern method' and how does it work?
For each native function you want to call, define an extern method in the C# file as follows: ``` [DllImport ("__Internal")] private static extern float FooPluginFunction(); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61cf0934789e
unity_docs
rendering
Give me an overview of the `PropertyName` class in Unity.
PropertyName struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Represents a string as an int for efficient lookup and comparison. Use this for common PropertyNames. Internally stores just an int to represent the string. A PropertyName can be created from a string but can not be converted...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f4192f56be5
unity_docs
scripting
What is `Windows.Speech.SpeechSystemStatus` in Unity? Explain its purpose and usage.
SpeechSystemStatus enumeration Description Represents the current status of the speech recognition system or a dictation recognizer. Properties Property Description Stopped Speech recognition system is stopped. Running Speech recognition system is running. Failed Speech recognition system has encountered an e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_582940a326bc
unity_docs
ui
What is `DeviceOrientation` in Unity? Explain its purpose and usage.
DeviceOrientation enumeration Description Describes physical orientation of the device as determined by the OS. If device is physically situated between discrete positions, as when (for example) rotated diagonally, system will report Unknown orientation. Properties Property Description Unknown The orientation ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0bfeb43a22fd
unity_docs
editor
In Unity's 'AssetBundle and Addressables determinism', what is 'Editor automation scripts' and how does it work?
If your project uses Editor automation, such as custom scripts that automatically assign assets to Addressable groups, ensure the following: The order of assigned Addressables and Addressable groups are deterministic. Each build environment has identical Addressable Asset Settings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d28a55e2f7c0
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.minParticleSize`.
ParticleSystemRenderer.minParticleSize public float minParticleSize ; Description Clamp the minimum particle size. Tiny particles can cause aliasing, and not contribute visually to the Scene, whilst still negatively affecting performance. Use this setting to make sure they always maintain a minimum size on scre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9280c2e698e8
unity_docs
scripting
What is `Search.IQueryEngineFilter.SetNestedQueryTransformer` in Unity? Explain its purpose and usage.
IQueryEngineFilter.SetNestedQueryTransformer Declaration public void SetNestedQueryTransformer (Func<TNestedQueryData,TRhs> transformer ); Parameters Parameter Description transformer The transformer function. Description Sets the filter's nested query transformer function. This function takes the result o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_275541adedb6
unity_docs
rendering
What is `Light.useBoundingSphereOverride` in Unity? Explain its purpose and usage.
Light.useBoundingSphereOverride public bool useBoundingSphereOverride ; Description Set to true to override light bounding sphere for culling. Additional resources: Light.boundingSphereOverride .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5274e1f75469
unity_docs
physics
What is `MPE.ProcessService` in Unity? Explain its purpose and usage.
ProcessService class in UnityEditor.MPE Description *This is an experimental feature.* The ProcessService allows you to start slave instance of UnityEditor, opened to the same Project as the master instance, with a specific RoleProviderAttribute . The Standalone Profiler workflow uses this technology. Static Pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_644eff443b80
unity_docs
scripting
What is `Handles.DrawPolyLine` in Unity? Explain its purpose and usage.
Handles.DrawPolyLine Declaration public static void DrawPolyLine (params Vector3[] points ); Description Draw a line going through the list of points . Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. PolyLine that connects all the objects in the Scene View...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0579f4477ed
unity_docs
scripting
What is `ParticleSystem.MainModule.stopAction` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.stopAction public ParticleSystemStopAction stopAction ; Description Select whether to Disable or Destroy the GameObject, or to call the MonoBehaviour.OnParticleSystemStopped script Callback, when the Particle System stops and all particles have died. ```csharp using UnityEngine; u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d445f52b3a86
unity_docs
editor
Give me an overview of the `CacheServerValidationMode` class in Unity.
CacheServerValidationMode enumeration Description Options for the accelerate server validation mode. Use this enum with EditorSettings.cacheServerValidationMode to select the Accelerator server validation mode for the project. Used in conjunction with the Accelerator server Accelerator server settings Protobuf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_053ccd976903
unity_docs
ui
What is `UIElements.BaseSlider_1.showInputField` in Unity? Explain its purpose and usage.
BaseSlider<T0>.showInputField public bool showInputField ; Description The visibility of the optional field inside the slider control. Set this property to true to display a numerical text field that provides another way to edit the slider value.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_247e37284b33
unity_docs
scripting
What is `ParticleSystem.ShapeModule.alignToDirection` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.alignToDirection public bool alignToDirection ; Description Align particles based on their initial direction of travel. The Shape Module supports setting the initial rotation of particles based on their direction of travel. This can be useful to make particles appear to have originat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_adfd3d15a64e
unity_docs
scripting
What is `Handles.matrix` in Unity? Explain its purpose and usage.
Handles.matrix public static Matrix4x4 matrix ; Description Matrix for all handle operations. This is used by functions in HandleUtility and Handles to transform controls. To make all Handle routines work in the local coordinate space of a GameObject, set this to Transform.localToWorldMatrix . The handle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb76400b5810
unity_docs
xr
What is `PackageManager.Requests.AddAndRemoveRequest` in Unity? Explain its purpose and usage.
AddAndRemoveRequest class in UnityEditor.PackageManager.Requests / Inherits from: PackageManager.Requests.Request_1 Description Represents an asynchronous request to add package dependencies to the project and/or remove package dependencies from the project. The PackageManager Client class returns an AddAndR...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f0a8a0c387e
unity_docs
editor
What is `VersionControl.Provider.IncomingChangeSetAssets` in Unity? Explain its purpose and usage.
Provider.IncomingChangeSetAssets Declaration public static VersionControl.Task IncomingChangeSetAssets ( VersionControl.ChangeSet changeset ); Declaration public static VersionControl.Task IncomingChangeSetAssets (string changesetID ); Parameters Parameter Description changeset Incoming changeset. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b32eef7a3d86
unity_docs
scripting
What is `AI.NavMesh.RemoveAllNavMeshData` in Unity? Explain its purpose and usage.
NavMesh.RemoveAllNavMeshData Declaration public static void RemoveAllNavMeshData (); Description Removes all NavMesh surfaces and links from the game. Unloads all surfaces and links that have been loaded from the Scene or added with AddNavMeshData or AddLink and frees all the internal resources associated w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80db3d05b29d
unity_docs
rendering
What is `LightTransport.BakeProgressState.Progress` in Unity? Explain its purpose and usage.
BakeProgressState.Progress Declaration public float Progress (); Returns float Progress value in the range [0;1]. Description Get the progress value. Returns the current progress as a value between 0.0 and 1.0, where: 0.0 means no progress (operation just started). Values increase according to the rate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3f629beb6fbc_doc_8
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Searches through the specified search scope until a component of type T is foundand assigns it to the passed variable reference if and only iff the variable hasnothing assigned to it yet. Throws an exception if nothing could be found.A reference to the variable to be set if unset so far.Optional search scope if the obj...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_a486cf8d0f37
unity_docs
scripting
What is `InteractionMode.UserAction` in Unity? Explain its purpose and usage.
InteractionMode.UserAction Description Use this setting to allow a method to show dialog boxes to the user, and to allow it to record to the undo history. You can only use this setting with methods that accept an InteractionMode parameter.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41cee27c5fba
unity_docs
scripting
What are the parameters of `Assertions.Assert.IsNotNull` in Unity?
Description Assert that the value is not null. ```csharp using UnityEngine; using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour { MyClass myClassReference; void Update() { // Make sure the myClassReference reference is set Assert.IsNotNull(myClassReference); } ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_72b22ebfc215
unity_docs
xr
Explain 'AssetBundle compression formats' in Unity.
AssetBundle files are an archive format that contains the following structures: A small header data structure. This is never compressed. A content section containing its virtual files, which you can optionally compress. You can compress AssetBundle files in the following formats: Full file LZMA compression . Chunk-base...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbabde2c6369
unity_docs
xr
What is `AssetBundle.LoadAllAssetsAsync` in Unity? Explain its purpose and usage.
AssetBundle.LoadAllAssetsAsync Declaration public AssetBundleRequest LoadAllAssetsAsync (); Declaration public AssetBundleRequest LoadAllAssetsAsync (Type type ); Declaration public AssetBundleRequest LoadAllAssetsAsync (); Parameters Parameter Description type When specified only main or visib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dd80cda1dcd0
unity_docs
scripting
In Unity's 'API updater', what is 'Using the API updater' and how does it work?
When a script compilation is triggered, the API updater runs automatically. For example, this occurs when you: Open a project. Import a package. Save changes to a script. The API updater offers to update any obsolete code that it detects. If you accept, it rewrites any obsolete code with the recommended updated version...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_62e1fce2826d
unity_docs
rendering
What is `LightmapEditorSettings` in Unity? Explain its purpose and usage.
LightmapEditorSettings class in UnityEditor Description This class is now obsolete. Use LightingSettings . The bake can be started via Lightmapping class. Additional resources: Lightmapping . Static Properties Property Description reflectionCubemapCompression Determines how Unity will compress baked refle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c37d272e37ab
unity_docs
scripting
What is `Animations.PropertyStreamHandle` in Unity? Explain its purpose and usage.
PropertyStreamHandle struct in UnityEngine.Animations / Implemented in: UnityEngine.AnimationModule Description Handle for a Component property on an object in the AnimationStream . ```csharp using UnityEngine; using UnityEngine.Playables; using UnityEngine.Animations;public struct PropertyStreamHandleJob : ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_31498a359df8
unity_docs
editor
In Unity's 'Create variations of prefabs', what is 'Edit a prefab variant' and how does it work?
When you open a prefab variant in prefab editing mode , the root of the variant appears as a prefab instance which represents the base prefab that the variant inherits from. Any edits you make to the prefab variant override this base prefab. You can also use overrides to modify property values, add or remove components...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ff9ff071611b
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.mesh`.
ParticleSystemRenderer.mesh public Mesh mesh ; Description The Mesh that the particle uses instead of a billboarded Texture. Additional resources: ParticleSystemRenderer.renderMode . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9932d1ff3f9e
unity_docs
animation
What is `UIElements.Experimental.ValueAnimation_1.easingCurve` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ValueAnimation<T0>.easingCurve public Func<float,float> easingCurve ; Description Smoothing function related to this animation. Default value is Easing.OutQuad .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ef81fac2d22a_doc_1
github
scripting
What does `OrderedDictionaryListAdaptor` do in this Unity script? Explain its purpose and signature.
Initializes a new instance of the class.The target object.The adaptor for the ordered dictionary's keys.The adaptor for the ordered dictionary's values. Signature: ```csharp public OrderedDictionaryListAdaptor(OrderedDictionary target, SerializedPropertyAdaptor keysPropertyAdaptor, SerializedPropertyAdaptor valuesPro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8223c84bf756
unity_docs
ui
What is `GUIStyle.contentOffset` in Unity? Explain its purpose and usage.
GUIStyle.contentOffset public Vector2 contentOffset ; Description Pixel offset to apply to the content of this GUIstyle. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints the value of contentOffset. void OnGUI() { Debug.Log(GUI.skin.button.contentOffset); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d740b1224a0f
github
scripting
Write a Unity C# script called Scene View
```csharp using Solid.Core; using UnityEngine; /*Copyright (c) Created by Oleksii Volovich 2021*/ namespace Solid.UI { [RequireComponent(typeof(Canvas))] public class SceneView:SolidBehaviour { [SerializeField] private Canvas _canvas; protected override void OnAwake(params object[] paramet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6b8ed73d345
unity_docs
physics
What is `Collision2D.rigidbody` in Unity? Explain its purpose and usage.
Collision2D.rigidbody public Rigidbody2D rigidbody ; Description The incoming Rigidbody2D involved in the collision with the otherRigidbody . This may be null if the Collision2D.collider is not attached to a Rigidbody2D . Additional resources: Collider2D and Rigidbody2D . ```csharp using UnityEngine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dfccd79cc3f0
unity_docs
physics
In Unity's 'CPU Usage Profiler module reference', what is 'More (⋮) menu settings' and how does it work?
The More (⋮) menu contains the following settings: Setting Description Show Full Scripting Method Names Displays the fully qualified names for all scripting methods ( Assembly::Class::MethodName ). Show Flow events (Timeline view only) Displays the relationship between systems, jobs, and threads. When you enable this s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38cc6d1fb28e
unity_docs
scripting
What is `Tilemaps.Tilemap.GetCellCenterLocal` in Unity? Explain its purpose and usage.
Tilemap.GetCellCenterLocal Declaration public Vector3 GetCellCenterLocal ( Vector3Int position ); Parameters Parameter Description position Grid cell position. Returns Vector3 Returns the center of the cell transformed into local space coordinates. Description Gets the logical center coordinate of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0bfa44e93f6
unity_docs
scripting
What is `UIElements.Toggle` in Unity? Explain its purpose and usage.
Toggle class in UnityEngine.UIElements / Inherits from: UIElements.BaseBoolField / Implemented in: UnityEngine.UIElementsModule Description A Toggle is a clickable element that represents a boolean value. A Toggle control consists of a label and an input field. The input field contains a sprite for the co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d272ecaefe91
unity_docs
performance
Show me a Unity code example for 'Create and run a job'.
e NativeContainer instance that the job was using. Calling Complete also cleans up the state in the safety system. Not doing so introduces a memory leak. ## Job examples The following is an example of a job that adds two floating point values together. It implements IJob , uses a NativeArray to get the results of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_725563186ae6
github
scripting
Write a Unity C# script called Camera Color Setter
```csharp using UnityEngine; namespace LeakyAbstraction.ReactiveScriptables { [ExecuteInEditMode] [RequireComponent(typeof(Camera))] public class CameraColorSetter : ColorSetterBase<Camera> { protected override void SetColor(Color color) => _component.backgroundColor = color; }...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0dc773329adf
unity_docs
scripting
In Unity's 'Details of disabling domain and scene reload', what is 'What Unity skips when domain reload and scene reload is disabled' and how does it work?
From a high-level perspective, entering Play mode consists of the following main stages: Backup current scenes . This only happens when the Scene has been modified. Allows Unity to revert the Scenes when exiting Play mode to the state they were in before Play mode started. Domain reload . Resets the scripting state, by...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_616cb6d7904b
unity_docs
rendering
What is `ShaderUtil.ShaderHasWarnings` in Unity? Explain its purpose and usage.
ShaderUtil.ShaderHasWarnings Declaration public static bool ShaderHasWarnings ( Shader shader ); Parameters Parameter Description shader The shader to check for compilation warnings. Returns bool Returns true if the shader has any compilation warnings. Otherwise, returns false. Description Checks if...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_10
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive eleven 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 clas...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_0f4fe589e86f
unity_docs
rendering
What is `Rendering.RenderPipelineAsset.autodeskInteractiveShader` in Unity? Explain its purpose and usage.
RenderPipelineAsset.autodeskInteractiveShader public Shader autodeskInteractiveShader ; Returns Shader Returns the default shader. Description Retrieves the default Autodesk Interactive Shader for this pipeline. This method is called whenever a model with Autodesk Interactive Material is imported in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a82af7fefde6
unity_docs
rendering
What is `TextureFormat.RGBA32_SIGNED` in Unity? Explain its purpose and usage.
TextureFormat.RGBA32_SIGNED Description Four channel (RGBA) texture format, 8-bits signed integer per channel. Import textures of this format in .DDS files. Note that not all graphics cards support all texture formats, use SystemInfo.SupportsTextureFormat to check. Additional resources: Texture2D.format , textu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_76a23ac102f8
unity_docs
editor
What are the parameters of `SettingsProvider.OnActivate` in Unity?
Description Use this function to implement a handler for when the user clicks on the Settings in the Settings window. You can fetch a settings Asset or set up UIElements UI from this function. ```csharp using UnityEditor; using UnityEngine; using UnityEngine.UIElements;class SimpleIMGUISettingsProvider : SettingsProvid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1377d092b616
unity_docs
scripting
Show me a Unity code example for 'Add class library references to .NET Framework'.
iles you want to reference into the Assets folder of your project, if they aren’t already in this folder. Populate the csc.rsp file with command-line arguments for the assemblies you want to reference. For example, if your project uses the HttpClient class, which is defined in the System.Net.Http.dll assembly, the C# c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28151ce65470
unity_docs
rendering
What is `IHVImageFormatImporter.streamingMipmaps` in Unity? Explain its purpose and usage.
IHVImageFormatImporter.streamingMipmaps public bool streamingMipmaps ; Description Enable mipmap streaming for this texture. When mipmap streaming is enabled, Unity will automatically load only the mipmap levels needed to render the Scene based on the current camera positions. Mipmap streaming must be enabled ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14c942992753
unity_docs
physics
What is `ParticleSystem.CollisionModule.colliderForce` in Unity? Explain its purpose and usage.
ParticleSystem.CollisionModule.colliderForce public float colliderForce ; Description How much force is applied to a Collider when hit by particles from this Particle System. Additional resources: ParticleSystem.CollisionModule.multiplyColliderForceByParticleSize , ParticleSystem.CollisionModule.multiplyColl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d19e9d86b919
unity_docs
rendering
What are the parameters of `ImageConversion.EncodeArrayToPNG` in Unity?
Description Encodes this array into PNG format. This function returns a byte array which is the PNG file data. You can store the encoded data as a file or send it over the network without further processing. This function does not work on any compressed format. The encoded PNG data will be either 8b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4ddf68cbbf2
unity_docs
scripting
What is `UIElements.INavigationEvent.commandKey` in Unity? Explain its purpose and usage.
INavigationEvent.commandKey public bool commandKey ; Description Gets a boolean value that indicates whether the Windows/Cmd key is pressed. True means the Windows/Cmd key is pressed. False means it isn't.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ff1e7e5d5715
unity_docs
editor
What are the parameters of `Profiling.HierarchyFrameDataView.GetItemColumnDataAsDouble` in Unity?
Returns double Value of the correspnding column as double. Description Returns double representation of hierarchy item value associated with the column. Use to retrieve value with high precision for columns such as HierarchyFrameDataView.columnStartTime which represents sample start time in milliseconds. ```csharp usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ea0624166c7
unity_docs
xr
What is `PackageManager.Client` in Unity? Explain its purpose and usage.
Client class in UnityEditor.PackageManager Description Use the Unity Package Manager Client class to manage the packages used in a project. Note: You can only call the Client methods in sequence. If you try to add or remove multiple packages at the same time, the outcome is nondeterministic. For example, if you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8129b9e2b39a
unity_docs
scripting
What is `AI.NavMeshAgent.remainingDistance` in Unity? Explain its purpose and usage.
NavMeshAgent.remainingDistance public float remainingDistance ; Description The distance between the agent's position and the destination on the current path. (Read Only) If the remaining distance is unknown then this will have a value of infinity.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4d28487f71fb
unity_docs
physics
What is `WheelCollider.center` in Unity? Explain its purpose and usage.
WheelCollider.center public Vector3 center ; Description The center of the wheel, measured in the object's local space. The center of the wheel describes the coordinate that the wheel would achieve if the car was suspended in mid-air. This is equivalent to the coordinate of the wheel center when the spring i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0af27c36b85c
unity_docs
editor
In Unity's 'Profiling tools reference', what is 'Unity’s analysis tools' and how does it work?
Unity has several profiling and analysis tools to measure the performance of your application: Tool Description Profiler Measures the performance of the Unity Editor, your application in Play mode, or connects to a device running your application in development mode. Memory Profiler Provides in-depth memory performance...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22da9e83d52e
unity_docs
rendering
What is `SketchUpImportScene` in Unity? Explain its purpose and usage.
SketchUpImportScene struct in UnityEditor Description Structure to hold scene data extracted from a SketchUp file. When importing a SketchUp file, Unity retrieves all the scenes in the SketchUp file. This can be extracted later from SketchUpImporter with SketchUpImporter.GetScenes . Properties Property Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c7df5370c54e
unity_docs
math
In Unity's 'USS transform', what is 'Pivot Origin' and how does it work?
The Pivot Origin widget sets the transform origin property. To use it, do one of the following: Click a point in the widget to set the origin to a corner, the center of an edge, or the center. You can also define the values using the keyboard. When the widget is in focus, use the arrow keys to specify a point in the wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8a09d0e54fd
unity_docs
xr
What are the parameters of `Rendering.AsyncGPUReadback.RequestIntoNativeSliceAsync` in Unity?
Description Retrieves data asynchronously from a GPU Texture resource. See AsyncGPUReadback.RequestIntoNativeSlice . Declaration public static Awaitable<AsyncGPUReadbackRequest> RequestIntoNativeSliceAsync (ref NativeSlice<T> output , ComputeBuffer src ); Declaration public static Awaitable<AsyncGPUReadbackRequest> Req...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eeefb80b1036
unity_docs
physics
What are the parameters of `Physics.CheckSphere` in Unity?
Description Returns true if there are any colliders overlapping the sphere defined by position and radius in world coordinates. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { public float sphereRadius; AudioSource audioSource; void Start() { audi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7433172a07c7
github
scripting
Write a Unity Editor script for Scriptable Item Extension Editor
```csharp using Baxter.ClusterScriptExtensions.Editor.Localization; using Baxter.ClusterScriptExtensions.Editor.ScriptUpdater; using UnityEditor; using UnityEngine; namespace Baxter.ClusterScriptExtensions.Editor.Inspector { [CustomEditor(typeof(ScriptableItemExtension))] public class ScriptableItemExtensionEd...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_30e1ace8e945
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUsage.StencilSampling` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUsage.StencilSampling Description Use this to create and render to the Stencil sub element of a RenderTexture.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_edd8a65c961b
unity_docs
rendering
Explain '2D and 3D projects' in Unity.
Unity is equally suited to creating both 2D and 3D games. When you create a new project, you choose either 2D or 3D mode. You may already know what you want to build, but there are a few subtle points that may affect which mode you choose. The choice between starting in 2D or 3D mode determines some settings for the Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0013e1aeeea
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeaderState.maximumNumberOfSortedColumns` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.maximumNumberOfSortedColumns public int maximumNumberOfSortedColumns ; Description This property controls the maximum number of columns returned by the sortedColumns property. This property controls the maximum number of columns returned by the sortedColumns property. It is set to a defau...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8a7054aeaae
unity_docs
math
What is `Rendering.SubMeshDescriptor.bounds` in Unity? Explain its purpose and usage.
SubMeshDescriptor.bounds public Bounds bounds ; Description Bounding box of vertices in local space. The bounds , firstVertex and vertexCount values are calculated automatically by Mesh.SetSubMesh , unless MeshUpdateFlags.DontRecalculateBounds flag is passed. Additional resources: Mesh.SetSubMesh , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8dd7f95829d6
unity_docs
xr
Explain 'Manage asset packs at runtime' in Unity.
Unity provides APIs to manage asset packs at runtime. They use Google’s PlayCore API, which means they have the same limitations as PlayCore, and can’t manage install-time asset packs. Using the PlayCore API also means your application requires the PlayCore plug-in . If your project has asset packs, either custom asset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a9feb32bd552
unity_docs
scripting
Show me a Unity code example for 'Deploy a QNX project'.
in libEGL[-_tag].so , which is the required libEGL (for example, libEGL_viv.so ). The line starting with glesv2-dlls should contain libGLESv2[-_tag] , which is the libGLESv2 (for example, libGLESv2_viv.so ). Both libraries should be in the same folder as graphics.conf . Both library file names must be set up as environ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_213e8b99d553
unity_docs
ui
Show me a Unity code example for 'Generate 2D visual content'.
indices. The MeshGenerationContext.Allocate method allocates and draws the specified number of vertices and indices required to express geometry for drawing the content of a visual element. For details on geometry generation conventions, see Vertex.position . The following code snippet generates a single quad . It allo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a2cb9d826b7d
unity_docs
rendering
In Unity's 'Rich Text', what is 'Nested elements' and how does it work?
It is possible to apply more than one style to a section of text by "nesting" one element inside another We are <b><i>definitely not</i></b> amused The <i> tag applies italic style, so this would be presented onscreen as We are definitely not amused Note the ordering of the closing tags, which is in reverse to that of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e146dddb50aa
unity_docs
rendering
What is `Camera.TryGetCullingParameters` in Unity? Explain its purpose and usage.
Camera.TryGetCullingParameters Declaration public bool TryGetCullingParameters (out Rendering.ScriptableCullingParameters cullingParameters ); Declaration public bool TryGetCullingParameters (bool stereoAware , out Rendering.ScriptableCullingParameters cullingParameters ); Parameters Parameter Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21d980bd0018
unity_docs
math
What is `Rendering.ResourcePathsBaseAttribute.isField` in Unity? Explain its purpose and usage.
ResourcePathsBaseAttribute.isField public bool isField ; Description Disambiguish array of 1 element and fields. As we don't store it at runtime, you cannot rely on this property for runtime operation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_11b831252913
unity_docs
scripting
What is `ParticleSystem.MainModule.loop` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.loop public bool loop ; Description Specifies whether the Particle System is looping. If you disable looping on a playing Particle System, it stops at the end of the current loop. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_21a1f914e86b
unity_docs
ui
Explain 'Style text with USS' in Unity.
You can style text with USS text properties inline in UXML , a USS file, or directly in UI Builder . To learn more about USS text properties, refer to Text properties . ## Style text in USS and UXML Text properties are regular USS style properties. You can set text style properties on any element. Unlike most USS sty...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f59a23e3633c
unity_docs
scripting
What is `Rendering.BatchDrawCommandProceduralIndirect.visibleInstancesBufferHandle` in Unity? Explain its purpose and usage.
BatchDrawCommandProceduralIndirect.visibleInstancesBufferHandle public GraphicsBufferHandle visibleInstancesBufferHandle ; Description Handle of the GraphicsBuffer from which the draw command will read visible instance index.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8d408b4ff9c
unity_docs
editor
What is `EditorUtility.FormatBytes` in Unity? Explain its purpose and usage.
EditorUtility.FormatBytes Declaration public static string FormatBytes (int bytes ); Description Returns a text for a number of bytes. ```csharp using UnityEngine; using UnityEditor;public class FormatBytesExample : MonoBehaviour { void Start() { // prints "100 bytes" print(EditorUtility.FormatBytes(100));...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32010d89f40e
unity_docs
audio
What is `Audio.AudioClipPlayable` in Unity? Explain its purpose and usage.
AudioClipPlayable struct in UnityEngine.Audio / Implemented in: UnityEngine.AudioModule Implements interfaces: IPlayable Description An implementation of IPlayable that controls an AudioClip . NOTE: You can use PlayableExtensions methods with AudioClipPlayable objects. Static Methods Method Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0d0c865ef547
unity_docs
scripting
In Unity's 'Bind to nested properties', what is 'Example overview' and how does it work?
This example creates a custom Inspector UI with the following: Two fields that bind to a GameObject ’s name and the scale of a USS transform Two fields that bind to nested properties of a SerializedObject You can find the completed files that this example creates in this GitHub repository .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_275e79fd304d
unity_docs
scripting
Show me a Unity C# example demonstrating `Events.UnityEvent`.
UnityEvent class in UnityEngine.Events / Inherits from: Events.UnityEventBase / Implemented in: UnityEngine.CoreModule Description A zero argument persistent callback that can be saved with the Scene. ```csharp using UnityEngine; using UnityEngine.Events;public class ExampleClass : MonoBehaviour { UnityEvent...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5bf9c663a27b
unity_docs
rendering
What is `Experimental.GlobalIllumination.PointLight` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PointLight struct in UnityEngine.Experimental.GlobalIllumination / Implemented in: UnityEngine.CoreModule Description A helper structure used to initialize a LightDataGI structure as a point light. Properties Property Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_65d5cc464294
unity_docs
animation
Show me a Unity C# example demonstrating `AnimationClip.legacy`.
AnimationClip.legacy public bool legacy ; Description Set to true if the AnimationClip will be used with the Legacy Animation component ( instead of the Animator ). ```csharp using UnityEngine; using System.Collections;public class animFov : MonoBehaviour { void Start() { AnimationClip fovc = new AnimationC...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0983842acf93
unity_docs
scripting
What is `HumanPoseHandler.SetInternalHumanPose` in Unity? Explain its purpose and usage.
HumanPoseHandler.SetInternalHumanPose Declaration public void SetInternalHumanPose (ref HumanPose humanPose ); Parameters Parameter Description humanPose The human pose to set. In the human pose, the bodyPosition and bodyRotation are the position and rotation of the approximate center of mass of the hu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5cb7f9fa1078
unity_docs
physics
What is `Rigidbody2D.GetVector` in Unity? Explain its purpose and usage.
Rigidbody2D.GetVector Declaration public Vector2 GetVector ( Vector2 vector ); Parameters Parameter Description vector The global space vector to transform into a local space vector. Description Get a local space vector given the vector vector in rigidBody global space.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_44b0c8b4a66a
unity_docs
xr
Explain 'Scripting API for packages' in Unity.
You can use the Package Manager scripting API to interact with the Package Manager using C# scripts . For example, you might want to install a specific package or version depending on the platform of the target machine. Using the scripting API for package management relies on the PackageManager.Client class. Use this c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7cdd529275e1
unity_docs
editor
What is `Device.SystemInfo.graphicsDeviceVendorID` in Unity? Explain its purpose and usage.
SystemInfo.graphicsDeviceVendorID public static int graphicsDeviceVendorID ; Description This has the same functionality as SystemInfo.graphicsDeviceVendorID 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_man_64059484ce60
unity_docs
ui
In Unity's 'Coordinate and position systems', what is 'Transformation between coordinate systems' and how does it work?
The VisualElement.layout.position and VisualElement.transform properties define how to transform between the local coordinate system and the parent coordinate system. The VisualElementExtensions static class provides the following extension methods that transform points and rectangles between coordinate systems: WorldT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a73b311a64d
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.IO.Archive.ArchiveHandle.Compression`.
ArchiveHandle.Compression public CompressionType Compression ; Description The type of compression the archive uses. Only accessible if the archive loaded successfully. Additional resources: AssetBundles compression . ```csharp using Unity.Content; using Unity.IO.Archive; using UnityEditor; using UnityEn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c8ff65017b1
unity_docs
scripting
What is `AssetImporters.AssetImportContext.assetPath` in Unity? Explain its purpose and usage.
AssetImportContext.assetPath public string assetPath ; Description The path of the source asset file to be imported. This value is provided by the Asset Pipeline and indicates the path of the Asset file to import.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ab810469b04
unity_docs
rendering
What is `Rendering.RendererListParams.filteringSettings` in Unity? Explain its purpose and usage.
RendererListParams.filteringSettings public Rendering.FilteringSettings filteringSettings ; Description A struct that describes how to filter the set of visible objects, so that Unity only draws a subset.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3eb4b1ce9f07
unity_docs
scripting
In Unity's 'Diff tool support', what is 'Set up a custom revision tool' and how does it work?
To set up a custom revision tool, follow these steps: Open the Preferences window, and navigate to the External Tools section. In the Revision Control Diff/Merge dropdown list, select Custom Tool . Enter the path to the custom tool’s installation folder. On macOS, this should point to the Contents / MacOS folder in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4b9ea0a35661
unity_docs
ui
In Unity's 'IMGUI Layout Modes', what is 'Fixed Layout - Groups' and how does it work?
Groups are a convention available in Fixed Layout Mode. They allow you to define areas of the screen that contain multiple Controls. You define which Controls are inside a Group by using the GUI.BeginGroup() and GUI.EndGroup() functions. All Controls inside a Group will be positioned based on the Group’s top-left corne...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a7c1884e80f0
unity_docs
audio
What is `Experimental.Audio.AudioSampleProvider.maxSampleFrameCount` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. AudioSampleProvider.maxSampleFrameCount public uint maxSampleFrameCount ; Description The maximum number of sample frames that can be accumulated inside the internal buffer before an overflow event is emitted.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.