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_man_3ab54676466f
unity_docs
editor
In Unity's 'Use Property Drawers with IMGUI to customize the Inspector', what is 'Default object references' and how does it work?
If you define public Object fields or private ones that are marked with SerializeField , you can set up default references for these fields. The default reference fields are visible in the Inspector window when you select the script asset in the Project window . Note : It is recommended to maintain each PropertyDrawer ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe2c101ed76e
unity_docs
rendering
What is `MaterialEditor.PropertiesDefaultGUI` in Unity? Explain its purpose and usage.
MaterialEditor.PropertiesDefaultGUI Declaration public void PropertiesDefaultGUI (MaterialProperty[] props ); Parameters Parameter Description props Array of material properties. Description Default rendering of shader properties. Note that you can customize shader properties rendering by implementing the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_900667273dfd
unity_docs
rendering
In Unity's 'Create a Profiler module detail panel', what is 'Create a script to control the module details panel' and how does it work?
Use the ProfilerModuleViewController base class to customize the module details panel in the Profiler window. To do this, create a script that controls what appears in the module details panel when you select a specific module. The script must do the following: Define a public constructor for the view controller that c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_710698f87c01
unity_docs
rendering
What are the parameters of `LightTransport.InputExtraction.GetShadowmaskChannelsFromLightIndices` in Unity?
Returns int[] Array of shadowmask channel indices (0-3 for RGBA, or -1 for no channel) corresponding to each input light index. Description Retrieves the shadowmask channel assignments for specified mixed lights. This method maps light indices to their assigned shadowmask channels in Unity's mixed lighting system. Mixe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_811aa2b432d3
unity_docs
rendering
In Unity's 'Set the color of a material in the Standard Shader', what is 'Set a single color' and how does it work?
To use a single color across a material, do either of the following: Select the swatch to open the Color window. Select the dropper to select a new color from anywhere on your screen. In the Color window, use the Alpha ( A ) slider to set transparency. Refer to Transparency for more information. Refer to Color for more...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c30c9fae951d
unity_docs
physics
What are the parameters of `SpherecastCommand.ctor` in Unity?
Description Creates a SpherecastCommand. The command is run in the default physics scene. Declaration public SpherecastCommand ( PhysicsScene physicsScene , Vector3 origin , float radius , Vector3 direction , QueryParameters queryParameters , float distance ); Parameters Parameter Description physicsScene The physics s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef40255e02ac
unity_docs
math
What is `IMGUI.Controls.MultiColumnHeader.GetVisibleColumnIndex` in Unity? Explain its purpose and usage.
MultiColumnHeader.GetVisibleColumnIndex Declaration public int GetVisibleColumnIndex (int columnIndex ); Parameters Parameter Description columnIndex Column index. Returns int Visible column index. Description Convert from column index to visible column index. Columns can be hidden so to get the vis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2703e0c8b96c
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.AddAssetTagToDefaultInstall`.
nstall (string targetGuid , string tag ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by TargetGuidByName . tag The name of the asset tag. Description Adds the asset tag to the list of tags to download during initial installation. Note : The function does ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_badf3abdaa6b
unity_docs
rendering
What is `Experimental.GlobalIllumination.SpotLightPyramidShape.angle` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SpotLightPyramidShape.angle public float angle ; Description The opening angle of the shorter side of the pyramid light.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32777257a692
unity_docs
scripting
Give me an overview of the `GridLayout` class in Unity.
GridLayout class in UnityEngine / Inherits from: Behaviour Description An abstract class that defines a grid layout. Additional resources: Grid & GridProxy. Properties Property Description cellGap The size of the gap between each cell in the layout. cellLayout The layout of the cells. cellSize The size ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_171149ee217e
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.ScreenPointToRay`.
creen width in pixels - 1, screen height in pixels - 1). Unity ignores the z coordinate. eye Optional argument that can be used to specify which eye transform to use. Default is Mono. Description Returns a ray going from camera through a screen point. Resulting ray is in world space, starting on the near plane of ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b44f5621d405
unity_docs
ui
What is `UIElements.IMouseEvent.button` in Unity? Explain its purpose and usage.
IMouseEvent.button public int button ; Description A value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e22af505b77f
unity_docs
scripting
What are the parameters of `MonoBehaviour.OnCollisionEnter2D` in Unity?
Description Sent when an incoming collider makes contact with this object's collider (2D physics only). Further information about the collision is reported in the Collision2D parameter passed during the call. If you don't need this information then you can declare OnCollisionEnter2D without the parameter. Note: OnColli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_842f44927b22
unity_docs
rendering
In Unity's 'Organizing assets into AssetBundles', what is 'AssetBundle naming conventions' and how does it work?
Unity automatically puts any AssetBundle names in lowercase during the build process. For example, an AssetBundle named Foo will result in a file named foo . To avoid any conflicts or issues, use lowercase names for your AssetBundles. There’s no established or expected file extension for AssetBundles. You can provide a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a11ee955228f
unity_docs
rendering
Show me a Unity C# example demonstrating `QualitySettings.shadows`.
QualitySettings.shadows public static ShadowQuality shadows ; Description Real-time Shadows type to be used. This determines which type of shadows should be used. The available options are Hard and Soft Shadows, Hard Shadows Only and Disable Shadows. Additional resources: Light.shadows . ```csharp using Un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2fa81bba753
unity_docs
xr
What is `VersionControl.AssetList` in Unity? Explain its purpose and usage.
AssetList class in UnityEditor.VersionControl Description A list of version control information about assets. Public Methods Method Description Filter Based on the current list and the states a new list is returned which only contains the assets with the requested states. FilterChildren Create an optimised li...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58023c298191
unity_docs
physics
Give me an overview of the `ClothSkinningCoefficient` class in Unity.
ClothSkinningCoefficient struct in UnityEngine / Implemented in: UnityEngine.ClothModule Description The ClothSkinningCoefficient struct is used to set up how a Cloth component is allowed to move with respect to the SkinnedMeshRenderer it is attached to. This is set using the Cloth.coefficients property o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a26963ba3739
github
scripting
Write a Unity C# XR/VR script for Clock
```csharp // Copyright 2020 The Tilt Brush Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicab...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_03aa60411d9d
unity_docs
math
What is `Windows.Crypto.ComputeMD5Hash` in Unity? Explain its purpose and usage.
Crypto.ComputeMD5Hash Declaration public static byte[] ComputeMD5Hash (byte[] buffer ); Parameters Parameter Description buffer The input to compute the hash code for. Description Computes MD5 hash value for the specified byte array.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1724f442d80c_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Returns a string used to keep different models from having overlapping names.Examples uses:- Keep texture names from colliding- Keep material names from colliding -- in particular this is an issue for the name "defaultShadingGroup" which shows up in Poly-obj and Media Library-obj imports a lot. Signature: ```csharp ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_6a98277b9172
unity_docs
editor
What is `Editor.hasUnsavedChanges` in Unity? Explain its purpose and usage.
Editor.hasUnsavedChanges public bool hasUnsavedChanges ; Description This property specifies whether the Editor prompts the user to save or discard unsaved changes before the Inspector gets rebuilt. Set hasUnsavedChanges to true to prompt the user to save or discard unsaved changes. This helps prevent them from...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c60e01036bbe
unity_docs
scripting
What is `AudioChorusFilter` in Unity? Explain its purpose and usage.
AudioChorusFilter class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.AudioModule Description The Audio Chorus Filter takes an Audio Clip and processes it creating a chorus effect. The chorus effect modulates the original sound by a sinusoid low frequency oscillator (LFO). The outpu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f14355c283e3
unity_docs
math
Show me a Unity C# example demonstrating `SerializedProperty.arrayElementType`.
SerializedProperty.arrayElementType public string arrayElementType ; Description Type name of the element in an array property. (Read Only) Returns the C# type name of the element in an array property. In the case of SerializedPropertyType.ObjectReference and other internal values of SerializedPropertyType, t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_93a80d22693f
unity_docs
physics
In Unity's 'Global Illumination (GI) cache', what is 'Clear the GI cache' and how does it work?
For details on how to clear the GI cache, refer to the GI Cache Preferences documentation. You can’t clear the GI cache by selecting Clear Baked Data in the Lighting window. You should only clear the GI cache as a last resort. If your project has an issue that forces you to clear the GI cache, report it as a bug .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_414bca4c8e03
unity_docs
input
What is `XR.InputDeviceCharacteristics.Simulated6DOF` in Unity? Explain its purpose and usage.
InputDeviceCharacteristics.Simulated6DOF Description The InputDevice reports software approximated, positional data. This InputDevice can only sense rotation, and its reported positional data is approximated.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2f8cd26b65e
unity_docs
editor
What is `TerrainTools.IOnInspectorGUI.Repaint` in Unity? Explain its purpose and usage.
IOnInspectorGUI.Repaint Declaration public void Repaint ( TerrainTools.RepaintFlags flags ); Parameters Parameter Description flags What to repaint. Description Instructs the Editor to repaint the tool UI and/or the scene view.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_06d9a908a005
unity_docs
math
What is `Vector4.negativeInfinity` in Unity? Explain its purpose and usage.
Vector4.negativeInfinity public static Vector4 negativeInfinity ; Description Shorthand for writing Vector4(float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity) .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4c1b9d3fed7
unity_docs
xr
What is `Accessibility.IAccessibilityNotificationDispatcher` in Unity? Explain its purpose and usage.
IAccessibilityNotificationDispatcher interface in UnityEngine.Accessibility Description Sends accessibility notifications to the screen reader. Public Methods Method Description SendAnnouncement Sends a notification to the screen reader conveying an announcement. Use this notification to provide accessib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3b7fa71003cc
unity_docs
rendering
In Unity's 'PackageRequirements block in ShaderLab reference', what is 'Version syntax' and how does it work?
In ShaderLab’s package requirements, a version uses the major.minor or major.minor.patch format. If you only use major.minor , Unity uses 0 for the patch . Package versions can also include a -preview or a -preview.n postfix where -preview is equivalent to -preview.0 . Preview versions come before non-preview versions,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8637d473cd4
unity_docs
scripting
What is `UIElements.StyleInt.ctor` in Unity? Explain its purpose and usage.
StyleInt Constructor Declaration public StyleInt (int v ); Description Creates from either an integer or StyleKeyword . Declaration public StyleInt ( UIElements.StyleKeyword keyword ); Description Creates from either an integer or StyleKeyword .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_47ca599e6854
unity_docs
rendering
Show me a Unity code example for 'Create samples for packages'.
acter ( ~ ) tells Unity to ignore the contents the Samples~ folder. Such folders aren’t tracked with.meta files. Add a JSON object for each sample under the samples array in your package.json manifest file. ## Location of sample files You can add your sample assets under subfolders of the Samples~ folder of your pack...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b99a37b160c2
unity_docs
input
What is `Experimental.GraphView.IconBadge.badgeText` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. IconBadge.badgeText public string badgeText ; Description Text displayed next to the badge on mouse hover.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ad9846e6cd5
unity_docs
scripting
What is `LazyLoadReference_1.isSet` in Unity? Explain its purpose and usage.
LazyLoadReference<T0>.isSet public bool isSet ; Description Determines if an asset is being targeted, regardless of whether the asset is available for loading. This never loads the referenced object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eccd0fb8aff1
unity_docs
rendering
What is `Rendering.BuiltinRenderTextureType` in Unity? Explain its purpose and usage.
BuiltinRenderTextureType enumeration Description Built-in temporary render textures produced during camera's rendering. When camera is rendering the Scene, in some cases it can produce temporary render textures in the process (e.g. depth textures, deferred G-buffer etc.). This enum indicates these temporary render...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e5c469bea84
unity_docs
rendering
Show me a Unity C# example demonstrating `GUIStyle.overflow`.
GUIStyle.overflow public RectOffset overflow ; Description Extra space to be added to the background image. This is used if your image has a drop shadow and you want to extend the background image beyond the rectangles specified for gui elements that use this style. ```csharp using UnityEngine;public class ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5af6d7fd067
unity_docs
rendering
What is `Unity.Profiling.LowLevel.Unsafe.ProfilerUnsafeUtility.CreateFlow` in Unity? Explain its purpose and usage.
ProfilerUnsafeUtility.CreateFlow Declaration public static uint CreateFlow (ushort categoryId ); Returns uint Returns flow identifier. Description Create a new Profiler flow identifier. Use Profiler flow to highlight dependencies in multithreaded code. Additional resources: FlowEvent , CPU Usage Profil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70a0be1b28b5
unity_docs
scripting
What is `Search.SearchItem.RemoveField` in Unity? Explain its purpose and usage.
SearchItem.RemoveField Declaration public bool RemoveField (string name ); Parameters Parameter Description name Name of the field to be removed. Returns bool Returns true if a field was actually removed. Description Removes an item field.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46171e202a92
unity_docs
rendering
What is `TextureImporter.wrapMode` in Unity? Explain its purpose and usage.
TextureImporter.wrapMode public TextureWrapMode wrapMode ; Description Texture coordinate wrapping mode. Using wrapMode sets the same wrapping mode on all axes. Different per-axis wrap modes can be set using wrapModeU , wrapModeV , wrapModeW . Querying the value returns the U axis wrap mode (same as wr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8f482dccdc87
github
scripting
Write a Unity C# UI script for Unity Singleton Helper
```csharp using System; using System.IO; using SiegfriedWagner.Singletons.Attributes; using SiegfriedWagner.Singletons.Exceptions; using UnityEngine; using UnityEngine.SceneManagement; using Object = UnityEngine.Object; namespace SiegfriedWagner.Singletons.Internal { internal static class UnitySingletonHelper { p...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_9157c0cbe8a9
unity_docs
math
What is `Vector2Int.Max` in Unity? Explain its purpose and usage.
Vector2Int.Max Declaration public static Vector2Int Max ( Vector2Int lhs , Vector2Int rhs ); Description Returns a vector that is made from the largest components of two vectors. Additional resources: Min function.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a830aa35d96a
unity_docs
rendering
What is `Texture.wrapModeW` in Unity? Explain its purpose and usage.
Texture.wrapModeW public TextureWrapMode wrapModeW ; Description Texture W coordinate wrapping mode for Texture3D . Controls wrapping mode along Texture W (depth, only relevant for Texture3D ) axis. Additional resources: TextureWrapMode , wrapMode , Texture assets .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39e6225d7d70
unity_docs
physics
What is `LowLevelPhysics.GeometryType` in Unity? Explain its purpose and usage.
GeometryType enumeration Description The set of basic geometry shape types that can exist. Additional resources: BoxGeometry , SphereGeometry , CapsuleGeometry , ConvexMeshGeometry , TriangleMeshGeometry , TerrainGeometry . Properties Property Description Sphere A sphere shape. Capsule A capsule shape. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_260c378f5fd8
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.SetActive`.
idbodies, and scripts. For example, Unity will no longer call MonoBehaviour.Update on a script attached to a deactivated GameObject. Deactivating a GameObject also stops all coroutines attached to it. Note: If the call to SetActive changes the value of GameObject.activeInHierarchy , this triggers MonoBehaviour.O...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a431e5038f5d_doc_8
github
scripting
What does `GetTextureCompressionFormat` do in this Unity script? Explain its purpose and signature.
Gets the object value of the Texture Compression Format Enum for reflection calls.See source . Signature: ```csharp private static object GetTextureCompressionFormat(string label) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_001ce3cac131
unity_docs
math
Show me a Unity C# example demonstrating `ScriptableWizard.DisplayWizard`.
ic T DisplayWizard (string title ); Parameters Parameter Description title The title shown at the top of the wizard window. Returns T The wizard. Description Creates a wizard. When the user hits the Create button OnWizardCreate function will be called. DisplayWizard will only show one wizard for eve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bbe58662b530
unity_docs
scripting
What is `HDRDisplaySupportFlags.AutomaticTonemapping` in Unity? Explain its purpose and usage.
HDRDisplaySupportFlags.AutomaticTonemapping Description Denotes if the GPU and driver support automatic tone mapping to HDR displays. Additional resources: HDROutputSettings.automaticHDRTonemapping .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8b55609db544
unity_docs
scripting
What is `UIElements.BindingSourceSelectionMode` in Unity? Explain its purpose and usage.
BindingSourceSelectionMode enumeration Description Option to change the data source assignation when using Data Binding in collection views. Properties Property Description Manual Data source assignation will be handled by user code when binding each item. AutoAssign The items source and indexed path ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9fcc761a37cf
unity_docs
rendering
What is `Rendering.BuiltinShaderDefine.UNITY_HARDWARE_TIER3` in Unity? Explain its purpose and usage.
BuiltinShaderDefine.UNITY_HARDWARE_TIER3 Description UNITY_HARDWARE_TIER3 is set when compiling shaders for GraphicsTier.Tier3 . Note: Graphics tiers are only supported in the Built-in Render Pipeline. Unity generates tier shader variants if your shader source code includes #pragma hardware_tier_variants , or if...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7bb1a5cff6ed
unity_docs
rendering
Give me an overview of the `ParticleSystemTrailTextureMode` class in Unity.
ParticleSystemTrailTextureMode enumeration Description Choose how textures are applied to Particle Trails. Properties Property Description Stretch Map the texture once along the entire length of the trail. Tile Repeat the texture along the trail. To set the tiling rate, use Material.SetTextureScale. Distribut...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4901bcfe983b
unity_docs
scripting
What is `ParticleSystem.ForceOverLifetimeModule.enabled` in Unity? Explain its purpose and usage.
ParticleSystem.ForceOverLifetimeModule.enabled public bool enabled ; Description Specifies whether the ForceOverLifetimeModule is enabled or disabled. Additional resources: ParticleSystem.forceOverLifetime . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_660e515f45c3
unity_docs
rendering
Give me an overview of the `LightShadows` class in Unity.
LightShadows enumeration Description Shadow casting options for a Light . Additional resources: light component . Properties Property Description None Do not cast shadows (default). Hard Cast "hard" shadows (with no shadow filtering). Soft Cast "soft" shadows (with 4x PCF filtering).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_45c036b46e57
unity_docs
editor
What is `IMGUI.Controls.ArcHandle.radiusHandleSizeFunction` in Unity? Explain its purpose and usage.
ArcHandle.radiusHandleSizeFunction public Handles.SizeFunction radiusHandleSizeFunction ; Description The SizeFunction to specify how large the angle control handle should be. Defaults to DefaultRadiusHandleSizeFunction for new instances of ArcHandle . The radius handle will be drawn with a size of 0 i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_967a6307b5d9_doc_12
github
scripting
What does `ApplyOverrides` do in this Unity script? Explain its purpose and signature.
Applies Sprite overrides to thisA list of Sprite overrides to applyThe input overrides list is not valid Signature: ```csharp public void ApplyOverrides(IList<KeyValuePair<Sprite, Sprite>> overrides) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3082885b1d09
unity_docs
scripting
What is `ObjectChangeKind.ChangeGameObjectStructureHierarchy` in Unity? Explain its purpose and usage.
ObjectChangeKind.ChangeGameObjectStructureHierarchy Description A change of this type indicates that the structure of a GameObject has changed and any GameObject in the hierarchy below it might have changed. This happens for example when Undo.RegisterFullObjectHierarchyUndo is used.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec8fe5534bdd
unity_docs
scripting
What is `UIElements.ToolbarBreadcrumbs.PushItem` in Unity? Explain its purpose and usage.
ToolbarBreadcrumbs.PushItem Declaration public void PushItem (string label , Unity.Android.Gradle.Manifest.Action clickedEvent ); Parameters Parameter Description label The text to display for the item in the breadcrumb toolbar. clickedEvent The action to perform when the a users clicks the item in the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3e38056b69a4
unity_docs
physics
Explain 'Capsule collider component reference' in Unity.
The Capsule collider is a built-in 3D capsule-shaped collider made of two half-spheres joined together by a cylinder. It is useful for in-application items that have a cylindrical shape, or as a collider for player and non-player characters in a scene . Because Capsule colliders have no corners, they are also useful to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0306a62ff912
unity_docs
rendering
Explain 'FBX Exporter' in Unity.
com.unity.formats.fbx ## Description The FBX Exporter package enables round-trip workflows between Unity and 3D modeling software. Send geometry, Lights, Cameras, and animation from Unity to Autodesk Maya, Autodesk Maya LT, or Autodesk 3ds Max, and back to Unity again, with minimal effort. ## Released for Unity Pac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae90c19043aa
unity_docs
physics
What is `UIElements.Scale.ctor` in Unity? Explain its purpose and usage.
Scale Constructor Declaration public Scale ( Vector2 scale ); Description Creates a new Scale from a Vector2 . Declaration public Scale ( Vector3 scale ); Description Creates a new Scale from a Vector3 . Scaling in the Z axis is currently unsupported. Consequently, if a Z value different tha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7359bc0c11ca
unity_docs
math
Show me a Unity C# example demonstrating `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.MemClear`.
for initializing memory without any residual data that might cause unexpected behavior. Use this method to ensure memory safety when reusing or reallocating memory blocks. This method provides a fast and efficient way to clear data, which is important in scenarios where performance and reliability are paramount. It is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f6347e79f872
unity_docs
scripting
What is `Vector2.Angle` in Unity? Explain its purpose and usage.
Vector2.Angle Declaration public static float Angle ( Vector2 from , Vector2 to ); Parameters Parameter Description from The vector from which the angular difference is measured. to The vector to which the angular difference is measured. Returns float The unsigned angle in degrees between the two v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_648266cc24cc
unity_docs
ui
What is `GUILayout.Height` in Unity? Explain its purpose and usage.
GUILayout.Height Declaration public static GUILayoutOption Height (float height ); Description Option passed to a control to give it an absolute height. Note: This option will override the Automatic height Layout parameter Fixed Height for a GUI Control. ```csharp using UnityEngine;public class ExampleScr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84a408076f5b
unity_docs
animation
What is `AnimatorStateInfo.IsName` in Unity? Explain its purpose and usage.
AnimatorStateInfo.IsName Declaration public bool IsName (string name ); Description Does name match the name of the active state in the statemachine? The name should be in the form Layer.Name or Layer.SubStateMachine.Name . For example, Base.Idle or Base.RunSM.JogForward .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e4a7444a42e
unity_docs
animation
Show me a Unity C# example demonstrating `AssetPostprocessor.OnPreprocessModel`.
AssetPostprocessor.OnPreprocessModel() Description Add this function to a subclass to get a notification just before a model (.fbx, .mb file etc.) is imported. This lets you control the import settings through code. ```csharp using UnityEngine; using UnityEditor;// Disable import of materials if the file contains ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60dce799276a
unity_docs
physics
Give me an overview of the `QueryTriggerInteraction` class in Unity.
QueryTriggerInteraction enumeration Description Overrides the global Physics.queriesHitTriggers . Overrides the global Physics.queriesHitTriggers to specify whether queries (raycasts, spherecasts, overlap tests, etc.) hit Triggers by default. Use Ignore for queries to ignore trigger Colliders. ```csharp //Crea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bbf93294a89b
github
scripting
Write a Unity C# MonoBehaviour script called Event Link
```csharp using Hudossay.AttributeEvents.Assets.Runtime.GameEvents; using System; using UnityEngine; namespace Hudossay.AttributeEvents.Assets.Runtime.EventLinks { /// <summary> /// Links one event from broadcaster GameObject to one method from listener GameObject's MoonoBehaviour. /// </summary> publi...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_931af2adeb38
unity_docs
rendering
What is `Material.GetVectorArray` in Unity? Explain its purpose and usage.
Material.GetVectorArray Declaration public Vector4[] GetVectorArray (string name ); Declaration public Vector4[] GetVectorArray (int nameID ); Parameters Parameter Description name The name of the property. nameID The name ID of the property retrieved by Shader.PropertyToID . Description Get a nam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d756d0b77dee
unity_docs
rendering
In Unity's 'Windows build settings reference', what is 'Windows Player build binaries' and how does it work?
When you build a Unity title on the Windows platform, Unity produces the following files, where ProjectName is the name of your application: ProjectName.exe - The project executable file, that’s your project application. This contains the program entry point which calls into the Unity engine when launched. The path to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20fbc6851c60
unity_docs
editor
What is `Unity.Profiling.Editor.ProfilerCounterDescriptor.Name` in Unity? Explain its purpose and usage.
ProfilerCounterDescriptor.Name public string Name ; Description The name of the described Profiler counter. The name of the described Profiler counter as a string. Read-only. Additional resources: ProfilerCounterDescriptor .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0298b03b682
unity_docs
scripting
What is `MonoBehaviour.CancelInvoke` in Unity? Explain its purpose and usage.
MonoBehaviour.CancelInvoke Declaration public void CancelInvoke (); Description Cancels all Invoke calls on this MonoBehaviour. ```csharp using UnityEngine; using System.Collections.Generic;public class ExampleScript : MonoBehaviour { public GameObject projectile; void Start() { // Starting in 2 seconds, a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16ce4e56189a
unity_docs
animation
What is `Animations.AnimationStreamHandleUtility.WriteInts` in Unity? Explain its purpose and usage.
AnimationStreamHandleUtility.WriteInts Declaration public static void WriteInts ( Animations.AnimationStream stream , NativeArray<PropertyStreamHandle> handles , NativeArray<int> buffer , bool useMask ); Parameters Parameter Description stream The animation stream. handles The PropertyStreamHandle arra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2e131a0f668
unity_docs
audio
What is `AudioSpeakerMode.Mode7point1` in Unity? Explain its purpose and usage.
AudioSpeakerMode.Mode7point1 Description The Surround 7.1 speaker setup which contains eight channels. The Surround 7.1 speaker mode contains eight channels: Front left Front right Front center Low-Frequency Effects (LFE subwoofer) Side left Side right Rear left Rear right If a device doesn't support this...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_508a5308138a
unity_docs
rendering
Show me a Unity code example for 'Modify source assets from code'.
cations to assets at application runtime are usually temporary. For example, you might want to modify the shader component of the material for a character to represent a temporary invincibility power-up. The shader modification in this case is not permanent and does not persist on exiting Play mode. The following examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_385786df40b2
unity_docs
animation
What is `UIElements.Experimental.ValueAnimation_1.interpolator` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ValueAnimation<T0>.interpolator public Func<T,T,float,T> interpolator ; Description Value interpolation method.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4cd2c6b7cf32
unity_docs
rendering
In Unity's 'Xcode frame debugger Unity integration', what is 'Capture a frame from your application with Xcode' and how does it work?
This section describes how to launch your application and perform a frame capture using the Xcode UI or the FrameCapture API. This workflow is supported on all platforms that use Metal. 1. Create an Xcode project. You can either create an Xcode project from the Unity Editor, or use any other Xcode project to launch mac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_950346f50f72
unity_docs
rendering
In Unity's 'Unity Editor command line arguments reference', what is 'Build arguments' and how does it work?
Use the following arguments to build Players for various platforms from the command line. For more information about building Players from the command line, refer to Create a build from the command line . Command Description -activeBuildProfile <pathname> Set the build profile saved at the given path as an active build...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d8c3313398c
unity_docs
editor
What is `Gradient.colorSpace` in Unity? Explain its purpose and usage.
Gradient.colorSpace public ColorSpace colorSpace ; Description Indicates the color space that the gradient color keys are using. Color space setting is automatically set up by the gradient editor, based on GradientUsageAttribute.colorSpace value. If you are creating gradients from C# code, this value needs ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_47b7c5f9517c
unity_docs
animation
Explain 'Direct blending' in Unity.
Use a Direct Blend Tree to map animator parameters to the weight of a BlendTree child. This is useful when you want exact control over blending animations rather than the indirectly control provided by 1D blending or 2D blending. In direct blending, you use the Inspector window to add motions and to also assign an Anim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_93f800891c30
unity_docs
scripting
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManagerMetrics.StopCollectingMetrics` in Unity? Explain its purpose and usage.
AsyncReadManagerMetrics.StopCollectingMetrics Declaration public static void StopCollectingMetrics (); Description Stop recording metrics data for AsyncReadManager read operations. Start collection with StartCollectingMetrics .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ed18d4151484
unity_docs
networking
In Unity's 'Introduction to Unity Accelerator', what is 'Using Unity Accelerator' and how does it work?
After you’ve installed Unity Accelerator on your network and set it up in your project, it will work in the background, caching your assets. You can monitor its usage via the dashboard, at http://<accelerator-host-ip>/dashboard .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d965cc7ec594
unity_docs
scripting
Show me a Unity C# example demonstrating `Search.PropertyDatabase.InvalidateMask`.
Declaration public void InvalidateMask (ulong documentKeyMask ); Parameters Parameter Description documentKeyMask A document key mask. Description Invalidate all properties stored from multiple documents that match a document key mask. This operation is slower than the simpler PropertyDatabase.Invalidate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9986189a5a83
unity_docs
math
Show me a Unity code example for 'Parallel tessellation'.
the mesh and add it to the draw sequence. You can do so with the following APIs: MeshGenerationContext.AllocateTempMesh MeshGenerationContext.DrawMesh Note : You can add the mesh to the draw sequence at any point during the call to generateVisualContent . The following example demonstrates a jobified tessellation with ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e352a6c72c8
unity_docs
rendering
What are the parameters of `ComputeShader.DispatchIndirect` in Unity?
Description Execute a compute shader. This function "runs" the compute shader, with the given work size read directly from the GPU. Typical use case is generating arbitrary amount of data from a ComputeShader and then dispatching that, without requiring a readback to the CPU. Buffer with arguments, argsBuffer , has to ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9fadf9e4467d
unity_docs
math
What is `SerializedProperty.type` in Unity? Explain its purpose and usage.
SerializedProperty.type public string type ; Description Type name of the property. (Read Only) Returns C# type name of the property for all SerializedPropertyType values, except for SerializedPropertyType.ObjectReference , SerializedPropertyType.ManagedReference and other internal values of SerializedPro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a59a5655f06
unity_docs
rendering
What is `ShaderImporter.GetNonModifiableTexture` in Unity? Explain its purpose and usage.
ShaderImporter.GetNonModifiableTexture Declaration public Texture GetNonModifiableTexture (string name ); Description Gets the non-modifiable texture assigned to the shader importer for the shader property with given name.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f949d134aa44
unity_docs
physics
What are the parameters of `Rigidbody.GetAccumulatedForce` in Unity?
Returns Vector3 Accumulated force expressed in ForceMode.Force . Description Returns the force that the Rigidbody has accumulated before the simulation step. The accumulated force is reset during each physics simulation step. ```csharp using UnityEngine;public class AddForceScript : MonoBehaviour { private Rigidbod...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7be3cb44032a
unity_docs
rendering
What is `CameraProjectionCache.WorldToGUIPoint` in Unity? Explain its purpose and usage.
CameraProjectionCache.WorldToGUIPoint Declaration public Vector2 WorldToGUIPoint ( Vector3 worldPoint ); Parameters Parameter Description worldPoint A point in world space. Returns Vector2 A point in GUI space. Description Converts a world space point to a 2D GUI position. Uses the cached camera ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ff82b99c1f1
unity_docs
scripting
What is `AI.NavMeshAgent.autoBraking` in Unity? Explain its purpose and usage.
NavMeshAgent.autoBraking public bool autoBraking ; Description Should the agent brake automatically to avoid overshooting the destination point? If the agent needs to land close to the destination point then it will typically need to brake to avoid overshooting or endless "orbiting" around the target zone. If t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_dd77601fc3da_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Whether to keep the from moving past from the poke target. Signature: ```csharp public bool clampToMaxDistance ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_a57f23dd0811
unity_docs
scripting
Show me a Unity C# example demonstrating `AudioConfiguration`.
udioModule Description Specifies the current properties or desired properties to be set for the audio system. Use these properties to change how Unity outputs all audio in your project, including how many sounds can play at one time and what speaker mode to use. For a longer example, refer to AudioSettings.Reset ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8022bceaca90
unity_docs
scripting
What is `Handles.CircleHandleCap` in Unity? Explain its purpose and usage.
Handles.CircleHandleCap Declaration public static void CircleHandleCap (int controlID , Vector3 position , Quaternion rotation , float size , EventType eventType ); Parameters Parameter Description controlID The control ID for the handle. position The position of the handle in the space of Handl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1d5b26aa078
unity_docs
rendering
What is `Rendering.ScriptableRenderContext.DrawRenderers` in Unity? Explain its purpose and usage.
Method group is Obsolete ScriptableRenderContext.DrawRenderers Obsolete DrawRenderers is obsolete and replaced with the RendererList API: construct a RendererList using ScriptableRenderContext.CreateRendererList and execture it using CommandBuffer.DrawRendererList. Declaration public void DrawRenderers ( Renderi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f38e0d6bc54
unity_docs
editor
What is `iOS.Xcode.PBXProject.GetBuildPhaseName` in Unity? Explain its purpose and usage.
PBXProject.GetBuildPhaseName Declaration public string GetBuildPhaseName (string phaseGuid ); Parameters Parameter Description phaseGuid GUID of the phase. Returns string The build phase name if it's defined. Description Returns the name of the build phase with the specified GUID. For shell script a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47bc7ffde596
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddFile` in Unity? Explain its purpose and usage.
PBXProject.AddFile Declaration public string AddFile (string path , string projectPath , iOS.Xcode.PBXSourceTree sourceTree ); Parameters Parameter Description path The physical path to the file on the filesystem. projectPath The project path to the file as viewed in Xcode. sourceTree The source tree...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b638502915d7
unity_docs
math
What is `RectInt.ctor` in Unity? Explain its purpose and usage.
RectInt Constructor Declaration public RectInt (int xMin , int yMin , int width , int height ); Declaration public RectInt ( Vector2Int position , Vector2Int size ); Parameters Parameter Description xMin The minimum X value of the RectInt. yMin The minimum Y value of the RectInt. width Width ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55f985d0d091
unity_docs
scripting
What is `AppleTV.tvOSPlatformIconKind.App` in Unity? Explain its purpose and usage.
tvOSPlatformIconKind.App public static PlatformIconKind App ; Description Includes all App icons required by tvOS. Small icon (400x240) displayed on the home screen Small icon 2x (800x480) displayed on the 4K Apple TV home screen. Large icon (1280x720) displayed on the app's App Store page All icons requir...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_20444d9049e3
unity_docs
scripting
Show me a Unity C# example demonstrating `Animations.AnimatorJobExtensions.AddJobDependency`.
nimator instance that calls this method. jobHandle The JobHandle of the job that needs to run before animator jobs. Description Creates a dependency between animator jobs and the job represented by the supplied job handle. To add multiple job dependencies, call this method for each job that need to run before th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_78d07e3458f3
unity_docs
math
What are the parameters of `UIElements.MeshGenerationContext.AddMeshGenerationJob` in Unity?
Description Instructs the renderer to wait for the completion of the provided JobHandle before beginning processing the meshes. The following code example shows how to use a job to generate a mesh: ```csharp using System; using Unity.Collections; using Unity.Jobs; using UnityEngine; using UnityEngine.UIElements;class C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc9da41958dc
unity_docs
rendering
What is `MaterialPropertyDrawer.Apply` in Unity? Explain its purpose and usage.
MaterialPropertyDrawer.Apply Declaration public void Apply ( MaterialProperty prop ); Parameters Parameter Description prop The MaterialProperty to apply values for. Description Apply extra initial values to the material. This function is called in all property drawers when a new material is created, o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_385abc4e45a0
unity_docs
editor
What is `AssetDatabase.GetCacheServerPort` in Unity? Explain its purpose and usage.
AssetDatabase.GetCacheServerPort Declaration public static ushort GetCacheServerPort (); Returns ushort Returns the Port number of the Cache Server in Editor Settings. Returns 0 if Port number is not set in Editor Settings. Description Gets the Port number of the Cache Server in Editor Settings. Note: If ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_396289977ece
unity_docs
physics
What is `Physics.ContactModifyEventCCD` in Unity? Explain its purpose and usage.
Physics.ContactModifyEventCCD Parameters Parameter Description value A delegate to call. Description Subscribe to this event to be able to customize the collision response of CCD generated contact pairs. Similar to Physics.ContactModifyEvent but dedicated to contact pairs that have been generated by the CCD ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.