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_ffce5538b889
unity_docs
xr
What are the parameters of `Windows.WebCam.PhotoCaptureFrame.TryGetProjectionMatrix` in Unity?
Returns bool True if a valid matrix is returned or false otherwise. This will be false if the frame has no location data. Description This method will return the projection matrix at the time the photo was captured if location data if available. If the near and far clip values are not specified, then the projection ma...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2b643fdfd75
unity_docs
scripting
What is `UIElements.TabView.selectedTabIndex` in Unity? Explain its purpose and usage.
TabView.selectedTabIndex public int selectedTabIndex ; Description A property that returns the index of current active tab inside a list of available tabs. Setting a valid index will set the Tab at the given index to active.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b48abd89ad7
unity_docs
physics
What is `ConfigurableJoint.angularZMotion` in Unity? Explain its purpose and usage.
ConfigurableJoint.angularZMotion public ConfigurableJointMotion angularZMotion ; Description Allow rotation around the Z axis to be Free, completely Locked, or Limited according to Angular ZLimit.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9184a378ef91
unity_docs
scripting
What is `UIElements.UxmlSerializedData.ShouldWriteAttributeValue` in Unity? Explain its purpose and usage.
UxmlSerializedData.ShouldWriteAttributeValue Declaration public static bool ShouldWriteAttributeValue ( UIElements.UxmlSerializedData.UxmlAttributeFlags attributeFlags ); Description Determines if an attribute should be applied during Deserialize.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3fd8dc0407b
unity_docs
scripting
What is `Animator.SetFloat` in Unity? Explain its purpose and usage.
Animator.SetFloat Declaration public void SetFloat (string name , float value ); Declaration public void SetFloat (string name , float value , float dampTime , float deltaTime ); Declaration public void SetFloat (int id , float value ); Declaration public void SetFloat (int id , float value , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3efbcb4757ac
unity_docs
math
Show me a Unity C# example demonstrating `AudioSource.GetSpectrumData`.
a result, the output data will initially be empty until the engine processes sufficient audio to populate the buffer. Please note this function isn't suited for critical or chronological, real-time data analysis or processing, or scenarios where you require low latency. For related information, refer to AudioSource.Ge...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d30c616e383c
unity_docs
scripting
Show me a Unity C# example demonstrating `Cloth.stretchingStiffness`.
Cloth.stretchingStiffness public float stretchingStiffness ; Description Stretching stiffness of the cloth. Must be greater than zero and smaller or equal to one. In many cases, when you want a cloth to be more stiff, actually reducing the number of vertices will get you better results - and performance. ```...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_92dbdb252892
unity_docs
scripting
Explain 'Java Native Interface APIs in Unity' in Unity.
Unity provides low-level and high-level Java Native Interface (JNI) APIs that allow you to interact with Java code from C# scripts . ## Low-level API The low-level AndroidJNI class wraps JNI calls and provides static methods that directly map to JNI methods. The AndroidJNIHelper API provides helper functionality that...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c74cce759d2
unity_docs
scripting
What is `Pose.GetTransformedBy` in Unity? Explain its purpose and usage.
Pose.GetTransformedBy Declaration public Pose GetTransformedBy ( Pose lhs ); Declaration public Pose GetTransformedBy ( Transform lhs ); Description Transforms the current pose into the local space of the provided pose.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5c7ac13dbb7
unity_docs
scripting
What is `UIElements.TransitionCancelEvent` in Unity? Explain its purpose and usage.
TransitionCancelEvent class in UnityEngine.UIElements / Inherits from: UIElements.TransitionEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Event sent when a transition is canceled. Inherited Members Properties Property Description bubbles Returns whether this event type bubbles ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_61df519fd274
unity_docs
rendering
In Unity's 'Optimize shaders', what is 'Avoid complex calculations' and how does it work?
To avoid complex calculations, do the following for example: Use lookup textures instead of resource-intensive functions such as pow , log and sin . Use Unity HLSL functions, such as normalize and dot , instead of writing your own. This ensures that the driver can generate better code.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ad16dd1b058b
unity_docs
physics
Explain 'Manually set physics simulation' in Unity.
Control the physics simulation manually to decide when physics calculations occur to align physics updates with your application’s actual performance and avoid redundant updates. This can help optimize performance during busy frames and is beneficial for scenarios that require tight synchronization with game logic or c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f8c3f92fbda3
unity_docs
rendering
In Unity's 'Mesh vertex data', what is 'Position' and how does it work?
The vertex position represents the position of the vertex in object space . Unity uses this value to determine the surface of the mesh. This vertex attribute is required for all meshes. In the Mesh class, the simplest way to access this data is with Mesh.GetVertices and Mesh.SetVertices . Unity also stores this data in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7436ccf2331
unity_docs
scripting
What is `Video.VideoPlayer.pixelAspectRatioDenominator` in Unity? Explain its purpose and usage.
VideoPlayer.pixelAspectRatioDenominator public uint pixelAspectRatioDenominator ; Description Denominator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only) For URL sources, this will only be set once the source preparation is completed. See VideoPlayer.Prepare .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_109c2b35628e
unity_docs
rendering
What is `TextureMipmapLimitBiasMode.OffsetGlobalLimit` in Unity? Explain its purpose and usage.
TextureMipmapLimitBiasMode.OffsetGlobalLimit Description Indicates that TextureMipmapLimitSettings offsets the global texture mipmap limit by the TextureMipmapLimitSettings.limitBias value, instead of overriding it. Additional resources: TextureMipmapLimitSettings , TextureMipmapLimitSettings.limitBiasMode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e38eedf3d04c
unity_docs
performance
Explain 'Video Profiler module reference' in Unity.
The Video Profiler module displays information about what resources the video in your application is using, such as memory, buffering, and number of video clips . You can use this data to determine how efficiently your application plays back and buffers videos on your selected platforms. You can also use the CPU Usage ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eb881475f519
unity_docs
math
What is `Handles.DrawSelectionFrame` in Unity? Explain its purpose and usage.
Handles.DrawSelectionFrame Declaration public static void DrawSelectionFrame (int controlID , Vector3 position , Quaternion rotation , float size , EventType eventType ); Parameters Parameter Description position The position of the handle in the space of Handles.matrix . rotation The rotation o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0f6fc22a673c
unity_docs
ui
In Unity's 'SliderInt', what is 'Create a SliderInt' and how does it work?
You can create a SliderInt with UI Builder, UXML, or C#. The following C# example creates a SliderInt with a default value, low value, and high value, and sets the direction of the slider: ``` var sliderInt = new SliderInt(); sliderInt.value = 42; sliderInt.lowValue = 0; sliderInt.highValue = 100; sliderInt.direction =...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1e8e66dc60a1
unity_docs
scripting
What are the parameters of `GameObject.GetComponentsInParent` in Unity?
Returns T[] An array containing all matching components of type T . Description Retrieves references to all components of type T on the specified GameObject, and any parent of the GameObject. The typical usage for this method is to call it on a reference to a different GameObject than the one your script is on. For exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57b28aad1429
unity_docs
rendering
What is `SketchUpImportCamera` in Unity? Explain its purpose and usage.
SketchUpImportCamera struct in UnityEditor Description Structure to hold camera data extracted from a SketchUp file. When importing a SketchUp file, Unity retrieves the current camera view the file is saved with and the camera view of all the scenes in the SketchUp file. The camera data of each Scene is stored in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0c92d682fe5
unity_docs
scripting
What is `TextMesh.alignment` in Unity? Explain its purpose and usage.
TextMesh.alignment public TextAlignment alignment ; Description How lines of text are aligned (Left, Right, Center). ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { GetComponent<TextMesh>().alignment = TextAlignment.Left; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a62ab0e8a1fb
unity_docs
scripting
What is `Rect.height` in Unity? Explain its purpose and usage.
Rect.height public float height ; Description The height of the rectangle, measured from the Y position. Setting this value will also change yMax . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { Rect rect = new Rect(0, 0, 10, 10); print(rect.height); rect.height = 20; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ba46d64aefa
unity_docs
editor
What is `Search.SearchIndexer.IsReady` in Unity? Explain its purpose and usage.
SearchIndexer.IsReady Declaration public bool IsReady (); Returns bool Returns true if the index is ready for search. Description Indicates if the index is fully built, up to date, and ready for search. ```csharp using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; static cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_224e86b027a6
unity_docs
xr
In Unity's 'AR Foundation', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.xr.arfoundation@6.5 released 6.5.0-pre.1, 6.5.0-pre.2, 6.5.0-pre.3, 6.5.0 com.unity.xr.arfoundation@6.4 released 6.4.0-pre.1, 6.4.0, 6.4.1, 6.4.2 com.unity.xr.arfoundation@6.3 released 6.3.0-pre.1, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e4cce36f7fcf_doc_2
github
scripting
What does `PermissionCallbacksPermissionDenied` do in this Unity script? Explain its purpose and signature.
Permission Denied callback. Signature: ```csharp private static void PermissionCallbacksPermissionDenied(string permissionName) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_99425f549d35
unity_docs
rendering
What is `Rendering.ShadowDrawingSettings.splitIndex` in Unity? Explain its purpose and usage.
ShadowDrawingSettings.splitIndex public int splitIndex ; Description The split index of the shadow-casting light to be rendered. With the default value of -1, Unity increments the split index from 0 for shadow renderer lists that are created consecutively for the same light index with matching filtering and mask...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a201fa40a338
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.lights`.
e is a simple and powerful module that allows particles to cast light onto their environment easily. Lights can inherit properties from the particles they are attached to, such as color and size. Point and Spot Lights are supported, including shadow casting and Light cookies. Particle System modules do not need to be r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78a73ff8c251
unity_docs
rendering
What is `ModelImporterMaterialSearch` in Unity? Explain its purpose and usage.
ModelImporterMaterialSearch enumeration Description Material search options for ModelImporter . Additional resources: ModelImporter.materialSearch . Properties Property Description Local Search in local Materials folder. RecursiveUp Recursive-up search in Materials folders. Everywhere Search in all project...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e4fca7af2ecd
unity_docs
xr
Explain 'Store credentials for automatic proxy configuration (macOS)' in Unity.
If your organization’s web proxy requires user authentication and is configured to accept basic authentication (username and password), you must store your credentials before using Unity applications. If you use Unity on macOS, use the following procedure. For Windows, refer to Store credentials for automatic proxy con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_defae0224992
unity_docs
physics
What is `RaycastHit.collider` in Unity? Explain its purpose and usage.
RaycastHit.collider public Collider collider ; Description The Collider that was hit. This property is null if the ray hit nothing and not-null if it hit a Collider. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Update() { if (Input.GetMouseButtonDown(0)) { RaycastHit hit; R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_37f0f408ef74
github
scripting
Write a Unity C# XR/VR script for Card
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.Events; using UnityEngine.XR.Interaction.Toolkit; using System; using Unity.VisualScripting; public class Card : MonoBehaviour { private Solitaire solitaire; private Rigidbody rb; public bool freshFr...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_fde32418d4b0
unity_docs
animation
What is `Animations.MuscleHandle.GetMuscleHandles` in Unity? Explain its purpose and usage.
MuscleHandle.GetMuscleHandles Declaration public static void GetMuscleHandles (out MuscleHandle[] muscleHandles ); Parameters Parameter Description muscleHandles An array of MuscleHandle. Description Fills the array with all the possible muscle handles on a humanoid.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d636bb4f981e
unity_docs
editor
Show me a Unity C# example demonstrating `Search.ISearchView.AddSelection`.
ISearchView.AddSelection Declaration public void AddSelection (params int[] selection ); Parameters Parameter Description selection Array of item indices to add to selection. Description Adds new items to the current selection. . ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Search; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d2d6e604c6b
unity_docs
scripting
What is `Unity.Collections.NativeSlice_1.SliceWithStride` in Unity? Explain its purpose and usage.
NativeSlice<T0>.SliceWithStride Declaration public NativeSlice<U> SliceWithStride (int offset ); Declaration public NativeSlice<U> SliceWithStride (); Parameters Parameter Description offset Stride offset. Returns NativeSlice<U> NativeSlice. Description SliceWithStride.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_95c71f24d65e
github
scripting
Write a Unity C# script called Context With Locator
```csharp using System; using UnityEngine; using UnityEngine.Assertions; namespace RMC.Mini.Experimental.ContextLocators { /// <summary> /// EXPERIMENTAL: This is an alternative version of /// <see cref="IContext"/> that keeps a globally accessible /// reference to this context via <see cref="ContextLocator"/>. ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_099d5271a913
unity_docs
rendering
What are the parameters of `Rendering.ScriptableCullingParameters` in Unity?
Obtain a ScriptableCullingParameters struct by calling Camera.TryGetCullingParameters . Note that you can obtain and view a ScriptableCullingParameters struct from a Camera in the Built-in Render Pipeline; however, changing the values has no effect. The following Scriptable Render Pipeline code demonstrates how to obta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_010e7176fe56
unity_docs
scripting
What is `Build.Player.ScriptCompilationSettings.group` in Unity? Explain its purpose and usage.
ScriptCompilationSettings.group public BuildTargetGroup group ; Description Platform group for which scripts will be compiled. Internal use only. See Build.Content.ScriptCompilationSettings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8e0e6f762530
github
scripting
Write a Unity C# XR/VR script for Camera Input
```csharp /* * NatCorder * Copyright (c) 2020 Yusuf Olokoba. */ namespace NatSuite.Recorders.Inputs { using UnityEngine; using UnityEngine.Rendering; using System; using System.Collections; using Clocks; /// <summary> /// Recorder input for recording video frames from one or more gam...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_aec34cb35945
unity_docs
xr
In Unity's 'Notarize with Xcode and command-line tools', what is 'Generate an application password' and how does it work?
To notarize an application, Apple requires a unique password in a particular format. For information on how to generate an application password, refer to How to generate an app-specific password . The password you generate uses the following format: xxxx-xxxx-xxxx-xxxx .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2a958a53614f
github
scripting
Write a Unity C# script called Color Extension
```csharp using UnityEngine; namespace DebugMenu { public static class ColorExtension { public static string Serialize(this Color color) => $"{color.r};{color.g};{color.b};{color.a}"; public static Color Deserialize(string serialized) { var split = serialized.Split(';'); ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_23e01543773e
unity_docs
physics
What is `PhysicsScene2D.subStepCount` in Unity? Explain its purpose and usage.
PhysicsScene2D.subStepCount public int subStepCount ; Description The number of simulation sub-steps that occurred during the last simulation step. When simulation sub-stepping occurs, the number of sub-steps that run are monitored with the actual count available for analysis here. The cost of sub-stepping shou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f62194e0007
unity_docs
physics
What is `Collision.gameObject` in Unity? Explain its purpose and usage.
Collision.gameObject public GameObject gameObject ; Description The GameObject whose collider you are colliding with. (Read Only). This is the GameObject that is colliding with your GameObject. Access this to check properties of the colliding GameObject, for example, the GameObject’s name and tag. ```cshar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb5320effc01
unity_docs
physics
What is `WheelCollider.sprungMass` in Unity? Explain its purpose and usage.
WheelCollider.sprungMass public float sprungMass ; Description The mass supported by this WheelCollider. Vehicle simulation uses the sprung mass model that assumes each wheel supports a particular portion of the vehicle's total mass at rest. By default, the sprung mass distribution is computed automatically ba...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_453af80c5ef9
unity_docs
editor
What is `EditorGUI.Vector2IntField` in Unity? Explain its purpose and usage.
EditorGUI.Vector2IntField Declaration public static Vector2Int Vector2IntField ( Rect position , string label , Vector2Int value ); Declaration public static Vector2Int Vector2IntField ( Rect position , GUIContent label , Vector2Int value ); Parameters Parameter Description position Rect...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f10926f531e9
unity_docs
input
Explain 'Input for Android devices' in Unity.
Mobile devices are the primary target for Android applications. For more information on mobile device input, refer to Mobile device input . ## Android keyboard Android devices include a touchscreen keyboard. When you select editable UI elements such as Input Fields Unity automatically activates the Android touchscree...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_40d01c4ca8fb
unity_docs
rendering
What is `TextureImporter.swizzleG` in Unity? Explain its purpose and usage.
TextureImporter.swizzleG public TextureImporterSwizzle swizzleG ; Description Specifies the source for the texture's green color channel data. By default, values for the imported texture's green channel come from the source image's green channel. To reorder or invert color channels at import time, change thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da2895cb2864
unity_docs
scripting
What is `ObjectFactory` in Unity? Explain its purpose and usage.
ObjectFactory class in UnityEditor Description Use the DefaultObject to create a new UnityEngine.Object in the editor. The creation process handles Undo registration and applies default values from your project. Static Methods Method Description AddComponent Creates a new component and adds it to the specifie...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb29257a2b44
unity_docs
editor
What is `Actions.EditorActionResult` in Unity? Explain its purpose and usage.
EditorActionResult enumeration Description The state that the EditorAction was completed in. Properties Property Description Canceled The EditorAction was canceled. Success The EditorAction completed successfully.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d585d54188c4_doc_8
github
scripting
What does `GetPackageUploadedVersions` do in this Unity script? Explain its purpose and signature.
Retrieve all Unity versions that the given package has already had uploaded content with Signature: ```csharp public static List<string> GetPackageUploadedVersions(string packageId, string versionId) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_385f07e2ea7f
github
scripting
Write a Unity C# UI script for Toggle Component
```csharp using UnityEngine; using UnityEngine.UI; namespace GI.UnityToolkit.Components.UI { [RequireComponent(typeof(Toggle))] public abstract class ToggleComponent : MonoBehaviour { protected Toggle Toggle { get; private set; } protected void Awake() { Toggle = GetCom...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_5401026130b9
unity_docs
ui
In Unity's 'Create a custom binding to bind USS selectors', what is 'Create the UI and the binding' and how does it work?
Generally speaking, you create a binding that binds to an existing property of the element. For demonstration purposes, this example creates a custom binding that binds to a property that doesn’t exist in the element. You must use UXML or C# to set up the binding that binds to a non-existing property. This example uses...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6a109eb2826
unity_docs
math
What is `UIElements.SortColumnDescriptions.CopyTo` in Unity? Explain its purpose and usage.
SortColumnDescriptions.CopyTo Declaration public void CopyTo (SortColumnDescription[] array , int arrayIndex ); Parameters Parameter Description array The array to copy to. arrayIndex The starting index. Description Copies the elements of the current collection to a Array, starting at the specified ind...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6c7537ceba02
unity_docs
ui
Show me a Unity code example for 'Local folder or tarball paths'.
macOS paths. ## Example of a relative path After the file: prefix, the path is a standard relative path. In the following example: The project’s Packages folder is C:\Users\my_username\Projects\my_project\Packages . The Projects , github , and Downloads folders are peer folders. my_package_c is an embedded package (a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a138335ab98a
unity_docs
animation
Explain 'State Machine Solo and Mute' in Unity.
In complex state machines , it is useful to preview the operation of some parts of the machine separately. For this, you can use the Mute and Solo functionality: Mute disables a transition. Solo plays only that transition. You can set up multiple Solo transitions to play only those that have Solo enabled. If one transi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7d4282a14e1
unity_docs
rendering
What are the parameters of `Rendering.CommandBuffer.SetRayTracingShaderPass` in Unity?
Description Adds a command to select which Shader Pass to use when executing ray/geometry intersection shaders. This name is specified in the ShaderLab shaders used by Materials applied to Renderers used in ray tracing. If a shader doesn't have a Shader Pass with the specified name, then no ray/geometry intersection co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_dcd025c62afb_doc_0
github
scripting
What does `OrderedDictionaryPropertyDrawer` do in this Unity script? Explain its purpose and signature.
Initializes a new instance of the class. Signature: ```csharp public OrderedDictionaryPropertyDrawer() ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d0c7c2a1d9c2
unity_docs
editor
What is `Search.FuzzySearch` in Unity? Explain its purpose and usage.
FuzzySearch class in UnityEditor.Search Description Provides a method to match query text using a fuzzy search algorithm. This utility class implements the text search functions using approximate string matching (fuzzy search). Search for a text pattern in a given string. If there is a match, get the match score....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9577b44fcf49
unity_docs
ui
What is `GUILayout.Width` in Unity? Explain its purpose and usage.
GUILayout.Width Declaration public static GUILayoutOption Width (float width ); Description Option passed to a control to give it an absolute width. Fixed width for a GUI Control. ```csharp using UnityEngine;public class ExampleScript : MonoBehaviour { // Draws a button with a fixed width void OnGUI() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4aa1db8c06ad
unity_docs
scripting
What is `Color32.b` in Unity? Explain its purpose and usage.
Color32.b public byte b ; Description Blue component of the color. ```csharp using UnityEngine;public class Example : MonoBehaviour { Color32 color = Color.white; void Start() { color.b = 0; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bf401728daea
unity_docs
scripting
In Unity's 'Load SSH keys automatically on macOS', what is 'Procedure' and how does it work?
Check your home folder for an.ssh subdirectory and check if it contains a config file. Note :.ssh is a hidden subdirectory. Create the ~/.ssh/config file if it doesn’t exist. Add the following content to ~/.ssh/config to set the key to load in the authentication agent and specify its use by the target server. Make sure...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e9d2465e8ca
unity_docs
audio
Give me an overview of the `AudioImporterSampleSettings` class in Unity.
AudioImporterSampleSettings struct in UnityEditor Description This structure contains a collection of settings used to define how an AudioClip should be imported. Unity uses this structure with the AudioImporter to define how to import and load the AudioClip within the Scene. This is useful if you want to cha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28a7beedb84b
unity_docs
rendering
What is `LightmapEditorSettings.reflectionCubemapCompression` in Unity? Explain its purpose and usage.
LightmapEditorSettings.reflectionCubemapCompression public static Rendering.ReflectionCubemapCompression reflectionCubemapCompression ; Description Determines how Unity will compress baked reflection cubemap.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_694409da4f81
unity_docs
editor
Show me a Unity C# example demonstrating `EditorWindow.maximized`.
EditorWindow.maximized public bool maximized ; Description Whether or not this window is maximized? To maximize the custome Editor window to the size of the Unity screen, set maximized . It works only when the custom Editor window is docked within Unity. ```csharp using UnityEditor; using UnityEngine; using ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b6bcf0119310
unity_docs
physics
What is `RaycastCommand` in Unity? Explain its purpose and usage.
RaycastCommand struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description Struct used to set up a raycast command to be performed asynchronously during a job. When you use this struct to schedule a batch of raycasts, they will be performed asynchronously and in parallel to each other. The res...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8a7c43aec595
unity_docs
rendering
In Unity's 'Managed code stripping and the Unity linker', what is 'How the Unity linker strips assemblies' and how does it work?
When you build a Unity project, the build process compiles your C# code to a .NET bytecode format called Common Intermediate Language (CIL). Unity packages this CIL bytecode into files called assemblies. The .NET framework libraries and any C# libraries in the plug-ins you use in your project are also pre-packaged as a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aeface8e1f96
unity_docs
rendering
What is `GraphicsBuffer.Target.Structured` in Unity? Explain its purpose and usage.
GraphicsBuffer.Target.Structured Description GraphicsBuffer can be used as a structured buffer. In HLSL shaders, this maps to StructuredBuffer<T> or RWStructuredBuffer<T> . When you construct a GraphicsBuffer of this type, the value of stride must match the stride of the corresponding StructuredBuffer struct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fba4647e79f8
unity_docs
xr
What is `PackageManager.Client.Remove` in Unity? Explain its purpose and usage.
Client.Remove Declaration public static PackageManager.Requests.RemoveRequest Remove (string packageName ); Parameters Parameter Description packageName The name of the package to remove from the project. ArgumentException is thrown if packageName is null or empty. Returns RemoveRequest A Remov...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18fdc92ff9f9
unity_docs
scripting
What is `XR.XRDisplaySubsystem.XRRenderPass.foveatedRenderingInfo` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.XRRenderPass.foveatedRenderingInfo public IntPtr foveatedRenderingInfo ; Description A pointer to a native struct containing platform-specific data for foveated rendering. This pointer can be passed to CommandBuffer.ConfigureFoveatRendering by the scriptable rendering pipeline implementation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e86ebf2b0978_doc_3
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Retrieves an object from the MonoBehaviour-based pool for the specified type.The type of the poolable MonoBehaviour object.The poolable object from the pool. Signature: ```csharp public T GetMono<T>() where T : MonoBehaviour, IPoolable => GetPool<MonoPool<T>, T>(_monoPools).Get(); ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_c5f92c82842b
unity_docs
scripting
What is `IMGUI.Controls.TreeViewItem.id` in Unity? Explain its purpose and usage.
TreeViewItem.id public int id ; Description Unique ID for an item. This ID needs to be unique among all TreeViewItems and is used to identify a TreeViewItem. If the tree is representing objects derived from UnityEngine.Object, it is a good idea to use the ID returned from GetInstanceID() for each object as the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b9156adea7b2
unity_docs
rendering
Explain 'Build Profiles window reference' in Unity.
The following sections provide an overview of the Build Profiles window and its settings. Access the Build Profiles window in the Unity Editor from File > Build Profiles . Asset Import Overrides Build options Build Data Platform Settings Player Settings Overrides ## Asset Import Overrides To speed up the time it take...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f8c32662d36
unity_docs
animation
What is `StateMachineBehaviour.OnStateUpdate` in Unity? Explain its purpose and usage.
StateMachineBehaviour.OnStateUpdate(Animator animator, AnimatorStateInfo animatorStateInfo, int layerIndex) Parameters Parameter Description animator The Animator evaluating this state machine. animatorStateInfo Information about the state being evaluated. layerIndex The current layer being evaluated. Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_01a9b887c700
unity_docs
rendering
In Unity's 'Advertisement Legacy', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.ads@9.8 compatible 9.8.8-preview.1, 9.8.8-preview.2, 9.8.8-preview.3, 9.8.8-preview.5 com.unity.ads@4.17 released 4.17.0 com.unity.ads@4.16 released 4.16.4
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0b65bd9ea0a4
unity_docs
scripting
What is `Cubemap.SmoothEdges` in Unity? Explain its purpose and usage.
Cubemap.SmoothEdges Declaration public void SmoothEdges (int smoothRegionWidthInPixels = 1); Parameters Parameter Description smoothRegionWidthInPixels Pixel distance at edges over which to apply smoothing. Description Performs smoothing of near edge regions. Helps to compensate lack of linear interpolat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80ee2d1f3d4d
unity_docs
rendering
What is `Texture2D.linearGrayTexture` in Unity? Explain its purpose and usage.
Texture2D.linearGrayTexture public static Texture2D linearGrayTexture ; Description Gets a small Texture with all gray pixels. Unity sets all pixels of this Texture to gray (0.5,0.5,0.5,0.5). The alpha value is also 0.5 (half transparent), and the color is in linear color space. Additional resources: grayTex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a109fc2c4c0
unity_docs
physics
What are the parameters of `Physics.CheckCapsule` in Unity?
Description Checks if any colliders overlap a capsule-shaped volume in world space. The capsule is defined by the two spheres with radius around point1 and point2 , which form the two ends of the capsule. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Given the start and end waypoints of a co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_97776dedd4f7
unity_docs
ui
Explain 'Best practices for USS' in Unity.
Follow these best practices when you write USS to style visual elements . ## Avoid inline styles Use USS files instead of inline styles when you can for more efficient memory usage. Inline styles are per element and can cause memory overhead. When you use inline styles in a C# script or a UXML file on many elements, ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16f5e00944e4
unity_docs
rendering
What is `Camera.renderingPath` in Unity? Explain its purpose and usage.
Camera.renderingPath public RenderingPath renderingPath ; Description The rendering path that should be used, if possible. In some situations, it may not be possible to use the rendering path specified, In this case the renderer automatically uses a different path; for example, if the underlying GPU/platfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_93de636d3526
unity_docs
networking
In Unity's 'Ads Mediation', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.services.levelplay@9.3 released 9.3.0 com.unity.services.levelplay@9.2 released 9.2.0 com.unity.services.levelplay@9.1 released 9.1.0 com.unity.services.levelplay@9.0 released 9.0.0, 9.0.1 com.unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c3dbe0b488b8
unity_docs
editor
What is `Build.IPreprocessBuildWithReport.OnPreprocessBuild` in Unity? Explain its purpose and usage.
IPreprocessBuildWithReport.OnPreprocessBuild Declaration public void OnPreprocessBuild ( Build.Reporting.BuildReport report ); Parameters Parameter Description report A report containing information about the build, such as its target platform and output path. Description Implement this function to receiv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c8cc7c23a1d
unity_docs
scripting
What are the parameters of `GameObject.GetComponentAtIndex` in Unity?
Returns Component A reference to a component at the specified index. If no component is found at the specified index, returns null . Description Retrieves a reference to a component at a specified index of the GameObject's array of components. Using GetComponentAtIndex is a stable way to access components on a GameObje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a544412abd88
unity_docs
editor
What is `PrefabUnpackMode` in Unity? Explain its purpose and usage.
PrefabUnpackMode enumeration Description Enum used to determine how a Prefab should be unpacked. Additional resources: PrefabUtility.UnpackPrefabInstance . Properties Property Description OutermostRoot Use this mode to only unpack the outermost layer of a Prefab. Completely Use this to strip away all Prefab ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a443f39b3223
unity_docs
scripting
What is `AI.NavMeshAgent.Raycast` in Unity? Explain its purpose and usage.
NavMeshAgent.Raycast Declaration public bool Raycast ( Vector3 targetPosition , out AI.NavMeshHit hit ); Parameters Parameter Description targetPosition The desired end position of movement. hit Properties of the obstacle detected by the ray (if any). Returns bool True if there is an obstacle betwe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8f82e003784d
github
scripting
Write a Unity Editor script for Simple Touch Setting GUI
```csharp using RayNeo; using System; using System.Collections.Generic; using System.IO; using UnityEditor; using UnityEditorInternal; using UnityEngine; namespace Rayneo { public class SimpleTouchSettingGUI : RayNeoProjectSettingGUIBase { //private ReorderableList m_OrderedList; private RayN...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a185caf11c14
unity_docs
rendering
What is `Device.SystemInfo.SupportsTypedUAVShaderLoadStoreOnGraphicsFormat` in Unity? Explain its purpose and usage.
SystemInfo.SupportsTypedUAVShaderLoadStoreOnGraphicsFormat Declaration public static bool SupportsTypedUAVShaderLoadStoreOnGraphicsFormat ( Experimental.Rendering.GraphicsFormat graphicsFormat , bool isLoad ); Description This has the same functionality as SystemInfo.SupportsTypedUAVShaderLoadStoreOnGraphics...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ccbc0629f14
unity_docs
animation
What is `Animations.AnimatorController.CreateStateMachineBehaviour` in Unity? Explain its purpose and usage.
AnimatorController.CreateStateMachineBehaviour Declaration public static int CreateStateMachineBehaviour ( MonoScript script ); Parameters Parameter Description script MonoScript class to instantiate. Returns int Returns instance id of created object, returns 0 if something is not valid. Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_821a8c36d79a
unity_docs
scripting
Show me a Unity C# example demonstrating `BoxCollider.size`.
BoxCollider.size public Vector3 size ; Description The size of the box, measured in the object's local space. Use this to return or set the size of the BoxCollider component of a GameObject. Unity measures the size in the GameObject's local space. Changing the BoxCollider size scales it by the Transform’s sc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_969f5575cab3
unity_docs
audio
What is `AudioEchoFilter.dryMix` in Unity? Explain its purpose and usage.
AudioEchoFilter.dryMix public float dryMix ; Description Volume of original signal to pass to output. 0.0 to 1.0. Default = 1.0. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioEchoFilter))] public class Example : MonoBehaviour { // Listen to only Echo (not th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0a161267741d
unity_docs
scripting
In Unity's 'Handling dependencies between AssetBundles', what is 'Script type representation in AssetBundles' and how does it work?
The MonoScript object in Unity represents a specific MonoBehaviour -derived class. This also covers classes derived from ScriptableObject. The MonoScript object records the assembly, namespace and class as strings that uniquely identify the type. When Unity serializes a MonoBehaviour object it records the GUID and LFID...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9f4917548802
github
scripting
Write a Unity C# script called Replace Child
```csharp using UnityEngine; namespace Duck.HierarchyBehaviour { public static partial class GameObjectExtensions { /// <summary> /// Destroys the child GameObject and creates a new child GameObject with the given TComponent component. /// IHierarchyBehaviour's will be initialized. /// </summary> /// <para...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_0dd17d860328
unity_docs
editor
What are the parameters of `Callbacks.RunBeforePackageAttribute.ctor` in Unity?
Description Add this attribute to a callback method to mark that this callback must be run before any callbacks that are part of the specified package. To define dependencies for a callback, use the following attributes: RunAfterClassAttribute , RunBeforeClassAttribute RunAfterAssemblyAttribute , RunBeforeAssemblyAttri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31c65be0d823
unity_docs
editor
What is `EditorWindow.CreateGUI` in Unity? Explain its purpose and usage.
EditorWindow.CreateGUI() Description CreateGUI is called when the EditorWindow's rootVisualElement is ready to be populated. Use CreateGUI to add UI Toolkit UI elements to your window. When creating a custom Editor window, follow these guidelines: Put code dependent on UXML/USS loading in the CreateGUI metho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61c94fb985fe
unity_docs
scripting
What is `Experimental.GraphView.StackNode.DragExited` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StackNode.DragExited Declaration public bool DragExited (); Returns bool Returns event propagation. Description This method is automatically called when a drag exit event occurs.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3f629beb6fbc_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Optional search scope if the object itself does not have the component.The type of the component to find.true if any object in the specified search scope has a component of type T. Signature: ```csharp public static bool Is<T>(this GameObject go, Search where = Search.InObjectOnly) where T : class ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_b8d8e79454dc
unity_docs
scripting
What is `Unity.Hierarchy.HierarchyPropertyString.GetValue` in Unity? Explain its purpose and usage.
HierarchyPropertyString.GetValue Declaration public string GetValue (ref Unity.Hierarchy.HierarchyNode node ); Parameters Parameter Description node The hierarchy node. Returns string The property value of the hierarchy node. Description Gets the property value for the given HierarchyNode .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc819089398f
unity_docs
scripting
What is `Event.isMouse` in Unity? Explain its purpose and usage.
Event.isMouse public bool isMouse ; Description Is this event a mouse event? (Read Only) ```csharp using UnityEngine;public class Example : MonoBehaviour { // Detects any mouse event void OnGUI() { Event e = Event.current; if (e.isMouse) { Debug.Log("Detected a mouse event!"); } } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72f11851ac4a
unity_docs
scripting
Give me an overview of the `Behaviour` class in Unity.
Behaviour class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.CoreModule Description Behaviours are Components that can be enabled or disabled. Additional resources: MonoBehaviour and Component . Properties Property Description enabled Enabled Behaviours are Updated, disabled ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_96eec1439703
unity_docs
physics
Give me an overview of the `SurfaceEffector2D` class in Unity.
SurfaceEffector2D class in UnityEngine / Inherits from: Effector2D / Implemented in: UnityEngine.Physics2DModule Description Applies tangent forces along the surfaces of colliders. When the source Collider2D is a trigger, the effector will apply forces whenever the target Collider2D overlaps the source. W...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bcd3d0f06aad
unity_docs
scripting
What are the parameters of `Animations.GameObjectRecorder.Bind` in Unity?
Description Binds a GameObject's property as defined by EditorCurveBinding . Use this function to bind a specific GameObject's property. The binding is defined in EditorCurveBinding . See the following example on binding the MeshRenderer.m_Enabled property. ```csharp using UnityEngine; using UnityEditor; using UnityEdi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b8278aa46de5
unity_docs
ui
In Unity's 'Bind to a list with ListView', what is 'Create the UXML template for the list items and ListView UI' and how does it work?
Create the template of the list item. Each item contains a Toggle and a TextField. Create the ListView UI, and set the item template to the template of the list item. Create a UXML file named game_switch.uxml with the following contents: ``` <ui:UXML xmlns:ui="UnityEngine.UIElements" editor-extension-mode="False"> <ui...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.