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_4892ce0af667
unity_docs
scripting
What is `UIElements.IMGUIEvent` in Unity? Explain its purpose and usage.
IMGUIEvent class in UnityEngine.UIElements / Inherits from: UIElements.EventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Class used to send a IMGUI event that has no equivalent UIElements event. Constructors Constructor Description IMGUIEvent Constructor. Use GetPooled() to get an...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f49e43a9afd3
unity_docs
input
Explain 'Bind custom controls to data' in Unity.
You bind custom controls to serialized properties to synchronize values between the control and the property. You can create a bindable custom control derived from the BaseField generic base class instead of BindableElement . This provides the following advantages: Implements the INotifyValueChanged interface for the g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f37c4be9c34
unity_docs
scripting
What are the parameters of `Video.VideoClip.GetAudioChannelCount` in Unity?
Returns ushort The number of channels. Description Returns the number of channels in the audio track. For example, if the audio track is a stereo track, this function returns 2. Video files can have multiple audio tracks for various reasons. For example, they can use different tracks to separate: different languages. a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_410a8fd94812
unity_docs
scripting
What is `ShortcutManagement.ShortcutModifiers` in Unity? Explain its purpose and usage.
ShortcutModifiers enumeration Description Represents modifier keys for use in a shortcut binding. Properties Property Description None No modifier keys. Alt Alt key (or Option key on macOS). Action Control key on Windows and Linux. Command key on macOS. Shift Shift key. Control Marks that the Control key mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_12e502114a02
unity_docs
scripting
In Unity's 'Inspecting scripts', what is 'Object reference fields' and how does it work?
As well as simple built-in C# types such as bool , string , and int , you can also make any field whose type inherits from UnityEngine.Object editable in the Inspector window. This includes all built-in component types (such as Transform , AudioSource , Camera , Light ), your own MonoBehaviour script types, and many as...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_073b1650b1b6
unity_docs
animation
Explain 'State machine basics' in Unity.
A state machine is a diagram that represents the behavior of a system or an object. This diagram consists of nodes connected by lines, similar to a flowchart. Each node represents a state and each connecting line represents a transition between states. A state machine is only in one state at a time. It remains in the s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_900a6b5b8734
unity_docs
animation
Show me a Unity C# example demonstrating `HumanTrait.MuscleName`.
HumanTrait.MuscleName public static string[] MuscleName ; Description Array of the names of all human muscle types defined by Mecanim. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { string[] muscleName = HumanTrait.MuscleName; for (int i = 0;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de8643819af6
unity_docs
math
What is `SceneVisibilityManager.DisablePicking` in Unity? Explain its purpose and usage.
SceneVisibilityManager.DisablePicking Declaration public void DisablePicking ( GameObject gameObject , bool includeDescendants ); Declaration public void DisablePicking (GameObject[] gameObjects , bool includeDescendants ); Parameters Parameter Description gameObject GameObject on which to disable pi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c1dd36459dc
unity_docs
xr
In Unity's 'Set up an Asset Store publisher profile', what is 'Create a publisher profile' and how does it work?
To create a publisher profile: Open the Asset Store Publisher Portal . Select the Profile tab. Enter the required information in each field. Select View on Asset Store to preview your publisher profile on the Asset Store.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a8d018039b9
unity_docs
scripting
What is `ShortcutManagement.ReserveModifiersAttribute.Modifiers` in Unity? Explain its purpose and usage.
ReserveModifiersAttribute.Modifiers public ShortcutManagement.ShortcutModifiers Modifiers ; Description One or more modifiers to reserve. Combines more than one modifier with the bitwise OR operator.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2511c9b342b5
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.CollisionModule.lifetimeLossMultiplier`.
ParticleSystem.CollisionModule.lifetimeLossMultiplier public float lifetimeLossMultiplier ; Description Change the lifetime loss multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall lifetime loss multiplier. ```csharp using UnityEngine; u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4cf9bdfa57ce
unity_docs
rendering
Explain 'Asset import determinism' in Unity.
Before you build assets, confirm whether the imported assets are deterministic. You can use the following tools to verify this: Use the consistency check argument : Open the Unity Editor with the following launch argument, which enables the ConsistencyChecker to record results in the Editor log: ``` -consistencyCheck `...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7f6ffc1f03fd
unity_docs
xr
In Unity's 'visionOS', what is 'Getting Started' and how does it work?
All visionOS application types require that you install the visionOS module to the Unity Editor via the Unity Hub . The visionOS module is available for Unity 2022.3.5f1+. In addition, Fully Immersive (VR) and Immersive (MR) apps require that you install extra packages. Refer to Install PolySpatial and visionOS support...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e553e34cbe10
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody2D.totalForce`.
hen using ForceMode2D.Force and not when using ForceMode2D.Impulse . During the next simulation step, the total force will be time-integrated into the Rigidbody2D.linearVelocity then automatically reset to zero . NOTE : Only a Rigidbody2D with a Dynamic Body Type will respond to force or torque. Setting this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_df0b38472dae
unity_docs
scripting
What is `RectInt.yMax` in Unity? Explain its purpose and usage.
RectInt.yMax public int yMax ; Description Shows the maximum Y value of the RectInt . Sets the maximum Y value of RectInt . If you enter a maximum value that is less than the current minimum value, then the entered value becomes the new minimum value and the previous minimum value becomes the new maximum valu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7bff307c662a
unity_docs
rendering
Explain 'Troubleshooting shadows' in Unity.
## Reduce shadow flickering Shadows might flicker if they’re far away from the camera . Refer to Understanding the View Frustum for more information. If shadows are closer to the camera than the world space origin, enable camera-relative culling. Unity uses the camera as the relative position for shadow calculations i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_64fe4db70382
unity_docs
scripting
In Unity's 'Assign tags to GameObjects', what is 'Understand built-in tags' and how does it work?
The Editor includes the following built-in tags which don’t appear in the Tag Manager: Untagged Respawn Finish EditorOnly MainCamera Player GameController Some built-in tags like MainCamera and EditorOnly have unique functions. The Editor caches GameObjects tagged with the MainCamera tag internally. When you access Cam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f9eedecfe9e9
unity_docs
rendering
Show me a Unity code example for 'Register meshes and materials with the BatchRendererGroup API in URP'.
ncludes changes you make in the first callback itself, but not changes that occur in any jobs scheduled by the callback. Modifying Mesh or Material objects after that point causes undefined behavior. See the following code sample for an example of how to register meshes and materials with a BatchRendererGroup object. T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_900f0ce2dd81
unity_docs
editor
Give me an overview of the `BuildPlayerWithProfileOptions` class in Unity.
BuildPlayerWithProfileOptions struct in UnityEditor Description Provide various options to control the behavior of BuildPipeline.BuildPlayer when using a build profile. Properties Property Description assetBundleManifestPath The path to a manifest file describing all the AssetBundles used in the build (optio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5929bba39348
unity_docs
rendering
What is `ComputeShader.SetTextureFromGlobal` in Unity? Explain its purpose and usage.
ComputeShader.SetTextureFromGlobal Declaration public void SetTextureFromGlobal (int kernelIndex , string name , string globalTextureName ); Declaration public void SetTextureFromGlobal (int kernelIndex , int nameID , int globalTextureNameID ); Parameters Parameter Description kernelIndex For which...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4431589d76f3
unity_docs
scripting
What is `UIElements.BaseListView.scrollViewWithFooterUssClassName` in Unity? Explain its purpose and usage.
BaseListView.scrollViewWithFooterUssClassName public static string scrollViewWithFooterUssClassName ; Description The USS class name for scroll view when add/remove footer is enabled. Unity adds this USS class scroll view of BaseListView when showAddRemoveFooter is set to true . Any styling applied to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b95187540de
unity_docs
scripting
What is `Experimental.GraphView.Scope.SetPosition` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Scope.SetPosition Declaration public void SetPosition ( Rect newPos ); Parameters Parameter Description newPos The new geometry. Description Sets the geometry of the Scope.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f45a4896f4f8
unity_docs
physics
What are the parameters of `Rigidbody.AddTorque` in Unity?
Description Adds a torque to the rigidbody. Force can be applied only to an active rigidbody. If a GameObject is inactive, AddTorque has no effect. The effects of the torques applied with this function are accumulated at the time of the call. The physics system applies the effects during the next simulation run (either...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2c7c50940e4a
unity_docs
scripting
In Unity's 'Set up an Audio Source component', what is 'Create an audio source from an audio file' and how does it work?
A quicker way to create an audio source is to click and drag an audio file from your Project window into the scene . As a result, Unity automatically creates a GameObject with an Audio Source component, and assigns your audio file to its Audio Clip property.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3243e8b9dcf1
unity_docs
math
What is `IMGUI.Controls.MultiColumnHeaderState.sortedColumnIndex` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.sortedColumnIndex public int sortedColumnIndex ; Description This property holds the index to the primary sorted column. This property holds the index to the primary sorted column with the default value of -1 (no sorting). Use the sortedColumns array which contains the history of the mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0df68743621c
unity_docs
scripting
What is `UIElements.TooltipEvent` in Unity? Explain its purpose and usage.
TooltipEvent class in UnityEngine.UIElements / Inherits from: UIElements.EventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Event sent to find the first VisualElement that displays a tooltip. This event can be used instead of VisualElement.tooltip to compute tooltips only when they a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1cbf132f8684
unity_docs
scripting
What is `WSA.Application.arguments` in Unity? Explain its purpose and usage.
Application.arguments public static string arguments ; Description Arguments passed to application. Arguments can be passed by secondary tiles and toast notifications. Note, that arguments are only available in XAML builds.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32f28e863621
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoPlayer.errorReceived`.
ts include: HTTP connection problems. Issues finding the file. Unsupported file types. Permission issues. Runtime issues. This is useful if you want to log errors and debug so that it’s easier to diagnose issues. You can also use it to implement fallback solutions, for example, you can display an error message o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ba10112d418
unity_docs
editor
What is `Tilemaps.Tilemap.EditorPreviewBoxFill` in Unity? Explain its purpose and usage.
Tilemap.EditorPreviewBoxFill Declaration public void EditorPreviewBoxFill ( Vector3Int position , Object tile , int startX , int startY , int endX , int endY ); Parameters Parameter Description position Position of the Tile on the Tilemap . tile Tile to place. startX The start X coordinate li...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_95c621d3d158
github
scripting
Write a Unity C# UI script for Layer Png Render Target
```csharp using System; using System.IO; using UnityEngine; using FactoryMustScale.Simulation; namespace FactoryMustScale.Visualization { /// <summary> /// Adapter-only renderer that converts terrain/factory simulation layers into a PNG image. /// Each cell becomes one pixel. Terrain is drawn first, then f...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
gh_1b14321dcc7f_doc_0
github
scripting
What does `FindNodeByPath` do in this Unity script? Explain its purpose and signature.
Returns a node with the given path (node names separated with '.') Signature: ```csharp public Node FindNodeByPath(string path) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
gh_3e3222cdb53f_doc_2
github
scripting
What does `ScaleBy` do in this Unity script? Explain its purpose and signature.
Scaling function scale both height and width by a specific amount.The by.Scale. Signature: ```csharp public static ScalingFunction ScaleBy(float scale) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_66c6cd4b7ea6
unity_docs
rendering
Give me an overview of the `DestroyAssetObjectEventArgs` class in Unity.
DestroyAssetObjectEventArgs struct in UnityEditor Description A change of this type indicates that an asset object has been destroyed. This happens for example when Undo.DestroyObjectImmediate is used with an instance of an asset (e.g. Texture ). Note that this only covers destruction of asset objects in memory...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c4bf04615550
unity_docs
performance
Explain 'Unity Profiler' in Unity.
The Unity Profiler is a tool you can use to get performance information about your application. You can connect it to devices on your network or devices connected to your computer to test how your application runs on your intended release platform. You can also run it in the Unity Editor to get an overview of resource ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe06eacc4628
unity_docs
scripting
Give me an overview of the `AndroidApplicationEntry` class in Unity.
AndroidApplicationEntry enumeration Description Options for which application entries to include when Unity generates a Gradle project. Properties Property Description Activity Include an application entry which derives from the Activity class. GameActivity Include an application entry which derives from the G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50d8ccfe18a8
unity_docs
rendering
What is `MaterialEditor.OnPreviewGUI` in Unity? Explain its purpose and usage.
MaterialEditor.OnPreviewGUI Declaration public void OnPreviewGUI ( Rect r , GUIStyle background ); Parameters Parameter Description r Rectangle in which to draw the preview. background Background image. Description Custom preview for Image component. Additional resources: ObjectPreview.OnPreviewGUI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91464b9e7bb9
unity_docs
ui
What are the parameters of `GUI.VerticalSlider` in Unity?
Returns float The value that has been set by the user. Description A vertical slider the user can drag to change a value between a min and a max. ```csharp // Draws a vertical slider control that goes from 10 (top) to 0 (bottom)using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6f12ddc2f560
unity_docs
ui
Explain 'Class selectors' in Unity.
USS class selectors match elements that have specific USS classes assigned. USS class selectors are analogous to CSS class selectors. ## Syntax A class selector consists of the class name prefixed with a period. Class names are case-sensitive and can’t begin with a numeral. ```.className { ... } ``` Only use a period...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_564e69904a5c
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.Log`.
Mathf.Log Declaration public static float Log (float f , float p ); Description Returns the logarithm of a specified number in a specified base. ```csharp using UnityEngine;public class ScriptExample : MonoBehaviour { void Start() { // logarithm of 6 in base 2 // prints 2.584963 Debug.Log(Mathf.Log(6, 2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_82d3a346066d
unity_docs
editor
Show me a Unity C# example demonstrating `Build.IPostBuildPlayerScriptDLLs.OnPostBuildPlayerScriptDLLs`.
being built. You can get assembly locations from the files property of the report parameter. Note that implementing this callback will cause builds to run slower, as assemblies need to be copied to an intermediate location, and is not recommended for best performance. Additional resources: BuildPlayerProcessor , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f34b97fee2c
unity_docs
physics
What is `RigidbodyType2D.Static` in Unity? Explain its purpose and usage.
RigidbodyType2D.Static Description Sets the Rigidbody2D to have static behaviour. Static behaviour stops the Rigidbody2D from reacting to gravity or applied forces including contacts with any other Rigidbody2D . This type of Rigidbody2D should never repositioned explicitly. It is designed to never move. A st...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4023672ee272
unity_docs
animation
What is `AnimationUtility.SetEditorCurves` in Unity? Explain its purpose and usage.
AnimationUtility.SetEditorCurves Declaration public static void SetEditorCurves ( AnimationClip clip , EditorCurveBinding[] bindings , AnimationCurve[] curves ); Parameters Parameter Description clip The animation clip to modify. binding The binding that defines the path and the properties of each curve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_555fee77974a
unity_docs
math
What are the parameters of `Quaternion.Euler` in Unity?
Returns Quaternion The Euler angle rotation specified by the angles x,y,z converted to a Quaternion. The rotation order is ZXY. Description Converts an input Euler angle rotation specified as three floats to a Quaternion. Returns a rotation that rotates z degrees around the z-axis, x degrees around the x-axis, and y de...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_06407f33e9fe
unity_docs
xr
What is `Screen` in Unity? Explain its purpose and usage.
Screen class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Provides access to display information. Use this class to get a list of supported screen resolutions, change the current resolution, or hide/show the system mouse pointer. When you launch your application, Unity immediately needs t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1136788588eb
unity_docs
scripting
What is `Camera.layerCullDistances` in Unity? Explain its purpose and usage.
Camera.layerCullDistances public float[] layerCullDistances ; Description Per-layer culling distances. Normally Camera skips rendering of objects that are further away than farClipPlane . You can set up some Layers to use smaller culling distances using layerCullDistances. This is very useful to cull small ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d5f9d370f872_doc_16
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Stores the "Head" used with continuous movement when inputs should be relative to head orientation (usually the main camera). Signature: ```csharp public Transform headForwardSource ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_72e54865bb15
unity_docs
editor
What is `AssetDatabase.GetDependencies` in Unity? Explain its purpose and usage.
AssetDatabase.GetDependencies Declaration public static string[] GetDependencies (string pathName ); Declaration public static string[] GetDependencies (string pathName , bool recursive ); Parameters Parameter Description pathName The path to the asset for which dependencies are required. recursive C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a0694052daee
unity_docs
rendering
In Unity's 'Use video sources', what is 'Reference your file as a video clip' and how does it work?
To reference a file as a video clip in the Video Player: Import your file as a video clip . Select your Video Player component. In the Video Player Inspector window, go to Source . Set Source to Video Clip . Click and drag the video clip asset into the Video Clip parameter or click the Video Clip picker to select your ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe738cf91e06
unity_docs
animation
What is `Animations.ParentConstraint.translationOffsets` in Unity? Explain its purpose and usage.
ParentConstraint.translationOffsets public Vector3[] translationOffsets ; Description The translation offsets from the constrained orientation. The translation offsets are relative to the source position local space.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_deaeb6458634
unity_docs
scripting
What is `Device.Application.Quit` in Unity? Explain its purpose and usage.
Application.Quit Declaration public static void Quit (); Declaration public static void Quit (int exitCode ); Description This has the same functionality as Application.Quit . At the moment, the Device Simulator doesn't support simulation of this method.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_efe3dc3b1e8f
unity_docs
scripting
Show me a Unity C# example demonstrating `SceneManagement.LoadSceneMode.Additive`.
de.Additive loads a Scene without unloading currently loaded Scenes. The additively loaded Scene appears in the Hierarchy window while another is active. To unload one of the currently loaded Scenes, see SceneManager.UnloadSceneAsync for more information. Additional resources: SceneManager.LoadScene . Note : If you...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0bf70ad7c33b
unity_docs
animation
What is `HumanDescription.human` in Unity? Explain its purpose and usage.
HumanDescription.human public HumanBone[] human ; Description Mapping between Mecanim bone names and bone names in the rig. Each item in the array is a HumanBone object that contains a Mecanim avatar bone name, a bone name in the model (to which the Mecanim bone is mapped) and a "muscle" that specifies the bone...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6633f3e3a288
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.IsValidNonDefaultHandle` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.IsValidNonDefaultHandle Declaration public static bool IsValidNonDefaultHandle (ref Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle ); Parameters Parameter Description handle The AtomicSafetyHandle to check. Returns bool true if the AtomicSafetyHandle has been initialized...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_678446fe0d94_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Make the object look at the xr rig's camera Signature: ```csharp public class LookAtPlayer : MonoBehaviour ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_1d903ddcf1fa
unity_docs
scripting
Show me a Unity C# example demonstrating `RenderSettings.flareFadeSpeed`.
RenderSettings.flareFadeSpeed public static float flareFadeSpeed ; Description The fade speed of all flares in the Scene. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { RenderSettings.flareFadeSpeed = 0.5f; } } ``` Additional resources: The Lighting window , LensFlare c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_835697568191
unity_docs
animation
In Unity's 'Avatar Mapping tab reference', what is 'Using Avatar Masks' and how does it work?
Sometimes it is useful to restrict an animation to specific body parts. For example, an walking animation might involve the character swaying their arms, but if they pick up a torch, they should hold it up to cast light. You can use an Avatar Body Mask to specify which parts of a character an animation should be restri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_947aad07de34
unity_docs
scripting
What is `U2D.SpriteAtlasImporter` in Unity? Explain its purpose and usage.
SpriteAtlasImporter class in UnityEditor.U2D / Inherits from: AssetImporter Description SpriteAtlasImporter imports SpriteAtlasAsset and generates SpriteAtlas. Properties Property Description includeInBuild Property to get/set whether this Sprite Atlas is marked to be included in the build. packingSettings ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_731627909bb1
unity_docs
ui
What is `IMGUI.Controls.SearchField.OnGUI` in Unity? Explain its purpose and usage.
SearchField.OnGUI Declaration public string OnGUI (string text , params GUILayoutOption[] options ); Parameters Parameter Description text Text string to display in the search field. options An optional list of layout options that specify extra layout properties. Additional resources: GUILayout.Width ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_19624e6451a7
unity_docs
scripting
Show me a Unity C# example demonstrating `WindZone.radius`.
WindZone.radius public float radius ; Description Radius of the Spherical Wind Zone (only active if the WindZoneMode is set to Spherical). ```csharp // Creates a Spherical Wind Zone and sets its radius to 10. using UnityEngine;public class ExampleScript : MonoBehaviour { void Start() { var wind = gameObject...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_944db19e6d67
unity_docs
rendering
What is `RenderTexture.IsCreated` in Unity? Explain its purpose and usage.
RenderTexture.IsCreated Declaration public bool IsCreated (); Description Is the render texture actually created? RenderTexture constructor does not actually create the hardware texture; by default the texture is created the first time it is set active . IsCreated returns true if the hardware resources fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f102f864f48
unity_docs
rendering
What is `Rendering.CommandBuffer.SetGlobalColor` in Unity? Explain its purpose and usage.
CommandBuffer.SetGlobalColor Declaration public void SetGlobalColor (string name , Color value ); Declaration public void SetGlobalColor (int nameID , Color value ); Description Add a "set global shader color property" command. When the command buffer will be executed, a global shader color property...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59ab94898577
unity_docs
input
Give me an overview of the `HierarchyDropFlags` class in Unity.
HierarchyDropFlags enumeration Description Define how dragged objects should be dropped relative to already existing Hierarchy items. Properties Property Description None Insert dragged object in the Hierarchy. The default flag value is 0. The only case in which DropMode is 0 is when dragging outside items and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f90573b8a94
unity_docs
math
What are the parameters of `GeometryUtility.TryCreatePlaneFromPolygon` in Unity?
Returns bool Returns true on success, false if Unity did not create a plane from the vertices. Description GeometryUtility.TryCreatePlaneFromPolygon creates a plane from the given list of vertices that define the polygon, as long as they do not characterize a straight line or zero area. There must be at least three ver...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d7371d2d218
unity_docs
editor
What is `SceneManagement.Scene.IsValid` in Unity? Explain its purpose and usage.
Scene.IsValid Declaration public bool IsValid (); Returns bool Whether this is a valid Scene. Description Whether this is a valid Scene. A Scene may be invalid if, for example, you tried to open a Scene that does not exist. In this case, the Scene returned from EditorSceneManager.OpenScene would return Fal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc4b69e7c815
unity_docs
math
What is `Quaternion.Slerp` in Unity? Explain its purpose and usage.
Quaternion.Slerp Declaration public static Quaternion Slerp ( Quaternion a , Quaternion b , float t ); Parameters Parameter Description a Start unit quaternion value, returned when t = 0. b End unit quaternion value, returned when t = 1. t Interpolation ratio. Value is clamped to the range [0, 1]...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e8f806ffb48
unity_docs
scripting
Show me a Unity C# example demonstrating `Object.FindAnyObjectByType`.
), or inactive objects. It also doesn't return objects that have HideFlags.DontSave set. Note : The object that this function returns isn't guaranteed to be the same between calls, but it is always of the specified type. This function is faster than Object.FindFirstObjectByType if you don't need a specific object i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_568662abbb62
unity_docs
rendering
What is `Rendering.SupportedRenderingFeatures.enlighten` in Unity? Explain its purpose and usage.
SupportedRenderingFeatures.enlighten public bool enlighten ; Description Determines if Enlighten Realtime Global Illumination lightmapper is supported by the currently selected pipeline. If it is not supported, Enlighten-specific settings do not appear in the Editor, which then defaults to the CPU Lightmapper.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fa2ccdd632d3
unity_docs
rendering
In Unity's 'Respond to events with custom controls', what is 'Override the HandleEventBubbleUp or HandleEventTrickleDown virtual methods' and how does it work?
A virtual method override applies to all instances of the class. For a class that overrides HandleEventBubbleUp or HandleEventTrickleDown , you can also register callbacks on its instances. To override the HandleEventBubbleUp or HandleEventTrickleDown methods, or both, derive a new subclass of VisualElement . HandleEve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_487463a5f570
unity_docs
scripting
What is `Search.SearchProvider.fetchPropositions` in Unity? Explain its purpose and usage.
SearchProvider.fetchPropositions public Func<SearchContext,SearchPropositionOptions,IEnumerable<SearchProposition>> fetchPropositions ; Description Handler used to enumerate search propositions when the user is using TAB to auto-complete a query. ``` IEnumerable<SearchProposition> FetchPropositions(SearchContex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b97da2dd3cf5
unity_docs
scripting
Give me an overview of the `AsyncInstantiateOperation_1` class in Unity.
AsyncInstantiateOperation<T0> class in UnityEngine / Inherits from: AsyncInstantiateOperation / Implemented in: UnityEngine.CoreModule Description Provides a generic method to instantiate operations asynchronously on a UnityEngine.Object. The operation is returned by Object.InstantiateAsync. Properties Prop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8e1fc413516
unity_docs
scripting
What is `Search.SearchViewState.LoadDefaults` in Unity? Explain its purpose and usage.
SearchViewState.LoadDefaults Declaration public static Search.SearchViewState LoadDefaults (); Returns SearchViewState New search view state that can be used to open a new search window. Description Returns a newly created default search view state. See SearchService.ShowWindow .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b91543244db9
unity_docs
rendering
Give me an overview of the `Gyroscope` class in Unity.
Gyroscope class in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Interface into the Gyroscope. Use this class to access the gyroscope. The example script below shows how the Gyroscope class can be used to view the orientation in space of the device. Underlying sensors used for data pop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_595559a9dea1
unity_docs
math
Show me a Unity C# example demonstrating `SerializedPropertyType.Generic`.
ropertyType enum value. For example RectOffset is Generic, but Vector3 is SerializedPropertyType.Vector3 . Note: The term Generic, when used as a SerializedProperty type, should not be confused with the unrelated C# feature of Generic classes and methods. Additional resources: SerializedProperty.isArray , Ser...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_29339e76eb26
unity_docs
rendering
Explain 'Wind' in Unity.
com.unity.modules.wind ## Description The Wind module implements the WindZone component which can affect terrain rendering and particle simulations. ## Version information Built-in packages are fixed to a single version matching the Editor version.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4d9f588ac44d
unity_docs
rendering
Explain 'An example of a YAML scene file' in Unity.
An example of a simple but complete scene is given below. The scene contains just a camera and a cube object. Note that the file must start with the two lines ``` %YAML 1.1 %TAG !u! tag:unity3d.com,2011: ``` …in order to be accepted by Unity. Otherwise, the import process is designed to be tolerant of omissions - defau...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7df3e41eeeda
unity_docs
scripting
Give me an overview of the `Cloth` class in Unity.
Cloth class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.ClothModule Description The Cloth class provides an interface to cloth simulation physics. Properties Property Description bendingStiffness Bending stiffness of the cloth. capsuleColliders An array of CapsuleColliders whi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e52982bd646
unity_docs
editor
What is `PlayerSettings.WSA.GetVisualAssetsImage` in Unity? Explain its purpose and usage.
PlayerSettings.WSA.GetVisualAssetsImage Declaration public static string GetVisualAssetsImage ( PlayerSettings.WSAImageType type , PlayerSettings.WSAImageScale scale ); Parameters Parameter Description type UWP Logo type to retrieve the Asset name for. scale UWP Scale type to retrieve the Asset name...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_579fccbbaaf4
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.pixelWidth`.
Camera.pixelWidth public int pixelWidth ; Description How wide is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only). Use this to return how wide the Camera viewport is in pixels. This is read-only. ```csharp //Attach this script to an empty GameObject //Create a new Camera (Crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f410890457b
unity_docs
rendering
Give me an overview of the `GL` class in Unity.
GL class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Low-level graphics library. Use this class to manipulate active transformation matrices, issue rendering commands similar to OpenGL's immediate mode and do other low-level graphics tasks. Note that in almost all cases using Graphics.R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03b5bf791ad7
unity_docs
rendering
Show me a Unity C# example demonstrating `CubemapArray.GetPixels`.
mpress compressed textures, and use memory to store the decompressed area. To get pixel data more quickly, use GetPixelData instead. If GetPixels fails, Unity throws an exception. GetPixels might fail if the array contains too much data. Use GetPixelData instead for very large textures. You can't use GetPixel ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5d4a825dd915
unity_docs
scripting
Explain 'Manage components and their values' in Unity.
The Inspector window displays the components attached to a GameObject. You can add, remove, and rearrange components, and edit their values. This section explains how to edit and manage component properties. To learn more about using components in a GameObject, refer to Components . Topic Description Manage references ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e7f34e998d69
unity_docs
performance
What is `Unity.Collections.NativeArray_1.ReinterpretStore` in Unity? Explain its purpose and usage.
NativeArray<T0>.ReinterpretStore Declaration public void ReinterpretStore (int destIndex , U data ); Parameters Parameter Description destIndex Index in the underlying array where the data is to be stored. data The data to store. Description Reinterpret and store data starting at underlying index as a d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b35b8d9f8e2
unity_docs
rendering
What is `SystemInfo.supportsCompressed3DTextures` in Unity? Explain its purpose and usage.
SystemInfo.supportsCompressed3DTextures public static bool supportsCompressed3DTextures ; Description Are compressed formats for 3D (volume) textures supported? (Read Only). Not all graphics APIs and platforms support compressed Texture3D textures, for example Metal on macOS before 10.15 does not. Additional ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37f8cfa0d225
unity_docs
scripting
Show me a Unity C# example demonstrating `Unity.IO.Archive.ArchiveFileInterface`.
ackage. The data.unity3d file generated when BuildPipeline.BuildPlayer is called with BuildOptions.CompressWithLz4 or BuildOptions.CompressWithLz4HC is also an archive file. In that case the ArchiveFileInterface API is not normally needed, because the contents of the archive are automatically available in th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_864757f8b74a
github
scripting
Write a Unity C# ScriptableObject for Ray Neo Extension Info
```csharp using UnityEngine; using FfalconXR; using System.Linq; using System; using System.Collections.Generic; using System.IO; #if UNITY_EDITOR using UnityEditor; #endif using Unity.Collections; namespace RayNeo { //[CreateAssetMenu(fileName = "RayNeoGeneralSettings", menuName = "RayNeo/RayNeo")] public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_43216157a337
unity_docs
physics
What is `Diagnostics.ForcedCrashCategory.AccessViolation` in Unity? Explain its purpose and usage.
ForcedCrashCategory.AccessViolation Description Cause a crash by performing an invalid memory access. The invalid memory access is performed on each platform as follows: OSX, Android : Invoked using raise(SIGSEGV) ; Windows, Windows Store : Invoked using RaiseException with EXCEPTION_ACCESS_VIOLATION Other : Inv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6d4385f673c
unity_docs
ui
What is `UIElements.UQueryExtensions` in Unity? Explain its purpose and usage.
UQueryExtensions class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description UQuery is a set of extension methods allowing you to select individual or collection of visualElements inside a complex hierarchy. For more information, refer to Find visual elements with UQuery . St...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32b8bff6069a
unity_docs
rendering
What is `Rendering.VertexAttributeFormat.Float16` in Unity? Explain its purpose and usage.
VertexAttributeFormat.Float16 Description 16-bit float number. This format matches the "FP16" or "half" data type in graphics APIs or shader languages. It is a floating-point number with 1 sign bit, 5 exponent bits, and 10 explicitly stored significand bits. Additional resources: Mesh class, VertexAttribute enu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_743fbac4f91a
unity_docs
rendering
What is `Mesh.GetBoneWeightBuffer` in Unity? Explain its purpose and usage.
Mesh.GetBoneWeightBuffer Declaration public GraphicsBuffer GetBoneWeightBuffer ( SkinWeights layout ); Parameters Parameter Description layout Which buffer to access, based on maximum bones per vertex. Returns GraphicsBuffer The bone weight data as a GraphicsBuffer . Description Retrieves a Gra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_573b1839e038
unity_docs
math
What is `Transform.InverseTransformVectors` in Unity? Explain its purpose and usage.
Transform.InverseTransformVectors Parameters Parameter Description vectors The vectors to be transformed, each is replaced by the transformed version. Description Transforms multiple vectors from world space to local space overwriting each original position with the transformed version. The opposite of Transf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28e0c808e750
unity_docs
physics
What is `WheelCollider.forceAppPointDistance` in Unity? Explain its purpose and usage.
WheelCollider.forceAppPointDistance public float forceAppPointDistance ; Description Application point of the suspension and tire forces measured from the base of the resting wheel. This is specified as a distance along the local up vector of the vehicle's rigid body from the base of the wheel at its rest coor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6cfe79ce0c6f
unity_docs
rendering
What is `Rendering.VirtualTexturing.Resolver` in Unity? Explain its purpose and usage.
Virtual Texturing is experimental and not ready for production use. The feature and documentation might be changed or removed in the future. Resolver class in UnityEngine.Rendering.VirtualTexturing / Implemented in: UnityEngine.VirtualTexturingModule Description Class responsable for virtual texturing feedback ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9693a01e5ced
unity_docs
editor
Show me a Unity C# example demonstrating `IMGUI.Controls.PrimitiveBoundsHandle.axes`.
PrimitiveBoundsHandle.axes public IMGUI.Controls.PrimitiveBoundsHandle.Axes axes ; Description Flags specifying which axes should display control handles. By default, all axes are enabled. You can use bitwise operations to enable or disable individual axes. Disabled axes are flattened out. ```csharp using Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_af295a0cbccb
unity_docs
networking
Explain 'Web networking' in Unity.
You can use networking in Web in the following ways: Use the UnityWebRequest class. Use the Unity Netcode networking package . ## Use the UnityWebRequest class in Web Unity supports the UnityWebRequest class in Web. To implement the UnityWebRequest class, Unity uses the JavaScript Fetch API, which uses the browser to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32e4ab76c2de
unity_docs
scripting
What is `UIElements.BaseVerticalCollectionView.selectedIndices` in Unity? Explain its purpose and usage.
BaseVerticalCollectionView.selectedIndices public IEnumerable<int> selectedIndices ; Description Returns the indices of selected items in the data source. Always returns an enumerable, even if no item is selected, or a single item is selected. In a tree, if a child item is collapsed, its index is not inclu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_347af9c08af8
unity_docs
audio
What is `Audio.AudioPlayableOutput.SetEvaluateOnSeek` in Unity? Explain its purpose and usage.
AudioPlayableOutput.SetEvaluateOnSeek Declaration public void SetEvaluateOnSeek (bool value ); Parameters Parameter Description value Set to true to play the output when seeking. Set to false to disable audio scrubbing on this output. Default is true. Description Controls whether the output should play whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_934c984422ba
unity_docs
editor
What is `iOS.Xcode.PBXProject.InsertCopyFilesBuildPhase` in Unity? Explain its purpose and usage.
PBXProject.InsertCopyFilesBuildPhase Declaration public string InsertCopyFilesBuildPhase (int index , string targetGuid , string name , string dstPath , string subfolderSpec ); Parameters Parameter Description index The position at which to insert the new build phase. If it's higher than the total number...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6cf0e165de53
unity_docs
physics
What are the parameters of `Collider2D.Overlap` in Unity?
Returns int Returns the number of results placed in the results list. Description Get a list of all Colliders that overlap this Collider. The integer return value is the number of Colliders that overlap this Collider with the specific Colliders stored in the supplied list. The results list will be resized if it doesn't...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4b1844d40f95
unity_docs
rendering
In Unity's 'Upgrade material assets to URP or HDRP', what is 'Upgrade BiRP materials to URP' and how does it work?
To upgrade all material assets from BiRP to URP: Back up your Built-in Render Pipeline material assets. In your URP project, go to Window > Rendering > Render Pipeline Converter . In the Render Pipeline Converter window, select Built-in to URP from the drop-down, enable Material Upgrade , then select Initialize and Con...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_017c64b41f42
unity_docs
scripting
What is `Projector` in Unity? Explain its purpose and usage.
Projector class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.CoreModule Description A script interface for a projector component . The Projector can be used to project any material onto the Scene - just like a real world projector. The properties exposed by this class are an exact...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.