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
gh_93ea6090a3cf_doc_0
github
scripting
What does `EditorScriptGeneratorSettings` do in this Unity script? Explain its purpose and signature.
EditorScriptGenerator settings ref Signature: ```csharp public EditorScriptGeneratorSettings EditorScriptGeneratorSettings => _editorScriptGeneratorSettings; ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e56503d5b2d9
unity_docs
scripting
What is `YieldInstruction` in Unity? Explain its purpose and usage.
YieldInstruction class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Base class for all yield instructions. See WaitForSeconds , WaitForFixedUpdate , Coroutine and MonoBehaviour.StartCoroutine for more information.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57713fe08ad7
unity_docs
math
What is `BillboardAsset.SetIndices` in Unity? Explain its purpose and usage.
BillboardAsset.SetIndices Declaration public void SetIndices (ushort[] indices ); Declaration public void SetIndices (List<ushort> indices ); Parameters Parameter Description indices The array of data to set. Description Set the indices of the billboard mesh. Additional resources: BillboardAsset , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dcf81060532b
unity_docs
input
What is `UIElements.Experimental.PointerUpLinkTagEvent` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PointerUpLinkTagEvent class in UnityEngine.UIElements.Experimental / Inherits from: UIElements.PointerEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description This event is sent when a pointer's last pressed ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bc2a2a9f0c6
unity_docs
scripting
What is `Vector2.operator_multiply` in Unity? Explain its purpose and usage.
Vector2.operator * public static Vector2 operator * ( Vector2 a , float d ); Description Multiplies a vector by a number. Multiplies each component of a by a number d . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { // make the vector twice longer: prints (2.0,4.0)...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5cd2f0f9dfcf
unity_docs
rendering
Explain 'LOD directive in ShaderLab reference' in Unity.
This page contains information on using a LOD block in your ShaderLab code to assign a LOD (level of detail) value to a SubShader. ## Render pipeline compatibility Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline ShaderLab: SubShader LOD block Yes...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f92add6efb69
unity_docs
scripting
What is `AssetImporters.ImportLog` in Unity? Explain its purpose and usage.
ImportLog class in UnityEditor.AssetImporters / Inherits from: Object Description Container class that holds the collection of logs generated by an importer during the import process. Additional resources: AssetImportContext.LogImportError , AssetImportContext.LogImportWarning . Properties Property Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0bd362368830
unity_docs
physics
What is `Joint2D.enableCollision` in Unity? Explain its purpose and usage.
Joint2D.enableCollision public bool enableCollision ; Description Should the two Rigidbody2D connected with this joint collide with each other? When this is disabled, the two Rigidbody2D connected with this joint will never produce collision or trigger contacts with each other. When this is enabled, the Ri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6392b2814369
unity_docs
ui
Show me a Unity C# example demonstrating `GUILayout.AreaScope`.
Area is called when the instance is disposed. By default, any GUI controls made using GUILayout are placed in the top-left corner of the screen. If you want to place a series of automatically laid out controls in an arbitrary area, use GUILayout.BeginArea to define a new area for the automatic layouting system to us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bab8566a0539
unity_docs
math
What is `Vector3Int.ToString` in Unity? Explain its purpose and usage.
Vector3Int.ToString Declaration public string ToString (); Declaration public string ToString (string format ); Declaration public string ToString (string format , IFormatProvider formatProvider ); Parameters Parameter Description format A numeric format string. formatProvider An object that spec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_3d13c89661d4_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Gets the total count of entries in the dictionary. Signature: ```csharp public abstract int Count ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_43be7be71cd2
unity_docs
scripting
What is `UIElements.MultiColumnListView.columnSortingChanged` in Unity? Explain its purpose and usage.
MultiColumnListView.columnSortingChanged Description If a column is clicked to change sorting, this event is raised to allow users to sort the list view items. For a default implementation, set sortingMode to ColumnSortingMode.Default .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b7b05f560114
unity_docs
rendering
What is `Device.SystemInfo.supportsTextureWrapMirrorOnce` in Unity? Explain its purpose and usage.
SystemInfo.supportsTextureWrapMirrorOnce public static int supportsTextureWrapMirrorOnce ; Description This has the same functionality as SystemInfo.supportsTextureWrapMirrorOnce and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a04ffdec39d
unity_docs
math
What is `Tilemaps.ITilemap.GetTile` in Unity? Explain its purpose and usage.
ITilemap.GetTile Declaration public Tilemaps.TileBase GetTile ( Vector3Int position ); Parameters Parameter Description position Position of the Tile on the Tilemap . Returns TileBase Tile placed at the cell. Description Gets the Tile at the given XYZ coordinates of a cell in the Tilemap . Us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_826ac7827277
unity_docs
rendering
What is `Rendering.BatchDrawCommandIndirect` in Unity? Explain its purpose and usage.
BatchDrawCommandIndirect struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Represents an indirect draw command for a BatchRendererGroup . This type of draw command has a reference to both a material and a mesh. The actual draw data to be used is passed by the GPU in the bu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1e6b12e28554_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Unity Editor class which registers Project Validation rules for the Hands Interaction Demo sample,checking that other required samples and packages are installed. Signature: ```csharp static class HandsInteractionSampleProjectValidation ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a97a75605f8e
unity_docs
scripting
What is `Grid.GetCellCenterLocal` in Unity? Explain its purpose and usage.
Grid.GetCellCenterLocal Declaration public Vector3 GetCellCenterLocal ( Vector3Int position ); Parameters Parameter Description position Grid cell position. Returns Vector3 Center of the cell transformed into local space coordinates. Description Get the logical center coordinate of a grid cell in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b970de48426d
unity_docs
scripting
What is `MeshUtility.GetMeshCompression` in Unity? Explain its purpose and usage.
MeshUtility.GetMeshCompression Declaration public static ModelImporterMeshCompression GetMeshCompression ( Mesh mesh ); Parameters Parameter Description mesh The mesh to get information on. Description Returns the mesh compression setting for a Mesh.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bffa58a5dfb2
unity_docs
networking
What is `Unity.Android.Gradle.Manifest.UIOptions` in Unity? Explain its purpose and usage.
UIOptions enumeration Description Mirrors the UIOptions enum. For more information about the attribute, see Android's documentation: UIOptions attribute Properties Property Description Null Attribute is not set and will not appear in the element. None Mirrors android:uiOptions="none". SplitActionBarWhen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c24f01e803f6
unity_docs
scripting
What is `WSA.SecondaryTileData.showNameOnSquare310x310Logo` in Unity? Explain its purpose and usage.
SecondaryTileData.showNameOnSquare310x310Logo public bool showNameOnSquare310x310Logo ; Description Defines whether the displayName should be shown on a large secondary tile. Defaults to false.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0389a5ff9b05
unity_docs
xr
What is `PackageManager.Requests.SearchRequest` in Unity? Explain its purpose and usage.
SearchRequest class in UnityEditor.PackageManager.Requests / Inherits from: PackageManager.Requests.Request_1 Description Represents an asynchronous request to find a package. The PackageManager Client class returns a SearchRequest instance when you call the Client.Search method to find a package or the C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8651bd15cbbc
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeaderState.Column.contextMenuText` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.Column.contextMenuText public string contextMenuText ; Description If this is set then it is used for the context menu for toggling visibility, if not set then the ::headerContent is used. This is usefull if the header content only contains an icon or if another text is wanted in the cont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_037e13fd916a
unity_docs
scripting
Explain 'Mouse events' in Unity.
Mouse events occur when you interact with the UI using a mouse. Touch, pens, or other pointing devices generate other events, not mouse events. In the Mouse event APIs and in this documentation, the term “mouse” refers only to a physical mouse or a virtual mouse that emulates a physical mouse. Mouse events are always p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0e1aafbb9c0
unity_docs
rendering
What is `Camera.cameraType` in Unity? Explain its purpose and usage.
Camera.cameraType public CameraType cameraType ; Description Identifies what kind of camera this is, using the CameraType enum. Regular cameras in your scene have a value of CameraType.Game , both at runtime and in the Unity Editor. Cameras that render different parts of the Unity Editor have other values...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c82e468df540
unity_docs
rendering
What is `MaterialEditor.FloatProperty` in Unity? Explain its purpose and usage.
MaterialEditor.FloatProperty Declaration public float FloatProperty ( MaterialProperty prop , string label ); Declaration public float FloatProperty ( Rect position , MaterialProperty prop , string label ); Parameters Parameter Description label Label for the property. Description Draw a proper...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7deb0e4d72be
unity_docs
scripting
Show me a Unity C# example demonstrating `Rendering.SplashScreen.StopBehavior.StopImmediate`.
SplashScreen.StopBehavior.StopImmediate Description Immediately stop rendering the SplashScreen. ```csharp using System.Collections; using UnityEngine; using UnityEngine.Rendering;// This example shows how the Splash Screen can be canceled early via the user pressing any key. public class Example : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47f551a94b40
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.ReleaseCachedFileHandles`.
AssetDatabase.ReleaseCachedFileHandles Declaration public static void ReleaseCachedFileHandles (); Description Calling this function will release file handles internally cached by Unity. This allows modifying asset or meta files safely thus avoiding potential file sharing IO errors. ```csharp using System.IO; u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d6a53ec07a1
unity_docs
rendering
What is `Rendering.RayTracingAccelerationStructure.Settings` in Unity? Explain its purpose and usage.
Settings struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Defines whether Unity or the user updates a RayTracingAccelerationStructure. Also provides additional filtering and acceleration structure build options. Properties Property Description buildFlagsDynamicGeometries T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c75044d839a4
unity_docs
scripting
What are the parameters of `Search.IQueryEngineFilter.AddOrUpdateMetaInfo` in Unity?
Returns IQueryEngineFilter The current filter. Description Add or update additional information specific to the filter. You can use this function to add additional information on the filter. ``` // Add a description to the filter var descriptionKey = "desc"; var descriptionValue = "This filters the objects based on the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3585c4c12e50
unity_docs
scripting
What is `SimulationMode` in Unity? Explain its purpose and usage.
SimulationMode enumeration Description A selection of modes that control when Unity executes the physics simulation. Additional resources: Physics.simulationMode . ```csharp // SimulationMode.FixedUpdate is the default setting in Unity. // Attach this script to a gameObject and enter runtime mode.using UnityEngi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_da08719e1753
unity_docs
rendering
In Unity's 'Mesh LOD', what is 'LOD levels' and how does it work?
A LOD level is a mesh that defines the level of detail Unity renders for a GameObject’s geometry. When a GameObject uses LOD, Unity displays the appropriate LOD level for that GameObject based on the GameObject’s distance from the Camera. Each LOD level exists in a separate GameObject, each of which has a Mesh Renderer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6bc035bfc180
unity_docs
physics
Show me a Unity C# example demonstrating `Collider2D.OnCollisionExit2D`.
der on another object stops touching this object's collider (2D physics only). Further information about the objects involved is reported in the Collision2D parameter passed during the call. Notes: Collision events will be sent to disabled MonoBehaviours, to allow enabling Behaviours in response to collisions. Additio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e7faf7f4483a
unity_docs
ui
Show me a Unity code example for 'Find visual elements with UQuery'.
x , Children , and Where . Q is the shorthand for Query<T>.First() . It returns the first element that matches the selection rules. ## Query elements You can query elements by their name , their USS class , or their element type (C# type) . You can also query with a predicate or make complex hierarchical queries . Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5b84ee9acb27
unity_docs
physics
What is `ArticulationBody.SetDriveForceLimit` in Unity? Explain its purpose and usage.
ArticulationBody.SetDriveForceLimit Declaration public void SetDriveForceLimit ( ArticulationDriveAxis axis , float value ); Parameters Parameter Description axis The drive axis. value The value to set the force limit to. Description Sets the force limit of the specified drive. Additional resources: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8c6b3b69a32f
unity_docs
scripting
Explain 'Customize dependencies' in Unity.
Use custom version of a dependency based on the requirement of your project. It’s recommended to use the Unity Hub to install Android SDK & NDK tools and OpenJDK to ensure that you receive the correct versions and configurations. However, there are situations where you might want to change the SDK, NDK, or JDK version ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_706c3d856e70
unity_docs
editor
What is `iOS.Xcode.PBXProject.GetHeadersBuildPhaseByTarget` in Unity? Explain its purpose and usage.
PBXProject.GetHeadersBuildPhaseByTarget Declaration public string GetHeadersBuildPhaseByTarget (string targetGuid ); Parameters Parameter Description targetGuid The GUID of the target, such as one returned by TargetGuidByName . Returns string Returns the GUID of the existing phase or null if it does n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2e968c5fa840
unity_docs
scripting
What is `ParticleSystem.MainModule.simulationSpeed` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.simulationSpeed public float simulationSpeed ; Description Override the default playback speed of the Particle System. Useful for speeding up or slowing down the entire simulation. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6a854106392
unity_docs
animation
Show me a Unity C# example demonstrating `Animations.AnimationHumanStream.SolveIK`.
AnimationHumanStream.SolveIK Declaration public void SolveIK (); Description Execute the IK solver. The humanoid IK solver is executed using the IK goal position, rotation, and weight currently set in the AnimationHumanStream . ```csharp using UnityEngine; using UnityEngine.Playables; using UnityEngine.Animat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_009130a8c373
unity_docs
scripting
Explain 'Load Light Probes in multiple scenes' in Unity.
Unity updates its Light Probe data differently depending on how you load or unload Scenes . Unity uses a LightProbes C# object to store Light Probe data for all currently loaded Scenes. The LightProbes object contains an internal data structure called a tetrahedral tessellation. Unity uses the tetrahedral tessellation ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7c8ce2617e02
unity_docs
editor
In Unity's 'Additional files for Roslyn analyzers and source generators', what is 'Naming additional files' and how does it work?
To be passed to the compilation pipeline, files must be named according to the format Filename.[Analyzer Name].additionalfile . Files that lack the [Analyzer Name] component are imported but not passed to the compilation pipeline. The [Analyzer Name] component is case-sensitive and must match the name of the analyzer t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb23907b7ab2
unity_docs
animation
What is `Animations.TransformSceneHandle.GetLocalScale` in Unity? Explain its purpose and usage.
TransformSceneHandle.GetLocalScale Declaration public Vector3 GetLocalScale ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that manages this handle. Returns Vector3 The scale of the transform relative to the parent. Description Gets the scale of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bb49fe6ea0b3
unity_docs
rendering
Explain 'Profiler Preferences reference' in Unity.
The Preferences window contains additional Profiler window settings. To open the Preferences window go to menu: Unity > Settings > Analysis > Profiler . ## Profiler settings Adjust the settings to customize how the Profiler collects and displays data. Setting Description Frame count Set the maximum number of frames f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2e501d66ce40
unity_docs
rendering
Show me a Unity code example for 'Managing importers with scripts'.
ters. You can manipulate import settings, analyze imported assets, or generate new assets dynamically during import. Refer to Supported asset type reference for a full list of built in importers available. The following is an example of an AssetPostprocessor script that modifies the import settings of a texture before ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c844a1640712
unity_docs
physics
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.EnforceAllBufferJobsHaveCompletedAndRelease` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.EnforceAllBufferJobsHaveCompletedAndRelease Declaration public static Unity.Collections.LowLevel.Unsafe.EnforceJobResult EnforceAllBufferJobsHaveCompletedAndRelease ( Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle ); Parameters Parameter Description handle The AtomicSafetyH...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a426fcaf7b2
unity_docs
scripting
What is `Vector3.forward` in Unity? Explain its purpose and usage.
Vector3.forward public static Vector3 forward ; Description Shorthand for writing Vector3(0, 0, 1) . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { transform.position += Vector3.forward * Time.deltaTime; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2cba312d934
unity_docs
scripting
What is `AI.NavMesh.GetSettingsCount` in Unity? Explain its purpose and usage.
NavMesh.GetSettingsCount Declaration public static int GetSettingsCount (); Returns int The number of registered entries. Description Returns the number of registered NavMesh build settings. This will always be at least one available, namely the default setting. Additional resources: NavMeshBuildSettings...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a14e8ec16ae
unity_docs
editor
What is `EditorWindow.Update` in Unity? Explain its purpose and usage.
EditorWindow.Update() Description Called multiple times per second on all visible windows. This callback is triggered from EditorApplication.update . ```csharp // The window appears in front of the Editor. // The window shows the type of a Unity object the cursor is over. using UnityEngine; using UnityEditor; us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_03ce23bc6bf2
unity_docs
rendering
Explain 'Custom Editor block in ShaderLab reference' in Unity.
This page contains information on using a CustomEditor or CustomEditorForRenderPipeline block in your ShaderLab code to assign custom editors . ## Render pipeline compatibility Feature name Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Built-in Render Pipeline ShaderLab: CustomEdit...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3d4d22319c97
unity_docs
scripting
What is `Transform.Rotate` in Unity? Explain its purpose and usage.
Transform.Rotate Description Use Transform.Rotate to rotate GameObjects in a variety of ways. The rotation is often provided as an Euler angle and not a Quaternion. You can specify a rotation in world axes or local axes. World axis rotation uses the coordinate system of the Scene , so when you start rotate a Gam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7fbc5fd5ab89
unity_docs
math
Show me a Unity C# example demonstrating `Rigidbody.ClosestPointOnBounds`.
Rigidbody.ClosestPointOnBounds Declaration public Vector3 ClosestPointOnBounds ( Vector3 position ); Description The closest point to the bounding box of the attached colliders. ```csharp // Subtract damage from a character's hit points when an // explosion occurs.using UnityEngine; using System.Collection...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e17f887b950
unity_docs
rendering
What is `TextureImporter.flipGreenChannel` in Unity? Explain its purpose and usage.
TextureImporter.flipGreenChannel public bool flipGreenChannel ; Description Indicates whether to invert the green channel values of a normal map. Inverting the green (Y) channel values of a normal map is useful if the normal map uses a different convention to what Unity expects. If the normal map conventions r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f986a8955b01
unity_docs
physics
What is `BuildPipeline.isBuildingPlayer` in Unity? Explain its purpose and usage.
BuildPipeline.isBuildingPlayer public static bool isBuildingPlayer ; Description Is a player currently being built? This returns true during Player builds and AssetBundle builds. It can be used to check the context inside script code that could be triggered during a build, for example when ExecuteAlways is b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61e1c3ba3c3e
unity_docs
scripting
What is `ObjectChangeEventStream.Builder` in Unity? Explain its purpose and usage.
Builder struct in UnityEditor Description Provides a way to construct an instance of ObjectChangeEventStream . Properties Property Description eventCount The number of events that have been recorded in this instance so far. Constructors Constructor Description ObjectChangeEventStream.Builder Constructs a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cbfa9be3bd2f
unity_docs
scripting
What is `Networking.UploadHandlerFile` in Unity? Explain its purpose and usage.
UploadHandlerFile class in UnityEngine.Networking / Inherits from: Networking.UploadHandler / Implemented in: UnityEngine.UnityWebRequestModule Description A specialized UploadHandler that reads data from a given file and sends raw bytes to the server as the request body. You can use it to send a large amount...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6122d2291287
unity_docs
editor
Give me an overview of the `CustomPreviewAttribute` class in Unity.
CustomPreviewAttribute class in UnityEditor Description Adds an extra preview in the Inspector for the specified type. You can use this attribute to add your custom preview to any object that can be Inspected. Constructors Constructor Description CustomPreviewAttribute Tells a DefaultPreview which class it's ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a51810b6b00d
unity_docs
editor
What is `Experimental.GraphView.EdgeDragHelper.HandlePointerUp` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. EdgeDragHelper.HandlePointerUp Declaration public void HandlePointerUp ( UIElements.PointerUpEvent evt ); Parameters Parameter Description evt The pointer up event. Description Handles when the pointer is released duri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e672d58595e2
github
scripting
Write a Unity C# MonoBehaviour script called Simple Behaviour
```csharp namespace AncientLightStudios.Nanoject.Tests { using AncientLightStudios.Nanoject; using UnityEngine; public class SimpleBehaviour : MonoBehaviour { public SimpleService SimpleService { get; private set; } [LateInit] public void SetUp(SimpleService simpleS...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3b871a7ed661
unity_docs
rendering
In Unity's 'Terrain Settings reference', what is 'Basic Settings' and how does it work?
Property Description Grouping ID The ID the tile uses for Auto connect . Only tiles with the same grouping ID can connect. Auto Connect Automatically connect to neighboring tiles that have the same Grouping ID . Reconnect If you change the Grouping ID of a tile, or disable Auto Connect for one or more tiles, you might ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c67499cecd06
unity_docs
rendering
What is `Experimental.GlobalIllumination.LightType.SpotBoxShape` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. LightType.SpotBoxShape Description A box-shaped spot light. This type is only compatible with Scriptable Render Pipelines; it is not compatible with the built-in render pipeline.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4fd3b8c1c62
unity_docs
networking
What is `WSA.Tile.Update` in Unity? Explain its purpose and usage.
Tile.Update Declaration public void Update (string xml ); Declaration public void Update (string medium , string wide , string large , string text ); Parameters Parameter Description xml A string containing XML document for new tile look. medium An uri to 150x150 image, shown on medium tile. wid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2725a6c4ff45
unity_docs
math
What is `Rendering.RayTracingGeometryInstanceConfig.enableTriangleCulling` in Unity? Explain its purpose and usage.
RayTracingGeometryInstanceConfig.enableTriangleCulling public bool enableTriangleCulling ; Description Whether front/back face culling for this ray tracing instance is enabled. The culling takes place when the GPU performs a ray-triangle intersection test.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_caf321eb8960
unity_docs
input
In Unity's 'Shortcuts Manager', what is 'Assigning shortcuts to global vs. contextual commands' and how does it work?
Unity commands can be global or contextual. Global commands are always available. For example, by default the command to Undo an action is assigned to the Ctrl/Cmd + Z shortcut. Using that shortcut always undoes the last action, regardless of which windows are open and which tools are active. Contextual commands only w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_12e546bb8f69
unity_docs
scripting
What is `LightProbeProxyVolume` in Unity? Explain its purpose and usage.
LightProbeProxyVolume class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.CoreModule Description The Light Probe Proxy Volume component offers the possibility to use higher resolution lighting for large non-static GameObjects. By default, a probe-lit Renderer receives lighting from ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_940da2b37fed
unity_docs
scripting
What is `AI.NavMeshBuildSourceShape.Mesh` in Unity? Explain its purpose and usage.
NavMeshBuildSourceShape.Mesh Description Describes a Mesh source for use with NavMeshBuildSource . Mesh sources must be positioned within 100,000 units of the world origin and must not exceed 100,000 units in any axis-aligned dimension.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c7d1d676411
unity_docs
scripting
What is `GenericMenu.MenuFunction` in Unity? Explain its purpose and usage.
GenericMenu.MenuFunction Declaration public delegate void MenuFunction (); Description Callback function, called when a menu item is selected. Additional resources: GenericMenu , MenuFunction2 .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa0723231e9a
unity_docs
networking
What is `Unity.Android.Gradle.Manifest.ReqKeyboardType` in Unity? Explain its purpose and usage.
ReqKeyboardType enumeration Description Mirrors the ReqKeyboardType enum. For more information about the attribute, see Android's documentation: ReqKeyboardType attribute Properties Property Description Null Attribute is not set and will not appear in the element. Undefined Mirrors android:reqKeyboardTyp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5d96dc3680bd
unity_docs
audio
Explain 'Audio playlist randomization' in Unity.
Use an Audio Random Container asset to set up a playlist that you can play back in different ways. You can use it for most sound effect use cases, such as footsteps, impacts, weapons, and props. Topic Description Audio Random Container reference Understand the user interface of the Audio Random Container. Audio Random ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41c2adae0116
unity_docs
rendering
What is `Terrain.heightmapMinimumLODSimplification` in Unity? Explain its purpose and usage.
Terrain.heightmapMinimumLODSimplification public int heightmapMinimumLODSimplification ; Description Limits how simplified the rendered terrain can be. Sets the lowest level of simplification for the Terrain. Also affects areas that are outside of the camera frustum. Use this property to correct a situation whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ef1084bf84e
unity_docs
editor
What are the parameters of `Profiling.RawFrameDataView.GetSampleChildrenCountRecursive` in Unity?
Returns int Returns amount of direct and indirect child samples. Description Gets amount of direct and indirect child samples for the specific sample. Use to quickly advance to the next sibling sample. ```csharp using UnityEditor.Profiling;public class Example { public static int SkipAllChildren(RawFrameDataView fr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5bc06b1b0fa
unity_docs
scripting
What is `Android.AndroidLocale` in Unity? Explain its purpose and usage.
AndroidLocale class in UnityEngine.Android / Implemented in: UnityEngine.AndroidJNIModule Description Use this class to retrieve the language and region preferences set on the device. Properties Property Description country Indicates the geographical location as an ISO code. language Indicates the language ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_571140158c74
unity_docs
scripting
What is `OperatingSystemFamily` in Unity? Explain its purpose and usage.
OperatingSystemFamily enumeration Description Enumeration for SystemInfo.operatingSystemFamily . Determines the operating system family application is running on. Properties Property Description Other Returned for operating systems that do not fall into any other category. MacOSX macOS operating system famil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_84224eadb128
unity_docs
scripting
In Unity's 'Serialization best practices', what is 'Thread safety' and how does it work?
Most Unity APIs can only be called from the main thread. Don’t call Unity APIs from constructors and field initializers of serializable types because these run on a separate loading thread. In development builds , Unity throws an error if you attempt to call main thread APIs from a loading thread. In a release build, t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49fc1dd56174
unity_docs
editor
What are the parameters of `Search.SearchMonitor.GetView` in Unity?
Returns SearchMonitorView A SearchMonitorView . Description Returns a SearchMonitorView to access Search's main PropertyDatabases . Multiple nested calls to GetView are supported. If those calls are on the same thread, it will return the same instance to avoid opening and closing new views. If the calls are on differen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c0e72bfcc6fb
unity_docs
rendering
What are the parameters of `ImageConversion.EncodeToTGA` in Unity?
Description Encodes the specified texture in TGA format. This function returns a byte array which is the TGA file data. You can store the encoded data as a file or send it over the network without further processing. This function does not work on any compressed format. Texture.isReadable must be true . The encoded TGA...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bbf42a08c5cb
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture2D.ctor`.
Texture2D Constructor Declaration public Texture2D (int width , int height ); Description Create a new empty texture. The texture will be width by height size, with an RGBA32 TextureFormat , with mipmaps and in sRGB color space. Usually you will want to set the colors of the texture after creating it, us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e9aa816f3a0
unity_docs
rendering
Show me a Unity C# example demonstrating `ObjectFactory.CreateInstance`.
ObjectFactory.CreateInstance Declaration public static Object CreateInstance (Type type ); Declaration public static T CreateInstance (); Parameters Parameter Description type The type of instance to create. Description Create a new instance of the given type. Use this method to create any type of ser...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2dfa1fe88138
unity_docs
scripting
In Unity's 'Edit prefab assets', what is 'Open a prefab asset in prefab editing mode' and how does it work?
You can open a prefab asset in prefab editing mode in the following ways: In isolation: Unity hides the rest of the current working scene, and displays only the GameObjects that relate to the prefab asset in the Hierarchy. In context: The rest of the current working scene remains visible, but locked for editing. The Hi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b29f32ada3c3
unity_docs
scripting
What is `RenderTargetSetup.colorLoad` in Unity? Explain its purpose and usage.
RenderTargetSetup.colorLoad public RenderBufferLoadAction[] colorLoad ; Description Load Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. Please note that not all platforms have load/store actions, so this setting might be ignored at runtime. Generally mobile-oriented gra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e223b236d5d
unity_docs
scripting
What is `Rendering.BatchDrawCommandProcedural.visibleCount` in Unity? Explain its purpose and usage.
BatchDrawCommandProcedural.visibleCount public uint visibleCount ; Description The number of instances to draw with this draw command. This must be a value greater than 1 . If BatchDrawCommandFlags.HasSortingPosition is set, you must set this to 1 . This is because Unity doesn't sort instances within a draw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c17f6c276d33
unity_docs
editor
What is `UIElements.ConverterGroups.RegisterGlobalConverter` in Unity? Explain its purpose and usage.
ConverterGroups.RegisterGlobalConverter Declaration public static void RegisterGlobalConverter (TypeConverter<TSource,TDestination> converter ); Parameters Parameter Description converter The delegate that handles the conversion. Description Registers a global UI conversion delegate that will be used when...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4d16ba1e2ac
unity_docs
rendering
What are the parameters of `Texture3D.GetPixels32` in Unity?
Returns Color32[] An array that contains the pixel colors. Description Gets the pixel color data for a mipmap level as Color32 structs. This method gets pixel data from the texture in CPU memory. Texture.isReadable must be true . The array contains the pixels slice by slice starting at the front of the texture. Each sl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fedf8abad9ca
unity_docs
physics
What is `Physics2D.GetRayIntersection` in Unity? Explain its purpose and usage.
Physics2D.GetRayIntersection Declaration public static int GetRayIntersection ( Ray ray , float distance , List<RaycastHit2D> results , int layerMask = Physics2D.DefaultRaycastLayers); Parameters Parameter Description ray The 3D ray defining origin and direction to test. distance The maximum distance ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_396e2f1d5cd3
unity_docs
rendering
Explain 'Cookies' in Unity.
Resources for adding masks to lights to simulate caustics, soft shadows, and light shapes such as light entering from a window. Page Description Introduction to cookies Learn about using light masks to simulate complex lighting effects with minimal or no impact on runtime performance. Apply a cookie Assign a texture to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4adb8e1c3af7
unity_docs
math
What is `MeshUtility.SetPerTriangleUV2` in Unity? Explain its purpose and usage.
MeshUtility.SetPerTriangleUV2 Declaration public static bool SetPerTriangleUV2 ( Mesh src , Vector2[] triUV ); Description Will insert per-triangle uv2 in mesh and handle vertex splitting etc.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_82dc7e021cb5
unity_docs
rendering
What is `Material.SetTextureScale` in Unity? Explain its purpose and usage.
Material.SetTextureScale Declaration public void SetTextureScale (string name , Vector2 value ); Declaration public void SetTextureScale (int nameID , Vector2 value ); Parameters Parameter Description nameID Property name ID, use Shader.PropertyToID to get it. name Property name, e.g. "_MainT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d3bc088a1ea1
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.NativeSetClassTypeToNullOnScheduleAttribute` in Unity? Explain its purpose and usage.
NativeSetClassTypeToNullOnScheduleAttribute class in Unity.Collections.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Sets the managed reference to a class to null on a copy of the job struct that is passed to a job. The job system doesn't allow managed references in a job struct. However,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f42a405ba19
unity_docs
scripting
What is `Progress.GetRemainingTime` in Unity? Explain its purpose and usage.
Progress.GetRemainingTime Declaration public static long GetRemainingTime (int id ); Parameters Parameter Description id The progress indicator's unique ID. Returns long The number of seconds remaining. Description Gets a progress indicator's remaining time, in seconds. If the remaining time is not ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eff814e564d0
unity_docs
scripting
What is `UIElements.PopupField_1.ctor` in Unity? Explain its purpose and usage.
PopupField<T0> Constructor Declaration public PopupField<T0> (); Description Construct a PopupField. Declaration public PopupField<T0> (string label ); Description Construct a PopupField. Declaration public PopupField<T0> (List<T> choices , T defaultValue , Func<T,string> formatSelectedValueCal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2973f268a3b
unity_docs
ui
Show me a Unity C# example demonstrating `GUIStyle.contentOffset`.
GUIStyle.contentOffset public Vector2 contentOffset ; Description Pixel offset to apply to the content of this GUIstyle. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Prints the value of contentOffset. void OnGUI() { Debug.Log(GUI.skin.button.contentOffset); } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5363fb2f2e5
unity_docs
scripting
What is `SortingLayer` in Unity? Explain its purpose and usage.
SortingLayer struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description SortingLayer allows you to set the render order of multiple sprites easily. There is always a default SortingLayer named "Default" which all sprites are added to initially. Added more SortingLayers to easily control the order...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bded7dab2c7
unity_docs
scripting
What is `Events.UnityEventTools.AddObjectPersistentListener` in Unity? Explain its purpose and usage.
UnityEventTools.AddObjectPersistentListener Declaration public static void AddObjectPersistentListener ( Events.UnityEventBase unityEvent , UnityAction<T> call , T argument ); Parameters Parameter Description unityEvent Event to modify. call Function to call. argument Argument to use when invoking. D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c5e1a5ae3b6
unity_docs
math
What is `ArticulationBody.parentAnchorPosition` in Unity? Explain its purpose and usage.
ArticulationBody.parentAnchorPosition public Vector3 parentAnchorPosition ; Description Position of the anchor relative to this body's parent. Defined in the space of the parent articulation body, not in the space of the parent transform, as there can be multiple transform nodes in the hierarchy between two ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a24f46399b5
unity_docs
rendering
Show me a Unity C# example demonstrating `GL.Vertex3`.
GL.Vertex3 Declaration public static void Vertex3 (float x , float y , float z ); Description Submit a vertex. In OpenGL this matches glVertex3f(x,y,z) ; on other graphics APIs the same functionality is emulated. This function can only be called between GL.Begin and GL.End functions. ```csharp using Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b8fd1a9da59
unity_docs
rendering
What is `Material.GetVector` in Unity? Explain its purpose and usage.
Material.GetVector Declaration public Vector4 GetVector (string name ); Declaration public Vector4 GetVector (int nameID ); Parameters Parameter Description nameID The name ID of the property retrieved by Shader.PropertyToID . name The name of the property. Description Get a named vector value...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_07bfd153126b
unity_docs
editor
Explain 'Video sources' in Unity.
Learn how to import, work with, and use your video sources in Unity. Topic Description Import and preview video clips Learn how to import and preview video clips in your application. Use video sources Reference video sources in your application. Understand video files Understand video files and video decoding in Unity....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4cfcd2e16570
unity_docs
rendering
What is `Cursor` in Unity? Explain its purpose and usage.
Cursor class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Cursor API for setting the cursor (mouse pointer). Supports hardware cursors on macOS, Windows and Linux. Falls back to software cursors on unsupported platforms. Windows Store Apps : Supports only one hardware cursor, set via Pla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6b0611442c3e
unity_docs
scripting
Explain 'Stop and restart Unity Accelerator' in Unity.
Unity Accelerator runs as a background process for each platform. To stop or restart Unity Accelerator for each platform, perform the following steps: ## Windows Open the Services Panel by searching for the term Services in the Settings menu, or running services.msc in the Run dialog ( Win + R ). Locate the Unity Acc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1e0da8589ce3
unity_docs
ui
Explain 'Prefab instance Inspector reference' in Unity.
When you create an instance of a prefab , the Inspector contains specific prefab settings which you can use to edit the prefab instance and its parent prefab asset. ## Overrides Opens the Overrides dropdown window which displays any overrides of the prefab instance. Use this window to apply overrides from the instanc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_81a63c73ba92
unity_docs
scripting
Show me a Unity C# example demonstrating `SceneManagement.Scene`.
ions in SceneManager and EditorSceneManager . To query the PhysicsScene that is assigned to the scene, use the PhysicsSceneExtensions.GetPhysicsScene method. The following script prints some information about the currently loaded scene, creates and switches to a new scene, then prints the same information for th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fec28534cd23
unity_docs
scripting
What is `Search.SearchPropositionFlagsExtensions.HasAny` in Unity? Explain its purpose and usage.
SearchPropositionFlagsExtensions.HasAny Declaration public static bool HasAny ( Search.SearchPropositionFlags flags , Search.SearchPropositionFlags f ); Parameters Parameter Description flags Flags to be checked. f Flags to be checked individually. Returns bool Returns true if any flags is verified...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.