id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_sr_cd16e3621bae
unity_docs
editor
What are the parameters of `MonoImporter.SetIcon` in Unity?
Description Sets a custom icon to associate with the imported MonoScript . MonoScripts can have an associated custom icon. This icon is used in the Scene view, the Inspector, and the Project window. Additional resources: MonoImporter.GetIcon , PluginImporter.SetIcon , EditorGUIUtility.SetIconForObject . ```csharp using...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d56091c6ba17
unity_docs
scripting
What is `TerrainLayerInspector` in Unity? Explain its purpose and usage.
TerrainLayerInspector class in UnityEditor / Inherits from: Editor Description The default Inspector class for Terrain Layer. Call Editor.CreateEditor with a TerrainLayer object to construct a TerrainLayerInspector object. Additional resources: TerrainLayer . Public Methods Method Description ApplyCustom...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86986a854e09
unity_docs
scripting
What is `AI.NavMeshPathStatus.PathInvalid` in Unity? Explain its purpose and usage.
NavMeshPathStatus.PathInvalid Description The path is not valid. Refer to the documentation of the returning method or property for more information. Additional resources: NavMeshAgent.pathStatus , NavMeshPath.status .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5cf6f6ec4981
unity_docs
rendering
In Unity's 'Create a Profiler module detail panel', what is 'Module details panel controller script example' and how does it work?
The following example script creates a module details panel controller that draws a single label in the module details panel that displays text: The script example does the following: Defines and creates a label to display the value you want to capture, and adds this label to the module details panel. Defines a constru...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8699cdaa85a
unity_docs
physics
What is `UIElements.BindingUpdateTrigger` in Unity? Explain its purpose and usage.
BindingUpdateTrigger enumeration Description Option to tell a binding when to update. Properties Property Description WhenDirty Only when Binding.MarkDirty has been called. OnSourceChanged Only when a change is detected in the source or Binding.MarkDirty has been called. EveryUpdate On every upda...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a15627a231d2
unity_docs
physics
Explain 'Cinemachine' in Unity.
com.unity.cinemachine ## Description Smart camera tools for passionate creators. Cinemachine 3 is a newer and better version of Cinemachine, but upgrading an existing project from 2.X will likely require some effort. If you’re considering upgrading an older project, please see our upgrade guide in the user manual. #...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_490b55931e68
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.ShapeModule.enabled`.
ParticleSystem.ShapeModule.enabled public bool enabled ; Description Specifies whether the ShapeModule is enabled or disabled. Additional resources: ParticleSystem.shape . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBehaviou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_83f7dfab9848
unity_docs
animation
What is `AnimationUtility.GetAnimatedObject` in Unity? Explain its purpose and usage.
AnimationUtility.GetAnimatedObject Declaration public static Object GetAnimatedObject ( GameObject root , EditorCurveBinding binding ); Description Retrieves the animated object that the binding points to.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_eebc17f12970
unity_docs
performance
In Unity's 'Android thread configuration', what is 'Identifying CPU cores' and how does it work?
Unity usually receives the capacity and big/little assignment for every CPU core from the device’s operating system. For older operating system versions, this information isn’t always available. In this case, Unity calculates the capacity of the CPU cores and uses that information to assign each core as either big or l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6bd6e12acc2f
unity_docs
rendering
In Unity's '3D texture preview reference', what is 'Volume' and how does it work?
In Volume preview mode, Unity displays the 3D texture as a translucent cube. Select and drag the cube to rotate the preview. Control Description Ramp Enable and disable color ramp so that Unity displays grayscale as color. If the image contains a lot of subtle details, enable Ramp to make the details easier to check. Q...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_251479cc1c33
unity_docs
scripting
Give me an overview of the `ConstantForce` class in Unity.
ConstantForce class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.PhysicsModule Description A force applied constantly. This is a small physics utility class used to apply a continous force to an object. Rigidbody.AddForce applies a force to the Rigidbody only for one frame, thus...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb519f644cdf
unity_docs
editor
What is `EditorApplication.wantsToQuit` in Unity? Explain its purpose and usage.
EditorApplication.wantsToQuit Description Unity raises this event when the editor application wants to quit. Add an event handler to this event to receive a notification that the application is attempting to quit. When this event is raised the quit process has started but can be cancelled. This means the editor is ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_704025c79d43
unity_docs
scripting
What is `Rendering.VertexAttributeFormat.Float32` in Unity? Explain its purpose and usage.
VertexAttributeFormat.Float32 Description 32-bit float number. This format matches the float data type in C# and other programming languages, and is default data type for most MeshAttributes. Additional resources: Mesh class, VertexAttribute enum, Mesh.GetVertexAttributeFormat .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7341a34f027d
unity_docs
performance
What is `Unity.Profiling.ProfilerCategoryColor` in Unity? Explain its purpose and usage.
ProfilerCategoryColor enumeration Description Profiler category colors enum. Use ProfilerCategoryColor to specific color of ProfilerCategory samples in the Timeline view of the CPU Usage Profiler module. Properties Property Description Render Render category markers color. Scripts Scripts category markers...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_19d41d1a5711
unity_docs
math
What is `UIElements.Vector2Field.ctor` in Unity? Explain its purpose and usage.
Vector2Field Constructor Declaration public Vector2Field (); Description Initializes and returns an instance of Vector2Field. Declaration public Vector2Field (string label ); Parameters Parameter Description label The text to use as a label. Description Initializes and returns an instance of Vect...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b4307a1e6d2
unity_docs
rendering
What is `UIElements.UsageHints.GroupTransform` in Unity? Explain its purpose and usage.
UsageHints.GroupTransform Description Optimizes rendering of a VisualElement that changes its transformation and position frequently, and has many descendants that have their hints set to DynamicTransform. This option is similar to DynamicTransform in that it allows GPU transformation of the vertices of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c00fa67f108a
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormatUtility.IsSIntFormat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.IsSIntFormat Declaration public static bool IsSIntFormat ( Experimental.Rendering.GraphicsFormat format ); Description Returns true if the format is a signed and integer format. Returns false otherwise...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebfef538e110
unity_docs
performance
Show me a Unity C# example demonstrating `Unity.Profiling.ProfilerMarker.End`.
); Description End profiling a piece of code marked with a custom name defined by this instance of ProfilerMarker . Always use Begin to start a section of an instrumented code. Code marked with Begin and End will show up in the Profiler hierarchy. Use Recorder to obtain per-frame timings in the Player. N...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1163a69a8c98
unity_docs
rendering
Show me a Unity code example for 'ShaderLab: legacy alpha testing'.
rams on import. ## Render pipeline compatibility Feature name Built-in Render Pipeline Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Custom SRP Legacy alpha testing Yes No No No After the final output color has been calculated, the color can optionally have its alpha value compared to a fixed...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bd9fa360fe4
unity_docs
rendering
What is `ParticleSystem.SetPlaybackState` in Unity? Explain its purpose and usage.
ParticleSystem.SetPlaybackState Declaration public void SetPlaybackState ( ParticleSystem.PlaybackState playbackState ); Parameters Parameter Description playbackState The PlaybackState to apply to the Particle System. Description Use this method with the results of an earlier call to ParticleSystem.Get...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59a173a528ce
unity_docs
rendering
What is `LightProbeProxyVolume.isFeatureSupported` in Unity? Explain its purpose and usage.
LightProbeProxyVolume.isFeatureSupported public static bool isFeatureSupported ; Description Checks if Light Probe Proxy Volumes are supported. The value depends on graphics hardware and graphics API used. LPPV requires at least Shader Model 4 , including RGBAFloat 3D texture support with linear filtering.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2580c54a65ff
unity_docs
scripting
Show me a Unity C# example demonstrating `AsyncOperation.progress`.
the operation's progress. (Read Only) Return an operation's progress. (Read Only) This returns how close the operation is to finishing. The operation is finished when the progress float reaches 1.0 and isDone is called. If you set allowSceneActivation to false, progress is halted at 0.9 until it is set to true. This i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_889677439a76
unity_docs
editor
Explain 'Attach the Frame Debugger to a built project' in Unity.
You can change the Frame Debugger’s target process to attach the Frame Debugger to a built Unity Player. To be compatible with the Frame Debugger, the Unity Player must: Use the Development Build Build Setting . Support multithreaded rendering. Every Unity platform except Web supports this. For desktop platforms, use t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_537a7300856b
unity_docs
rendering
In Unity's 'ZClip command in ShaderLab reference', what is 'Syntax' and how does it work?
This command makes a change to the render state. Use it in a Pass block to set the render state for that Pass, or use it in a SubShader block to set the render state for all Passes in that SubShader. Signature Example syntax Function ZClip [enabled] ZClip True Sets the depth clip mode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7cb0cad9a442
unity_docs
rendering
What is `ShaderGUI.ValidateMaterial` in Unity? Explain its purpose and usage.
ShaderGUI.ValidateMaterial Declaration public void ValidateMaterial ( Material material ); Parameters Parameter Description material The material to validate. Description When the user loads a Material using this ShaderGUI into memory or changes a value in the Inspector, the Editor calls this method. Use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_72b4f5f9921f
unity_docs
math
In Unity's 'Bindable data types and fields', what is 'Fields supported byPropertyField' and how does it work?
When the Inspector window is populated, if a custom Editor doesn’t exist for a type, the binding system calls InspectorElement.FillDefaultInspector() . This creates a PropertyField for each SerializedProperty on the SerializedObject . Each PropertyField has a matching control under it, such as an IntegerField to repres...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b883e0f117c1
unity_docs
math
What is `Sprites.DataUtility.GetPadding` in Unity? Explain its purpose and usage.
DataUtility.GetPadding Declaration public static Vector4 GetPadding ( Sprite sprite ); Description Return the padding on the sprite. If the sprite has been packed it is possible that edges have been cliped from the source sprite. This will give the edge clipped size in pixels for each edge (x=left, y=bottom...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb855d4a367c
unity_docs
scripting
What is `SpritePackingRotation` in Unity? Explain its purpose and usage.
SpritePackingRotation enumeration Description Sprite rotation modes for the Sprite Packer. Properties Property Description None No rotation. FlipHorizontal Sprite is flipped horizontally when packed. FlipVertical Sprite is flipped vertically when packed. Rotate180 Sprite is rotated 180 degree when packed. A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10f0a04002d2
unity_docs
scripting
What are the parameters of `Assertions.Assert.AreNotEqual` in Unity?
Description Assert that the values are not equal. Show message when the expected and actual are equal. ```csharp using UnityEngine; using UnityEngine.Assertions;public class AssertionExampleClass : MonoBehaviour { void Update() { // Make sure the Game Object's layer is never set to 0 Assert.AreN...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d63d5624aef4
unity_docs
scripting
What is `Unity.Properties.DontCreatePropertyAttribute` in Unity? Explain its purpose and usage.
DontCreatePropertyAttribute class in Unity.Properties / Implemented in: UnityEngine.PropertiesModule Description Use this attribute to prevent have a property from being automatically generated on a public field.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_33e1518a5260
unity_docs
scripting
In Unity's 'Navigation panel reference', what is 'Context list' and how does it work?
Select the context you want from the navigation panel. You can select from these options: Context Description In Project Displays all feature sets and packages installed in your project, including local , git , and embedded packages, and packages installed from any registry. The list also includes any packages from the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f8afb4008e9
unity_docs
rendering
Give me an overview of the `SpriteMask` class in Unity.
SpriteMask class in UnityEngine / Inherits from: Renderer Description A component for masking Sprites and Particles. By default it will mask all Sorting Layers. A custom range of Sorting Layers can be set. If a SortingGroup is present, it will act local to the SortingGroup. Properties Property Description a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b21abb229367
github
scripting
Write a Unity C# MonoBehaviour script called Video Controller
```csharp using UnityEngine; using UnityEngine.Video; namespace TapLive.Scripts { /// <summary> /// Video playback controller - moved from Assets/Scripts/ /// Compatible with 360/180/2D video playback /// </summary> [RequireComponent(typeof(VideoPlayer))] public class VideoController : MonoBeha...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_72a12eae783b
unity_docs
rendering
In Unity's 'Design a tree', what is 'Place the tree in the Ambient-Occlusion folder' and how does it work?
Trees can render correctly only when placed in a folder called Ambient-Occlusion . In the Project window, select the Assets folder. Select Add (+) > Folder . Give the folder the name Ambient-Occlusion . Move the tree prefab and its texture folder into the Ambient-Occlusion folder.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4234da0811e7
unity_docs
input
Give me an overview of the `LocationService` class in Unity.
LocationService class in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Provides methods that allow an application to access the device's location. Properties Property Description isEnabledByUser Indicates whether the device allows the application to access the location service. las...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26c6cc2cecfd
unity_docs
animation
What is `Animations.AnimatorController.AddMotion` in Unity? Explain its purpose and usage.
AnimatorController.AddMotion Declaration public Animations.AnimatorState AddMotion ( Motion motion ); Declaration public Animations.AnimatorState AddMotion ( Motion motion , int layerIndex ); Parameters Parameter Description motion The Motion that will be in the AnimatorState. layerIndex The la...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_052a735b07c4
unity_docs
xr
What is `XR.XRNodeState.tracked` in Unity? Explain its purpose and usage.
XRNodeState.tracked public bool tracked ; Description Set to true if the node is presently being tracked by the underlying XR system, and false if the node is not presently being tracked by the underlying XR system.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8092d24d9788
unity_docs
scripting
What is `UIOrientation` in Unity? Explain its purpose and usage.
UIOrientation enumeration Description Default mobile device orientation. Properties Property Description Portrait Portrait. PortraitUpsideDown Portrait upside down. LandscapeRight Landscape: clockwise from Portrait. LandscapeLeft Landscape : counter-clockwise from Portrait. AutoRotation Auto Rotation Enable...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_26d9685b8f3f
unity_docs
rendering
In Unity's 'Change particle color', what is 'Fade particles near opaque GameObjects' and how does it work?
To fade particles near opaque GameObjects , follow these steps: Enable a deferred rendering path , or output a depth texture from the camera . Go to Edit > Project Settings > Quality , then enable Soft Particles . Soft particles are supported only on platforms that support depth textures .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_538464d797b9
unity_docs
scripting
What is `Rendering.CommandBuffer.RequestAsyncReadback` in Unity? Explain its purpose and usage.
CommandBuffer.RequestAsyncReadback Declaration public void RequestAsyncReadback ( ComputeBuffer src , Action<AsyncGPUReadbackRequest> callback ); Declaration public void RequestAsyncReadback ( GraphicsBuffer src , Action<AsyncGPUReadbackRequest> callback ); Declaration public void RequestAsyncReadback ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6dde6ec2025
unity_docs
rendering
What is `ParticleSystem.ShapeModule.normalOffset` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.normalOffset public float normalOffset ; Description Move particles away from the surface of the source Mesh. Additional resources: ParticleSystem.ShapeModule.shapeType .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c58acd8ba7d1
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.SetMeshes`.
[] meshes , int size ); Parameters Parameter Description meshes The array of Meshes to use. size The number of elements from the Mesh array to apply. Description Sets the Meshes that the ParticleSystemRenderer uses to display particles when the ParticleSystemRenderer.renderMode is set to ParticleSyste...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee57c9373499
unity_docs
rendering
Show me a Unity C# example demonstrating `TextureMipmapLimitGroups.GetGroups`.
TextureMipmapLimitGroups.GetGroups Declaration public static string[] GetGroups (); Returns string[] String array of texture mipmap limit group names. Description Retrieves a string array containing the name of all texture mipmap limit groups available in the project. ```csharp using UnityEngine;public cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d2b5b64eab9
unity_docs
editor
What is `Build.Content.ContentBuildInterface.GetPlayerAssetRepresentations` in Unity? Explain its purpose and usage.
ContentBuildInterface.GetPlayerAssetRepresentations Declaration public static ObjectIdentifier[] GetPlayerAssetRepresentations (GUID asset , BuildTarget target ); Description Returns a list of visible objects directly contained inside of an asset. The returned objects are not loaded, and thus this method is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fa3d43c8f57
unity_docs
scripting
What is `AI.NavMesh.CreateSettings` in Unity? Explain its purpose and usage.
NavMesh.CreateSettings Declaration public static AI.NavMeshBuildSettings CreateSettings (); Returns NavMeshBuildSettings The created settings. Description Creates and returns a new entry of NavMesh build settings available for runtime NavMesh building. This is useful for creating and storing settings to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4ebf4cc23f2e_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Detaching the BaseStream or Disposing the Reader leaves the stream in a consistent state.SketchBinaryReader also doesn't (currently) do any pre-reading or caching. Signature: ```csharp public Stream BaseStream ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_3f42beda7630
unity_docs
editor
What is `VersionControl.Asset.Edit` in Unity? Explain its purpose and usage.
Asset.Edit Declaration public void Edit (); Description Opens the assets in an associated editor. Will try to open the asset in an associated editor. Eg. if png files are associated to Photoshop the png file will be loaded in photoshop.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a1c13fa519de
unity_docs
rendering
What is `Texture3D.SetPixel` in Unity? Explain its purpose and usage.
Texture3D.SetPixel Declaration public void SetPixel (int x , int y , int z , Color color , int mipLevel = 0); Parameters Parameter Description x The x coordinate of the pixel to set. The range is 0 through the (texture width - 1). y The y coordinate of the pixel to set. The range is 0 through t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e8374f68cd2
unity_docs
editor
What is `AssetDatabase.GetMainAssetTypeFromGUID` in Unity? Explain its purpose and usage.
AssetDatabase.GetMainAssetTypeFromGUID Declaration public static Type GetMainAssetTypeFromGUID (GUID guid ); Parameters Parameter Description guid The GUID of the asset. Returns Type Returns the type of the main asset object with guid . Description Obtains the type of the main object of a given asse...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2235a9504d89
unity_docs
scripting
What is `ParticleSystem.NoiseModule.remapZMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.NoiseModule.remapZMultiplier public float remapZMultiplier ; Description z-axis remap multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall remap multiplier. Additional resources: ParticleSystem.NoiseModule.remapZ . ```csha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5737bd064e5a
unity_docs
math
What is `Vector2.Normalize` in Unity? Explain its purpose and usage.
Vector2.Normalize Declaration public void Normalize (); Description Makes this vector have a magnitude of 1. When normalized, a vector keeps the same direction but its length is 1.0. Note that this function will change the current vector. If you want to keep the current vector unchanged, use normalized vari...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5773f6a2d6f0
unity_docs
editor
What are the parameters of `EditorGUILayout.PasswordField` in Unity?
Returns string The password entered by the user. Description Make a text field where the user can enter a password. This works just like GUILayout.PasswordField , but correctly responds to select all, etc. in the editor, and it can have an optional label in front. Simple window that visualizes what you have typed in th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_88693810b0cf
unity_docs
rendering
What is `RenderTextureDescriptor.useDynamicScale` in Unity? Explain its purpose and usage.
RenderTextureDescriptor.useDynamicScale public bool useDynamicScale ; Description Set to true to enable dynamic resolution scaling on this render texture. Mutually exclusive with RenderTextureDescriptor.useDynamicScaleExplicit Additional resources: RenderTexture.useDynamicScale .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8a7a19630505
unity_docs
scripting
Show me a Unity C# example demonstrating `Input.gyro`.
fer to Input . Use this to return the gyroscope details of your device. Ensure first that your device has a gyroscope. Use Input.gyro.enabled to check this. Knowing the gyroscope details of a device enables you the ability to include features that need to know a device’s orientation. Common uses include changing camer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ad438122fbd
unity_docs
physics
What is `Collision2D.collider` in Unity? Explain its purpose and usage.
Collision2D.collider public Collider2D collider ; Description The incoming Collider2D involved in the collision with the otherCollider . This collider is attached to the Collision2D.rigidbody . Additional resources: Collider2D and Rigidbody2D . ```csharp using UnityEngine; using System.Collections;pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4822a11d0e57
unity_docs
scripting
What is `Media.MediaRational.operator_double` in Unity? Explain its purpose and usage.
MediaRational.double Parameters Parameter Description r Rational number to convert. Description Returns the rational value expressed as a floating point value. A loss of precision may result when performing the division. Converting invalid rationals (see isValid ) returns 0.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ea37b7a3ec74
unity_docs
math
What is `Windows.File` in Unity? Explain its purpose and usage.
File class in UnityEngine.Windows / Implemented in: UnityEngine.CoreModule Description Provides static methods for file operations. The UnityEngine.Windows.File class is available only for the Universal Windows Platform. It was recommended during the times in which the System.IO.File class was not available fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2a935313e0eb
unity_docs
rendering
What is `ParticleSystemTrailTextureMode` in Unity? Explain its purpose and usage.
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_9f8fd4841833
unity_docs
audio
What is `Android.AndroidProjectFiles.SetManifestFile` in Unity? Explain its purpose and usage.
AndroidProjectFiles.SetManifestFile Declaration public void SetManifestFile (string path , Unity.Android.Gradle.Manifest.AndroidManifestFile manifest ); Parameters Parameter Description path The file path to place the Manifest file at. This path is relative to the gradle project path. manifest The rep...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_66eadb1fe7dc
github
scripting
Write a Unity C# script called Graphic Color Setter
```csharp using UnityEngine; using UnityEngine.UI; namespace LeakyAbstraction.ReactiveScriptables { [ExecuteInEditMode] [RequireComponent(typeof(Graphic))] public class GraphicColorSetter : ColorSetterBase<Graphic> { protected override void SetColor(Color color) => _component.color...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_343762047e91
unity_docs
scripting
Explain 'Apple’s privacy manifest policy requirements' in Unity.
Apple requires new and updated applications targeted for iOS, iPadOS, macOS, tvOS, and visionOS platforms on the App Store to include privacy manifest files . The privacy manifest file ( PrivacyInfo.xcprivacy ) lists the types of data your Unity applications, or any third-party SDKs, packages, and plug-ins collect, and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_177dfec6bcc1
unity_docs
scripting
In Unity's 'Create or delete a package draft', what is 'Create a package draft' and how does it work?
To create a new package draft: Open the Asset Store Publisher Portal Select Create a package to create a package draft. Enter package details before or after you add assets to the package draft. Add and upload assets to your package draft.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7cd071958059
unity_docs
editor
What are the parameters of `AssetSettingsProvider.CreateProviderFromAssetPath` in Unity?
Returns AssetSettingsProvider Returns an AssetSettingsProvider that will create an Editor for this particular asset. Description Create an AssetSettingsProvider from an asset path. ```csharp using UnityEngine; using UnityEditor;class MyCustomSettings : ScriptableObject { public const string k_MyCustomSettingsPath =...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2637f38ca657
unity_docs
rendering
What is `EditorUtility.FocusProjectWindow` in Unity? Explain its purpose and usage.
EditorUtility.FocusProjectWindow Declaration public static void FocusProjectWindow (); Description Brings the project window to the front and focuses it. This is commonly called after a menu item that creates and selects an asset is invoked. Changes the color of the selected GameObjects. ```csharp using Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_40b8edae93ad
unity_docs
scripting
What is `UIElements.DisplayStyle` in Unity? Explain its purpose and usage.
DisplayStyle enumeration Description Defines how an element is displayed in the layout. Properties Property Description Flex The element displays normally. None The element isn't visible and absent from the layout.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7dfada839db5
unity_docs
ui
In Unity's 'Handle event callbacks and value changes', what is 'Register an event callback' and how does it work?
You can register an event callback to customize the behavior of an individual instance of an existing class, such as reacting to a mouse click on a text label. To register a callback for an event, use the RegisterCallback() method to register the callback directly on the element. Each element along the propagation path...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5cc4846b986e
unity_docs
editor
What is `AssetImporter.SourceAssetIdentifier` in Unity? Explain its purpose and usage.
SourceAssetIdentifier struct in UnityEditor Description Represents a unique identifier for a sub-asset embedded in an imported Asset (such as an FBX file). Properties Property Description name The name of the Asset. type The type of the Asset. Constructors Constructor Description AssetImporter.SourceAsset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cccc1b2c76e2
unity_docs
scripting
What is `Experimental.GraphView.RectangleSelector.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. RectangleSelector Constructor Declaration public RectangleSelector (); Description RectangleSelector's constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f5725d690fe
unity_docs
scripting
What is `ContactFilter2D.IsFilteringDepth` in Unity? Explain its purpose and usage.
ContactFilter2D.IsFilteringDepth Declaration public bool IsFilteringDepth ( GameObject obj ); Parameters Parameter Description obj The GameObject used to check the z-position (depth) of Transform.position . Returns bool Returns true when obj is excluded by the filter and false if otherwise. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5fd9f22ec57e
unity_docs
editor
Show me a Unity C# example demonstrating `AssetImporter.RemoveRemap`.
entifier identifier ); Parameters Parameter Description identifier The identifier of the sub-asset. Returns bool Returns true if an element was removed, otherwise false. Description Removes an item from the map of external objects. Apply changes by writing the metadata and reimporting the Asset. The e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5ac16bc8fc0
unity_docs
rendering
What is `GUILayout.Box` in Unity? Explain its purpose and usage.
GUILayout.Box Declaration public static void Box ( Texture image , params GUILayoutOption[] options ); Declaration public static void Box (string text , params GUILayoutOption[] options ); Declaration public static void Box ( GUIContent content , params GUILayoutOption[] options ); Declaration pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cd8c3a1ab952
unity_docs
ui
Show me a Unity code example for 'ToggleButtonGroup'.
or example: C# To create a ToggleButtonGroup in C#, create a new instance of a ToggleButtonGroup object and add a set of Buttons . By default, you can select one button at a time. To enable multiple selections, set the is-multiple-selection to true . To enable empty selection, set the allow-empty-selection to true . #...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4b4691601fa9
unity_docs
scripting
Explain 'API updater' in Unity.
To improve usability and performance, Unity might change the way classes, functions and properties (the API) work. Occasionally, these improvements might introduce breaking changes when moving from one major Unity version to another. To minimize the impact of breaking changes, the API updater identifies and updates obs...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_196f6557f6b2
unity_docs
ui
What is `UIElements.VisualElement.Hierarchy.operator_eq` in Unity? Explain its purpose and usage.
VisualElement.Hierarchy.operator == public static bool operator == ( UIElements.VisualElement.Hierarchy x , UIElements.VisualElement.Hierarchy y ); Parameters Parameter Description x The left operand of the comparison. y The right operand of the comparison. Returns bool Returns true if the two inst...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_14c4d8546812
unity_docs
rendering
Explain 'Disable sRGB sampling for a texture' in Unity.
You can disable sRGB sampling to ensure a Texture is imported with the original color space of the image. To do this, in the Inspector window for the Texture: Set the Texture Type property to the appropriate setting for the Texture’s intended use. Uncheck sRGB (Color Texture) if it is shown.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a7ce402479af
unity_docs
math
What is `AndroidJNI.SetFloatArrayElement` in Unity? Explain its purpose and usage.
AndroidJNI.SetFloatArrayElement Declaration public static void SetFloatArrayElement (IntPtr array , int index , float val ); Description Sets the float value of one element in a primitive array. This function is a special case of SetFloatArrayRegion(), called with region size set to 1. Additional resources: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1b40c02f23da_doc_2
github
scripting
What does `OnLateUpdate` do in this Unity script? Explain its purpose and signature.
Called in response to the lifecycle managerlate update event function being called, if this subsystem is running. Signature: ```csharp protected virtual void OnLateUpdate() ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_57b8ca247e6e
unity_docs
scripting
What is `UIElements.DragAndDropPosition` in Unity? Explain its purpose and usage.
DragAndDropPosition enumeration Description Position where the drop operation occurs. Properties Property Description OverItem Dragging over an item, to add as a child. BetweenItems Dragging between items, to add as a sibling. OutsideItems Dragging in front or after visible items.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_96be9d734af1
unity_docs
xr
What is `Networking.UnityWebRequestTexture` in Unity? Explain its purpose and usage.
UnityWebRequestTexture class in UnityEngine.Networking / Implemented in: UnityEngine.UnityWebRequestTextureModule Description Helpers for downloading image files into Textures using UnityWebRequest . Static Methods Method Description GetTexture Create a UnityWebRequest intended to download an image via HTTP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dc56d2f58ddf
unity_docs
audio
What is `AudioSource.PlayDelayed` in Unity? Explain its purpose and usage.
AudioSource.PlayDelayed Declaration public void PlayDelayed (float delay ); Parameters Parameter Description delay Delay time specified in seconds. Description Plays the clip with a delay specified in seconds. Users are advised to use this function instead of the old Play(delay) function that took a del...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41c50059d887
unity_docs
scripting
What is `Pool.ObjectPool_1.Get` in Unity? Explain its purpose and usage.
ObjectPool<T0>.Get Declaration public T Get (); Returns T A pooled object or a new instance if the pool is empty. Description Get an instance from the pool. If the pool is empty then a new instance is created. Calls to Get invoke the delegate passed to the constructor as the actionOnGet parameter. New...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8d01ca9f0ab
unity_docs
scripting
Show me a Unity C# example demonstrating `CharacterController.center`.
CharacterController.center public Vector3 center ; Description The center of the character's capsule relative to the transform's position. ```csharp using UnityEngine;public class Example : MonoBehaviour { CharacterController controller; private void Start() { controller = GetComponent<CharacterControlle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5babac3a084f
unity_docs
scripting
Give me an overview of the `ParticleSystemEmitterVelocityMode` class in Unity.
ParticleSystemEmitterVelocityMode enumeration Description Control how a Particle System calculates its velocity. Properties Property Description Transform Calculate the Particle System velocity by using the Transform component. Rigidbody Calculate the Particle System velocity by using a Rigidbody or Rigidbody2...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_751342b2d8d6
unity_docs
editor
What is `Search.SearchExpressionContext.ResolveAlias` in Unity? Explain its purpose and usage.
SearchExpressionContext.ResolveAlias Declaration public string ResolveAlias (string defaultLabel ); Declaration public string ResolveAlias ( Search.SearchExpression expr , string defaultLabel ); Parameters Parameter Description defaultLabel If no exeuction frames are present this becomes the default a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_99646773ea74
unity_docs
editor
What is `EditorGUILayout.DropdownButton` in Unity? Explain its purpose and usage.
EditorGUILayout.DropdownButton Declaration public static bool DropdownButton ( GUIContent content , FocusType focusType , params GUILayoutOption[] options ); Declaration public static bool DropdownButton ( GUIContent content , FocusType focusType , GUIStyle style , params GUILayoutOption[] options...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3651cee6839c
unity_docs
math
What is `Compass.rawVector` in Unity? Explain its purpose and usage.
Compass.rawVector public Vector3 rawVector ; Description The raw geomagnetic data measured in microteslas. (Read Only) The compass is actually a magnetometer that measures the magnetic field in the device's XYZ coordinates - in the absence of a stronger magnet, it will measure the Earth's field from which t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e84beae6313b
unity_docs
scripting
What is `SceneManagement.StageUtility.GetCurrentStageHandle` in Unity? Explain its purpose and usage.
StageUtility.GetCurrentStageHandle Declaration public static SceneManagement.StageHandle GetCurrentStageHandle (); Returns StageHandle The current stage. Description Get the current stage being edited.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84b2332fefcd
unity_docs
scripting
What is `Display.systemWidth` in Unity? Explain its purpose and usage.
Display.systemWidth public int systemWidth ; Description Horizontal native display resolution. Actual rendering resolution might be different, see Display.renderingWidth . Additional resources: systemHeight , renderingWidth .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_910b4113bd7e
unity_docs
ui
Show me a Unity C# example demonstrating `CursorLockMode.None`.
CursorLockMode.None Description Cursor behavior is unmodified. ```csharp //This script makes Buttons that control the Cursor's lock state. Note that the Confined mode only works on Windows and Linux Standalone platform build.using UnityEngine;public class Example : MonoBehaviour { void Update() { //Press the spa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f43a812486cd
unity_docs
input
What is `XR.CommonUsages.secondary2DAxisTouch` in Unity? Explain its purpose and usage.
CommonUsages.secondary2DAxisTouch public static InputFeatureUsage<bool> secondary2DAxisTouch ; Description Represents the secondary 2D axis being touched. The secondary 2D axis is the Vector2 input feature tagged with CommonUsages.secondary2DAxis .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dcdd2d2a92f8
unity_docs
physics
Give me an overview of the `ContactPair` class in Unity.
ContactPair struct in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description A pair of Colliders that belong to the bodies in the parent ContactPairHeader struct. Contains an array of ContactPairPoint s that can be retrieved using the GetContactPoint method. Properties Property Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90dcc09f3a00
unity_docs
editor
Show me a Unity C# example demonstrating `SettingsProviderGroupAttribute`.
SettingsProviderGroupAttribute class in UnityEditor Description Attribute used to register multiple SettingsProvider items. Use this attribute to decorate a function that returns an array of SettingsProvider instances. If the function returns null, no SettingsProvider appears in the Settings window. ```csharp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_207e0dc66b92
unity_docs
performance
What is `Unity.Jobs.LowLevel.Unsafe.JobsUtility.Schedule` in Unity? Explain its purpose and usage.
JobsUtility.Schedule Declaration public static Unity.Jobs.JobHandle Schedule (ref Unity.Jobs.LowLevel.Unsafe.JobsUtility.JobScheduleParameters parameters ); Returns JobHandle A JobHandle to the new job. Description Schedules a single IJob .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7528f79a6bed_doc_1
github
scripting
What does `Init` do in this Unity script? Explain its purpose and signature.
Provides the with the objects that it depends on.You can think of the function as a parameterized constructor alternative for the component. gets called when the script is being loaded, before the , OnEnable and Start events whenthe component is created using or.Note that gets called immediately following object cr...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_15161d5a8d3c
unity_docs
scripting
Show me a Unity C# example demonstrating `Application.dataPath`.
ning a split binary build, it points to the OBB instead. UWP Apps: The absolute path to the player data folder (this folder is read only, use Application.persistentDataPath to save data) Note that the string returned on a PC will use a forward slash as a folder separator. For any unlisted platform, run the example...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10f5bac2ec4c
unity_docs
scripting
What is `LogOption` in Unity? Explain its purpose and usage.
LogOption enumeration Description Option flags for specifying special treatment of a log message. Properties Property Description None Normal log message. NoStacktrace The log message will not have a stacktrace appended automatically.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c905759adec
unity_docs
physics
What is `RaycastHit2D.operator_RaycastHit2D` in Unity? Explain its purpose and usage.
RaycastHit2D.bool Parameters Parameter Description hit The RaycastHit2D to being checked for valid results. Description Implicit operator used to return a true or false result indicating if the result is valid or not. When using any physics query that returns a RaycastHit2D, you should always first check t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b9b490e9d2b1
unity_docs
physics
What is `IMGUI.Controls.JointAngularLimitHandle.wireframeAlpha` in Unity? Explain its purpose and usage.
JointAngularLimitHandle.wireframeAlpha public float wireframeAlpha ; Description Returns or specifies the opacity to use for the curved lines along the outside of the arcs of motion. Defaults to 1.0. This value is multiplied with the value of the color for the axis being drawn, which is multiplied with the valu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b45a3e650a4d
unity_docs
math
What is `Mathf.Clamp01` in Unity? Explain its purpose and usage.
Mathf.Clamp01 Declaration public static float Clamp01 (float value ); Description Clamps value between 0 and 1 and returns value. If the value is negative then zero is returned. If value is greater than one then one is returned. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Set the p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9d92a7354b8
unity_docs
rendering
What is `Material.HasBuffer` in Unity? Explain its purpose and usage.
Material.HasBuffer Declaration public bool HasBuffer (string name ); Declaration public bool HasBuffer (int nameID ); Parameters Parameter Description name The name of the property. nameID The name ID of the property. Use Shader.PropertyToID to get this ID. Returns bool Returns true if the Shad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.