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_1d29022dac1e
unity_docs
rendering
Explain 'Setting the render state on the GPU' in Unity.
Use these commands within a Pass block to set the render state for that Pass, or within a SubShader block to set the render state for that SubShader and any Passes that it contains. Page Description Enable conservative rasterization in a shader Use the Conservative command to rasterize pixels that are partially covered...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c78864fb3aac
github
scripting
Write a Unity C# script called Bouncy Ball View
```csharp using System.Collections; using RMC.Core.Architectures.Umvcs.Samples.MyBouncyBallExample.Umvcs.Controller.Commands; using RMC.Core.Architectures.Umvcs.Samples.MyBouncyBallExample.Umvcs.Controller.Events; using RMC.Core.Architectures.Umvcs.View; using UnityEngine; namespace RMC.Core.Architectures.Umvcs.Sampl...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_a92b492a704c
unity_docs
audio
What is `Device.SystemInfo.supportsAudio` in Unity? Explain its purpose and usage.
SystemInfo.supportsAudio public static bool supportsAudio ; Description This has the same functionality as SystemInfo.supportsAudio and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_854e5ec3650f
unity_docs
scripting
What is `UIElements.PropertyField` in Unity? Explain its purpose and usage.
PropertyField class in UnityEditor.UIElements / Inherits from: UIElements.VisualElement Implements interfaces: IBindable Description A SerializedProperty wrapper VisualElement that, on Bind(), will generate the correct field elements with the correct binding paths. For more information, refer to UXML element ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86c472909ed9
unity_docs
audio
Show me a Unity C# example demonstrating `AudioChorusFilter.wetMix3`.
AudioChorusFilter.wetMix3 public float wetMix3 ; Description Volume of 3rd chorus tap. This tap is 90 degrees out of phase of the second tap. 0.0 to 1.0. Default = 0.5. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioChorusFilter))] public class Example : MonoB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1bb2f35bdcdf
unity_docs
rendering
What is `Rendering.SupportedRenderingFeatures.overridesEnvironmentLighting` in Unity? Explain its purpose and usage.
SupportedRenderingFeatures.overridesEnvironmentLighting public bool overridesEnvironmentLighting ; Description Determines if the renderer will override the Environment Lighting and will no longer need the built-in UI for it.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2679936588a0
unity_docs
math
What are the parameters of `Graphics.RenderPrimitivesIndexed` in Unity?
Description Renders indexed primitives with GPU instancing and a custom shader. Renders a given number of instances and primitives that have specific topology. This method requires custom shaders to fetch or calculate vertex data using the SV_VertexID semantic, which is set with values in the indexBuffer . To access in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1be0bb267429
unity_docs
scripting
What is `PackageManager.UI.PackageManagerExtensions.RegisterExtension` in Unity? Explain its purpose and usage.
PackageManagerExtensions.RegisterExtension Declaration public static void RegisterExtension ( PackageManager.UI.IPackageManagerExtension extension ); Parameters Parameter Description extension A Package Manager UI extension. Description Registers a new Package Manager UI extension.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec7528c8d77c
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.NoiseModule.remapYMultiplier`.
ParticleSystem.NoiseModule.remapYMultiplier public float remapYMultiplier ; Description y-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.remapY . ```csha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e8878d78b6b
unity_docs
math
Show me a Unity C# example demonstrating `Rect.position`.
Rect.position public Vector2 position ; Description The X and Y position of the rectangle. This is the same as min , except that setting it will move the rectangle rather than resize it. ```csharp using UnityEngine;// Show Rect, the position selected randomly.public class RectExample : MonoBehaviour { priv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ec681370fbd
unity_docs
physics
What is `Collision2D` in Unity? Explain its purpose and usage.
Collision2D class in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description Collision details returned by 2D physics callback functions. The collisions details are returned by MonoBehaviour.OnCollisionEnter2D , MonoBehaviour.OnCollisionStay2D and MonoBehaviour.OnCollisionExit2D callbacks. It...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ef6558fa833
unity_docs
scripting
What is `Rendering.BatchCullingProjectionType` in Unity? Explain its purpose and usage.
BatchCullingProjectionType enumeration Description The projection type of a view that is being culled. Properties Property Description Unknown The type of the projection is unknown. Perspective Objects get smaller as their distance from the viewpoint increases. Orthographic Parallel lines in world-space remai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a5a088817e0
unity_docs
audio
What is `AudioSource.GetAmbisonicDecoderFloat` in Unity? Explain its purpose and usage.
AudioSource.GetAmbisonicDecoderFloat Declaration public bool GetAmbisonicDecoderFloat (int index , out float value ); Parameters Parameter Description index Zero-based index of user-defined parameter to be read. value Return value of the user-defined parameter that is read. Returns bool True, if the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8464120ebe3b
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.isPlaying`.
ParticleSystem.isPlaying public bool isPlaying ; Description Determines whether the Particle System is playing. isPlaying is true from when the Particle System begins to play until its last live particle dies. isPlaying is false when the Particle System is no longer spawning particles and is not simulat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b26009da770b
unity_docs
physics
What is `MeshCollider.cookingOptions` in Unity? Explain its purpose and usage.
MeshCollider.cookingOptions public MeshColliderCookingOptions cookingOptions ; Description Options used to enable or disable certain features in mesh cooking. Mesh cooking is a process of turning a normal mesh into a mesh that is suitable for use in the physics engine. Cooking builds the spatial search struc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7d215880c1e1
unity_docs
scripting
What are the parameters of `Vector3.LerpUnclamped` in Unity?
Returns Vector3 Interpolated value. This value always lies on a line that passes through points a and b . Description Interpolates linearly between two vectors, allowing extrapolation beyond the end points. Unclamped linear interpolation allows for values of t less than zero or greater than one, such that the returned ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d91733823139
unity_docs
xr
What is `Scripting.RequireAttributeUsagesAttribute` in Unity? Explain its purpose and usage.
RequireAttributeUsagesAttribute class in UnityEngine.Scripting / Implemented in: UnityEngine.CoreModule Description Only allowed on attribute types. If the attribute type is marked, then so too will all CustomAttributes of that type. Note that Low and Medium Managed Stripping Levels do not remove any CustomAttr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6af051847b1b
unity_docs
scripting
What is `Experimental.GraphView.SearchWindow` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SearchWindow class in UnityEditor.Experimental.GraphView / Inherits from: EditorWindow Description This subclass displays a searchable menu of available graph nodes. Static Methods Method Description Open Opens the search...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10be892e6eab
unity_docs
scripting
What is `UIElements.BaseTreeViewController.IsExpandedByIndex` in Unity? Explain its purpose and usage.
BaseTreeViewController.IsExpandedByIndex Declaration public bool IsExpandedByIndex (int index ); Parameters Parameter Description index The item index Returns bool Whether the item with the specified index is expanded in the tree. Will return false if the index is not valid. Description Return wheth...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4d71439e545d
unity_docs
animation
Show me a Unity code example for 'Mecanim FAQ'.
to one or should the weight be zero when using another layer? The base layer weight is always 1 and override layers will completely override the base layer. Is there any way to get a variable value from the controller without using the name string? You can use integers to identify the states and parameters. Use the Ani...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0c92264c614
unity_docs
scripting
What is `Vector3.Angle` in Unity? Explain its purpose and usage.
Vector3.Angle Declaration public static float Angle ( Vector3 from , Vector3 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 angle in degrees between the two vectors. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_06b95856406e
unity_docs
physics
What is `OverlapCapsuleCommand.queryParameters` in Unity? Explain its purpose and usage.
OverlapCapsuleCommand.queryParameters public QueryParameters queryParameters ; Description Structure for specifying additional parameters for a batch query such as layer mask or hit triggers.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ada93541e7d5
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.RadeonRaysContext.Flush`.
RadeonRaysContext.Flush Declaration public bool Flush (); Returns bool True if the flush was successful. Description Flush the device context. Start execution of the enqueued operations on the device. On some platforms the underlying implementation or driver flushes automatically, on others it is up to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_35ae48ae587d_doc_0
github
scripting
What does `new` do in this Unity script? Explain its purpose and signature.
A class with a field that canbe used to draw an 'Add Entry' control below the entries of an actual in an editor interface (i.e. the inspector).Type of ordered dictionary that is to be edited. Signature: ```csharp public abstract class EditableEntry<TOrderedDictionary> : EditableEntry where TOrderedDictionary ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_d33ab07f0ae4
unity_docs
scripting
What is `UIElements.UQueryState_1.First` in Unity? Explain its purpose and usage.
UQueryState<T0>.First Declaration public T First (); Returns T The first element matching all the criteria, or null if none was found. Description The first element matching all the criteria, or null if none was found.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_370ef4fa38a2
unity_docs
physics
What is `CollisionDetectionMode2D.Discrete` in Unity? Explain its purpose and usage.
CollisionDetectionMode2D.Discrete Description When a Rigidbody2D moves, only collisions at the new position are detected. When using this mode, Rigidbody2D that are moving fast can overlap or even pass through other colliders. This mode however is much faster to calculate and should only be used when objects ar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8b556c2f8d8
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody2D.AddTorque`.
ither as a force or an impulse, you can use any value to get the required change in angularVelocity . However, if you require a specific change in degrees, then you must first convert the torque value into radians by multiplying with Mathf.Deg2Rad then multiplying by the inertia . The following example demonstrat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8581c81fc4f7
unity_docs
rendering
What is `TerrainData.SyncTexture` in Unity? Explain its purpose and usage.
TerrainData.SyncTexture Declaration public void SyncTexture (string textureName ); Parameters Parameter Description textureName The name of the Terrain texture to synchronize. Description Performs synchronization queued by previous calls to CopyActiveRenderTextureToTexture and DirtyTextureRegion , which...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_8e0e6f762530_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Recorder input for recording video frames from one or more game cameras. Signature: ```csharp public sealed class CameraInput : IDisposable ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_b56cd8ac53e2
unity_docs
editor
What is `PlayerSettings.Android.fullscreenMode` in Unity? Explain its purpose and usage.
PlayerSettings.Android.fullscreenMode public static FullScreenMode fullscreenMode ; Description The display mode for Android Player builds of your application. Android supports FullScreenMode.Windowed and FullScreenMode.FullScreenWindow . For more information, refer to FullScreenMode ```csharp using Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_959e1c3cd868
unity_docs
rendering
What is `ModelImporterMaterialName.BasedOnTextureName` in Unity? Explain its purpose and usage.
ModelImporterMaterialName.BasedOnTextureName Description Use material names in the form <textureName>.mat. Material names will be accepted in the form <textureName>.mat (ie, the diffuse texture name of the imported material) when searching for existing materials or creating new ones. If the imported material does...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46154f936938
unity_docs
performance
What is `ShortcutManagement.IShortcutManager.RenameProfile` in Unity? Explain its purpose and usage.
IShortcutManager.RenameProfile Declaration public void RenameProfile (string profileId , string newProfileId ); Parameters Parameter Description profileId ID of existing profile. newProfileId New ID for profile. Description Renames the ID of a profile. Changes the ID of the Throws ArgumentNullExceptio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7a9491dfd71
unity_docs
math
What is `Transform.InverseTransformVector` in Unity? Explain its purpose and usage.
Transform.InverseTransformVector Declaration public Vector3 InverseTransformVector ( Vector3 vector ); Description Transforms a vector from world space to local space. The opposite of Transform.TransformVector . This operation is not affected by position of the transform but it is affected by scale. The...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4213526a3790
unity_docs
scripting
What is `Search.RefreshFlags` in Unity? Explain its purpose and usage.
RefreshFlags enumeration Description Refresh flags are used to indicate why search view needs to be refreshed or updated. Properties Property Description None No particular refresh reason were specified. Default Normal refresh. StructureChanged The structure of the current selection data has changed (i.e. the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cca7f2ef75b3
unity_docs
scripting
What is `Rendering.AttachmentDescriptor.ConfigureTarget` in Unity? Explain its purpose and usage.
AttachmentDescriptor.ConfigureTarget Declaration public void ConfigureTarget ( Rendering.RenderTargetIdentifier target , bool loadExistingContents , bool storeResults ); Parameters Parameter Description tgt The surface to use as the backing storage for this AttachmentDescriptor. loadExistingContents Whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52ff66f04da8
unity_docs
rendering
What is `Texture2D.PackTextures` in Unity? Explain its purpose and usage.
Texture2D.PackTextures Declaration public Rect[] PackTextures (Texture2D[] textures , int padding , int maximumAtlasSize , bool makeNoLongerReadable ); Parameters Parameter Description textures Array of textures to pack into the atlas. padding Padding in pixels between the packed textures. maximumAtlas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_84fb37c95df4_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Example hand processor that applies transformations on the root poses tomodify the hands skeleton. Note it is possible to modify the bonesdirectly for more advanced use cases that are not shown here. Signature: ```csharp public class HandProcessor : MonoBehaviour, IXRHandProcessor ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acdd7e0e4028
unity_docs
rendering
Give me an overview of the `CubemapArray` class in Unity.
CubemapArray class in UnityEngine / Inherits from: Texture / Implemented in: UnityEngine.CoreModule Description Class for handling Cubemap arrays. Modern graphics APIs, such as D3D10.1 and later, OpenGL 4.0 and later, and Metal on macOS support cubemap arrays, which are arrays of cubemaps with same size and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8534b3133ed3
unity_docs
scripting
What is `SubsystemsImplementation.SubsystemWithProvider.Start` in Unity? Explain its purpose and usage.
SubsystemWithProvider.Start Declaration public void Start (); Description Starts an instance of a subsystem. Once the instance is started, the subsystem representing this instance is active and can be interacted with.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6d61bf75247f
unity_docs
physics
Explain 'fixed-updates' in Unity.
## Fixed updates Unlike the main frame update , Unity’s physics system updates at a fixed time interval, which is important for the accuracy and consistency of physics simulations. The interval between fixed updates is often referred to as the fixed timestep . You can read or change the fixed timestep in two ways: In ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_12d47965c403
unity_docs
scripting
What is `SearchService.SceneSearch.RegisterEngine` in Unity? Explain its purpose and usage.
SceneSearch.RegisterEngine Declaration public static void RegisterEngine ( SearchService.ISceneSearchEngine engine ); Parameters Parameter Description engine The Scene search engine to register. Description Registers a Scene search engine dynamically. If you set a dynamically registered engine as the act...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_483fb51fbc6f
unity_docs
scripting
What is `UIElements.StartDragArgs.ctor` in Unity? Explain its purpose and usage.
StartDragArgs Constructor Declaration public StartDragArgs (string title , UIElements.DragVisualMode visualMode ); Parameters Parameter Description title The text to use during the drag. visualMode The visual mode the drag starts with. Description Initializes a StartDragArgs .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db1386cc8def
unity_docs
editor
Show me a Unity C# example demonstrating `SerializedObject.GetIterator`.
e desired field name is known, it is better to use FindProperty to retrieve the associated SerializedProperty more quickly. However this method can be useful for more general code that needs to scan different types of objects, e.g. when the names of desired properties is not known in advance. Additional resources:...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30657a2d3e8c
unity_docs
input
What is `KeyCode.Mouse1` in Unity? Explain its purpose and usage.
KeyCode.Mouse1 Description Right mouse button (or secondary mouse button). Use this to detect right mouse button presses. The “1” mouse button is the secondary button on the user’s mouse, which is usually the right mouse button. Unity defines this as the "1" mouse button, as the mouse button numbering begins at 0. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_187ca0f60d48
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoPlayer`.
t to be visible. When the data VideoPlayer.source is set to URL, the audio and video description of what is being played will only be initialized once the VideoPlayer preparation is completed. You can test this with VideoPlayer.isPrepared . Refer to Video file compatibility for more information on supported vide...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b989c489bb93
unity_docs
scripting
What is `ParticleSystem.MainModule.startSizeY` in Unity? Explain its purpose and usage.
ParticleSystem.MainModule.startSizeY public ParticleSystem.MinMaxCurve startSizeY ; Description The initial size of particles along the y-axis when the Particle System first spawns them. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(Parti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd6f601fd360
unity_docs
editor
What is `Search.SearchIndexer.name` in Unity? Explain its purpose and usage.
SearchIndexer.name public string name ; Description Name of the index. Generally this name is set by a user from SearchDatabase.Settings. ```csharp using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; /// <summary> /// The index name can be used t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa4aeea45cb0
unity_docs
math
What is `Vector3Int.magnitude` in Unity? Explain its purpose and usage.
Vector3Int.magnitude public float magnitude ; Description Returns the length of this vector (Read Only). The length of the vector is square root of (x*x+y*y+z*z) . If you only need to compare magnitudes of some vectors, you can compare squared magnitudes of them using sqrMagnitude (computing squared magnitud...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c7d11907f2b9
unity_docs
editor
What is `SerializedProperty.depth` in Unity? Explain its purpose and usage.
SerializedProperty.depth public int depth ; Description Nesting depth of the property. (Read Only) Additional resources: propertyPath . ```csharp using System; using System.Text; using UnityEngine; using UnityEditor;public class SerializePropertyDepthExample : ScriptableObject { // Declare fields to demonstr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e1de476f2118
unity_docs
networking
Show me a Unity code example for 'Set up your Node.js server configuration for Web builds'.
s app to serve your Unity Web build. For more information about Node.js and how to install and use it, refer to the Node.js documentation . ## Set up your package.json file To create a package.json file that’s ready for use with Unity Web: Create a file in a text editor or IDE. Name the file package.json . Save your ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_9055363c7f75_doc_2
github
scripting
What does `StopStaticCoroutine` do in this Unity script? Explain its purpose and signature.
Stops the specified coroutine on the instance.The coroutine to stop. Signature: ```csharp public static void StopStaticCoroutine(UnityEngine.Coroutine coroutine) ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_24975ccd4e0f
unity_docs
scripting
What is `VerticalWrapMode` in Unity? Explain its purpose and usage.
VerticalWrapMode enumeration Description Wrapping modes for text that reaches the vertical boundary. Properties Property Description Truncate Text will be clipped when reaching the vertical boundary. Overflow Text well continue to generate when reaching vertical boundary.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9057d6be17f
unity_docs
scripting
Show me a Unity C# example demonstrating `Event.shift`.
Event.shift public bool shift ; Description Is Shift held down? (Read Only) Returns true if any Shift key is held down. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Detects if the shift key was pressed void OnGUI() { Event e = Event.current; if (e.shift) { Debug.Log("Shift was p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_660c1c1b12d6
unity_docs
rendering
What is `CameraProjectionCache.GUIToScreenPoint` in Unity? Explain its purpose and usage.
CameraProjectionCache.GUIToScreenPoint Declaration public Vector2 GUIToScreenPoint ( Vector2 guiPoint ); Parameters Parameter Description guiPoint A point in GUI space to convert to screen space. Returns Vector2 guiPoint in screen space relative to the cached camera viewport. Description Converts ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cb9e3b31a432
unity_docs
editor
What is `Device.SystemInfo.usesReversedZBuffer` in Unity? Explain its purpose and usage.
SystemInfo.usesReversedZBuffer public static bool usesReversedZBuffer ; Description This has the same functionality as SystemInfo.usesReversedZBuffer and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ef9947dd8b5
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.B4G4R4A4_UNormPack16` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.B4G4R4A4_UNormPack16 Description A four-component, 16-bit packed unsigned normalized format that has a 4-bit B component in bits 12..15, a 4-bit G component in bits 8..11, a 4-bit R component in bits 4..7, and a 4-...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5245f342c1aa
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUIUtility.SetIconForObject`.
obj The GameObject or MonoScript to associate the icon with. icon The custom icon to associate with the GameObject or MonoScript . When this value is null, the default icon is restored. Description Sets a custom icon to associate with a GameObject or MonoScript . The custom icon is displayed in the Scene...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_317f2258a72d
unity_docs
physics
Show me a Unity C# example demonstrating `EditorApplication.UpdateMainWindowTitle`.
EditorApplication.UpdateMainWindowTitle Declaration public static void UpdateMainWindowTitle (); Description Force Unity Editor to update its window title. This function is automatically called when a new scene is loaded or when the editor starts. A user having register a callback on EditorApplication.updateMai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e743544f7da6
unity_docs
rendering
Explain 'Lightmap UVs Settings in the Model Import Settings Inspector window reference' in Unity.
These are the settings that appear in the Model tab of the Model Import Settings , when you enable Generate Lightmap__ UVs__. Property: Function: Hard Angle The angle between neighboring triangles (in degrees) after which Unity considers it a hard edge and creates a seam. You can set this to a value between 0 and 180. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b319e85e7ea8
unity_docs
rendering
What is `ShaderKeywordFilter.ApplyRulesIfTagsEqualAttribute` in Unity? Explain its purpose and usage.
ApplyRulesIfTagsEqualAttribute class in UnityEditor.ShaderKeywordFilter / Inherits from: ShaderKeywordFilter.TagConstraintAttribute Description Enable or disable shader keyword filter attributes based on shader tags. If you use this attribute, Unity enables filter attributes if the shader compilation context ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1cc0ac58fb22
unity_docs
editor
What is `Build.Content.FileType` in Unity? Explain its purpose and usage.
FileType enumeration Description Enum description of the type of file an object comes from. Note: this enum and its values exist to provide low-level support for the Scriptable Build Pipeline package. This is intended for internal use only; use the Scriptable Build Pipeline package to implement a fully feature...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9a2fc4a4e48
unity_docs
audio
What is `AudioSampleRateSetting` in Unity? Explain its purpose and usage.
AudioSampleRateSetting enumeration Description The sample rate setting used within the AudioImporter. This defines the sample rate conversion of audio on import. Properties Property Description PreserveSampleRate Do not change the sample rate of the imported audio file. The sample rate will be preserved for the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ee70de969745
unity_docs
scripting
Explain 'Inverse Kinematics' in Unity.
Most character animation is created by rotating the angles of joints in a skeleton to predetermined values. The position of a child joint changes according to the rotation of its parent. The end point of a chain of joints is determined by the angles and relative positions of the individual joints along the chain. This ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d11241fd6b30
unity_docs
scripting
What is `JointDrive.maximumForce` in Unity? Explain its purpose and usage.
JointDrive.maximumForce public float maximumForce ; Description Amount of force applied to push the object toward the defined direction. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Create a JointDrive, configure it and assign the JointDrive to // the zDrive element of a configurable ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ed56ed2a9207
unity_docs
math
What is `Mesh.MeshData` in Unity? Explain its purpose and usage.
MeshData struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description A struct containing Mesh data for C# Job System access. Use a MeshData struct to access, process and create Meshes in the C# Job System. There are two types of MeshData struct: read-only MeshData structs that allow read-o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f3d62266c268
unity_docs
editor
Show me a Unity C# example demonstrating `PluginImporter.GetIcon`.
ugin. Returns Texture2D Returns the custom icon that will be associated with the imported MonoScript . If no custom icon will be associated with the imported MonoScript , returns null. Description Gets the custom icon to associate with a MonoScript at import time. Additional resources: MonoScript.GetClass ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_967a6307b5d9_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A list of Sprite Overrides Signature: ```csharp public List<TileSpritePair> m_Sprites = new List<TileSpritePair>(); ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_374b009beae0
unity_docs
ui
What is `GUIStyle.stretchWidth` in Unity? Explain its purpose and usage.
GUIStyle.stretchWidth public bool stretchWidth ; Description Can GUI elements of this style be stretched horizontally for better layouting? ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { GUI.skin.button.stretchWidth = true; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb8a763d8acb
unity_docs
ui
What is `EditorWindow.ShowModalUtility` in Unity? Explain its purpose and usage.
EditorWindow.ShowModalUtility Declaration public void ShowModalUtility (); Description Shows the EditorWindow as a floating modal window. You cannot interact with the utility window while the Editor is runs. The EditorWindow.ShowModalUtility window is never hidden by the Editor. You cannot dock the utility wi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_36e50c700dda
unity_docs
ui
What is `Experimental.GraphView.StackNode.dropPreviewTemplate` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StackNode.dropPreviewTemplate public Func<GraphElement,VisualElement> dropPreviewTemplate ; Description Use this property to customize the preview that appears when GraphElements are dragged over the StackNode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6960ac541e4a
unity_docs
animation
What are the parameters of `Tilemaps.Tilemap.RefreshTile` in Unity?
Description Refreshes a Tile at the given XYZ coordinates of a cell in the Tilemap . The Tilemap will retrieve the rendering data, animation data and other data for the Tile and update all relevant components. ```csharp using UnityEngine; using UnityEngine.Tilemaps;// Tile that displays a Sprite when it is alone and a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_03705228f791
unity_docs
scripting
What is `MPE.ChannelService.GetChannelList` in Unity? Explain its purpose and usage.
ChannelService.GetChannelList Declaration public static ChannelInfo[] GetChannelList (); Returns ChannelInfo[] A list that contains the ChannelInfo for every open channel. Description Gets a list of channels open in the ChannelService. By default the ChannelService always has a "status" channel and an "eve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57055d3e5a23
unity_docs
scripting
What is `Progress.Pause` in Unity? Explain its purpose and usage.
Progress.Pause Declaration public static bool Pause (int id ); Parameters Parameter Description id The progress indicator's unique ID. Returns bool True if the task is paused, false if it cannot be paused. Description Pauses a runnning progress indicator, and invokes the pause callback for its task. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c69825233f6f
unity_docs
physics
What is `ControllerColliderHit.normal` in Unity? Explain its purpose and usage.
ControllerColliderHit.normal public Vector3 normal ; Description The normal of the surface we collided with in world space. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnControllerColliderHit(ControllerColliderHit hit) { // print the impact point's normal Debug.Log("Normal vect...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b5dae6982246
unity_docs
rendering
Explain 'Style UI with UI Builder' in Unity.
In UI Builder, you can style an element with inline styles or USS selectors. Inline styles are typically used for single-use or experimental purposes, whereas managing styles through style sheets tends to be easier and more efficient. You can extract inline styles to a USS class . You can also manage style sheets and U...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb83315de7bd
unity_docs
physics
What is `Physics2D.OverlapBox` in Unity? Explain its purpose and usage.
Physics2D.OverlapBox Declaration public static Collider2D OverlapBox ( Vector2 point , Vector2 size , float angle , int layerMask = DefaultRaycastLayers, float minDepth = -Mathf.Infinity, float maxDepth = Mathf.Infinity); Parameters Parameter Description point The center of the box. size The s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dfd0245f6c80
unity_docs
rendering
In Unity's 'Choose a GPU texture format by platform', what is 'Android' and how does it work?
Texture format support on Android is complicated. You might need to build several application versions with different sub-targets . You can select the default format in Player Settings . Your options are ASTC, ETC2 and ETC (ETC1 for RGB, ETC2 for RGBA). See Texture compression settings for more details on how the diffe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eefb9286e472
unity_docs
scripting
What is `Experimental.GraphView.GraphView.isReframable` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.isReframable public bool isReframable ; Description Whether or not the selection is reframable.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c886b587f046_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
On collision align the object with the normal of the surface that was hit Signature: ```csharp public class StickToObject : MonoBehaviour ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_e06a1a2be3cc
unity_docs
rendering
Explain 'Custom shaders' in Unity.
Resources for using or writing programs that run on the GPU to control the appearance of objects in a scene . Page Description Writing custom shaders Resources for creating your own shaders using Shader Graph, or High-Level Shader Language (HLSL) and ShaderLab . Optimize shaders Optimizing custom shaders for runtime pe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c26235a5234
unity_docs
scripting
What are the parameters of `Rigidbody2D.SetRotation` in Unity?
Description Sets the rotation of the Rigidbody2D to angle (given in degrees). Additional resources: Rigidbody2D.rotation and Rigidbody2D.MoveRotation . ```csharp using UnityEngine;// Rotate rigidBody2D every frame. public class ExampleScript : MonoBehaviour { public Rigidbody2D rigidBody2D; public float rotatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bc1f278149ca
unity_docs
rendering
Explain 'Control material properties in the Inspector window' in Unity.
In the Unity Editor, you can control how material properties appear in the Inspector window. The easiest way to do this is using a MaterialPropertyDrawer . For more complex needs, you can use the MaterialEditor , MaterialProperty , and ShaderGUI classes. ## Use a custom editor Use custom editors to display data types...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c4507babd7b9
unity_docs
rendering
Show me a Unity C# example demonstrating `Mesh.uv3`.
or Vector4 value if you need to. This property returns a copy of the data. This means that it causes a heap memory allocation. It also means that to make changes to the original data, you must update the copy and then reassign the updated copy to the mesh. The following example demonstrates how to create an array to ho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4156c00dc9f2
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.SearchItem`.
arch is performed. The search item holds all the data that is used to sort and present the search results. Some members of a SearchItem can be specified in an asynchronous callback (see SearchItem.fetchThumbnail, SearchItem.fetchDescription, etc). SearchItems are generally created using the SearchProvider.CreateItem ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95e586959d27
unity_docs
rendering
Give me an overview of the `ParticleSystemNoiseQuality` class in Unity.
ParticleSystemNoiseQuality enumeration Description The quality of the generated noise. Properties Property Description Low Low quality 1D noise. Medium Medium quality 2D noise. High High quality 3D noise.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e616836c4569
unity_docs
rendering
What is `Rendering.RenderPipelineAsset.defaultSpeedTree7Shader` in Unity? Explain its purpose and usage.
RenderPipelineAsset.defaultSpeedTree7Shader public Shader defaultSpeedTree7Shader ; Description Return the default SpeedTree v7 Shader for this pipeline. This shader will be used during the import process of SpeedTree v7 assets. If null is returned, the default "Nature/SpeedTree" will be used. Note that t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_407a634424d1
unity_docs
scripting
What are the parameters of `Events.UnityEvent.AddListener` in Unity?
Description Adds a non-persistent listener to the UnityEvent. Adds a runtime callback. You can add many different listeners. If you add identical listeners multiple times, it results in only one call being made to that specific listener. ```csharp //Attach this script to a GameObject //This script creates a UnityEvent ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13222b565902
unity_docs
rendering
In Unity's 'Materials tab', what is 'Remapped Materials' and how does it work?
The Remapped Materials section lists the embedded materials and allows you to remap them to other materials that are already in the project. If you already have a set of materials you want to use for this asset, expand the On Demand Remap group, select Search and Remap , and give the location of the materials. Unity re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_87f8a5edbc77
unity_docs
editor
What is `TooltipAttribute` in Unity? Explain its purpose and usage.
TooltipAttribute class in UnityEngine / Inherits from: PropertyAttribute / Implemented in: UnityEngine.CoreModule Description Specify a tooltip for a field in the Inspector window. Tooltip hovering over the class it was added to. In the following script a Tooltip is added. This provides information to the u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fdf64043afca
unity_docs
scripting
What is `Experimental.GraphView.GraphView.elementResized` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.elementResized public Experimental.GraphView.GraphView.ElementResized elementResized ; Description Element resized callback.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_b616e0338090
github
scripting
Write a Unity C# script called Rook
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; public class Rook : Piece { public override bool[,] PossibleMoves() { bool[,] ret = new bool[8,8]; Piece p; int i; // Right for (i = CurrentX + 1; i < 8; ++i) { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d09e824d8ccc
unity_docs
math
Show me a Unity C# example demonstrating `Mesh.vertices`.
changed by assigning a vertex array with a different number of vertices. If you resize the vertex array then all other vertex attributes (normals, colors, tangents, UVs) are automatically resized too. RecalculateBounds is automatically invoked if no vertices have been assigned to the Mesh when setting the vertices. N...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1df057ef124
unity_docs
editor
What are the parameters of `ShortcutManagement.ShortcutManager.RegisterTag` in Unity?
Description Registers the tag as a custom context used to filter shortcuts after a window context is determined. Use this method to define contexts that span across Editor windows, or encompass certain window states and GUI controls. ```csharp using UnityEditor; using UnityEditor.ShortcutManagement; using UnityEngine;p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_08372ef6edfb
unity_docs
input
Explain 'Device Simulator introduction' in Unity.
The Device Simulator is a Unity Editor feature that simulates how your application appears and behaves on a mobile device. The Device Simulator consists of: The Simulator view: Views your application on a simulated mobile device. Simulated classes: Tests code that responds to device-specific behaviors. Device definitio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30a9702c4412
unity_docs
editor
What is `AssetImporters.AssetImporterEditor.HasModified` in Unity? Explain its purpose and usage.
AssetImporterEditor.HasModified Declaration public bool HasModified (); Description Determine if the import settings have been modified. Returns true if any of the import settings have been edited but not yet applied. Otherwise, returns false.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f2826a401986
unity_docs
scripting
What is `Experimental.GraphView.Placemat.ExpandedPosition` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Placemat.ExpandedPosition public Rect ExpandedPosition ; Description The rect representing the expanded placemat, regardless of the current collapsed state.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_246c58021f85
unity_docs
scripting
What is `UIElements.StyleCursor.ctor` in Unity? Explain its purpose and usage.
StyleCursor Constructor Declaration public StyleCursor ( Cursor v ); Description Creates from either a Cursor or StyleKeyword . Declaration public StyleCursor ( UIElements.StyleKeyword keyword ); Description Creates from either a Cursor or StyleKeyword .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b137a84d99b5
unity_docs
editor
Give me an overview of the `PreferBinarySerialization` class in Unity.
PreferBinarySerialization class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Prefer ScriptableObject derived type to use binary serialization regardless of project's asset serialization mode. This is useful for custom asset types that contain large amounts of data. Always keeping them sto...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cfea8cf2e782
unity_docs
editor
Show me a Unity C# example demonstrating `BuildAssetBundleOptions.DisableLoadAssetByFileName`.
xtension are generated when an Asset Bundle is loaded from file. Example: "Assets/Prefabs/Player.prefab", "Player", and "Player.prefab" This option will set a flag on Asset Bundles to prevent creating the asset file name lookup. This option saves runtime memory and loading performance for asset bundles. Additional reso...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f242dbf625e6
unity_docs
scripting
Give me an overview of the `DetailInstanceTransform` class in Unity.
DetailInstanceTransform struct in UnityEngine / Implemented in: UnityEngine.TerrainModule Description Describes the transform of a Terrain detail object. Additional resources: TerrainData.ComputeDetailInstanceTransforms . Properties Property Description posX The X coordinate of the detail object in the Ter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.