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_4dc069bf8451
unity_docs
ui
What is `UIElements.VisualElement.BringToFront` in Unity? Explain its purpose and usage.
VisualElement.BringToFront Declaration public void BringToFront (); Description Brings this element to the end of its parent children list. The element will be visually in front of any overlapping sibling elements.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e8b866d42ae
unity_docs
scripting
What is `Events.UnityEventBase.RemoveAllListeners` in Unity? Explain its purpose and usage.
UnityEventBase.RemoveAllListeners Declaration public void RemoveAllListeners (); Description Remove all non-persistent (ie created from script) listeners from the event. All persistent (ie created via inspector) listeners are not affected.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_217f093f6b1f
unity_docs
scripting
What is `UIElements.PanelSettings.screenMatchMode` in Unity? Explain its purpose and usage.
PanelSettings.screenMatchMode public UIElements.PanelScreenMatchMode screenMatchMode ; Description Specifies how to scale the panel area when the aspect ratio of the current resolution does not match the reference resolution.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26e47ba93723
unity_docs
scripting
What are the parameters of `GameObject.InstantiateGameObjects` in Unity?
Description Creates a specified number of instances of a GameObject identified by its instance ID and populates NativeArrays with the instance IDs of the new GameObjects and their Transform components. Use InstantiateGameObjects to instantiate multiple GameObjects as a batch. An instance ID can be resolved to an object...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de3c36739b73
unity_docs
math
What is `Matrix4x4.Index_operator` in Unity? Explain its purpose and usage.
Matrix4x4.this[int,int] public float this[int,int] ; Description Access element at [row, column]. Both row and column must be from 0 to 3 inclusive. A matrix is 4x4 array of numbers, and you can access the individual elements using this function. Note the standard math notation - row is the first index. pu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8248a46a74b0
unity_docs
editor
Show me a Unity C# example demonstrating `Event.Use`.
s type will be set to EventType.Used , causing other GUI elements to ignore it. Events of type EventType.Repaint and EventType.Layout should not be used. Attempting to call this method on such events will issue a warning. The following example demonstrates how events are consumed and used up. Copy this code into a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69dbbed35e39
unity_docs
scripting
What is `Unity.Content.ContentNamespace.GetOrCreateNamespace` in Unity? Explain its purpose and usage.
ContentNamespace.GetOrCreateNamespace Declaration public static Unity.Content.ContentNamespace GetOrCreateNamespace (string name ); Parameters Parameter Description name Name of the ContentNamespace. It must contain only alphanumeric characters and have a maximum length of 16 characters. Returns ContentN...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b89f81a094e9
unity_docs
scripting
What is `GameObject.SetActive` in Unity? Explain its purpose and usage.
GameObject.SetActive Declaration public void SetActive (bool value ); Parameters Parameter Description value The active state to set, where true sets the GameObject to active and false sets it to inactive. Description Activates or deactivates the GameObject locally, according to the value of the suppl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b371ab648e46
unity_docs
rendering
What is `AI.NavMeshAgent.path` in Unity? Explain its purpose and usage.
NavMeshAgent.path public AI.NavMeshPath path ; Description Property to get and set the current path. This property can be useful for GUI, debugging and other purposes to get the points of the path calculated by the navigation system. Additionally, a path created from user code can be set for the agent to foll...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ee1f3a31cd1
unity_docs
scripting
What are the parameters of `EditorGUI.Vector2Field` in Unity?
Returns Vector2 The value entered by the user. Description Makes an X and Y field for entering a Vector2 . Vector2 field in an Editor Window. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEditor;// Editor window that shows the detailed rotation (X,Y,Z and W componen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_abec6b51d287
unity_docs
scripting
What is `SceneTemplate.SceneTemplateService.CreateTemplateFromScene` in Unity? Explain its purpose and usage.
SceneTemplateService.CreateTemplateFromScene Declaration public static SceneTemplate.SceneTemplateAsset CreateTemplateFromScene ( SceneAsset sourceSceneAsset , string sceneTemplatePath ); Parameters Parameter Description sourceSceneAsset The Scene Asset that serves as the template. sceneTemplatePath Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3daf31a696b3
unity_docs
physics
Show me a Unity C# example demonstrating `Physics.Simulate`.
ysics.Simulate every time you call it. Usually, step should be a small positive number. Using step values greater than 0.03 is likely to produce inaccurate results. Additional resources: Physics.simulationMode , SimulationMode . Here is an example of a basic simulation that implements what's being done in the Si...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ae0b349c7ba
unity_docs
scripting
What is `Application.isMobilePlatform` in Unity? Explain its purpose and usage.
Application.isMobilePlatform public static bool isMobilePlatform ; Description Identifies whether the current Runtime platform is a known mobile platform. Currently this returns true if the application is running on Android, iOS, or WSA. When targeting WebAssembly and running in a web browser, this property mig...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7bce49228a3b
unity_docs
editor
What is `Experimental.GraphView.ISelectable` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ISelectable interface in UnityEditor.Experimental.GraphView Description Selectable interface. Public Methods Method Description HitTest See if point is on target. IsSelectable Check if element is selectable. IsSelected Ch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0d32715493f
unity_docs
xr
What is `SceneManagement.EditorSceneManager.SaveScenes` in Unity? Explain its purpose and usage.
EditorSceneManager.SaveScenes Declaration public static bool SaveScenes (Scene[] scenes ); Parameters Parameter Description scenes List of Scenes that should be saved. Returns bool True if the save succeeded. Otherwise false. Description Save a list of Scenes. If an unsaved Scene is part of the list...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a77bde871e5
unity_docs
scripting
Show me a Unity C# example demonstrating `Tilemaps.Tilemap.GetCellCenterWorld`.
for a cell of the Tilemap is defined by the Tile Anchor of the Tilemap. In a rectangular grid layout, a call to GridLayout.CellToWorld with Vector3Int parameter returns a Vector3 coordinate that represents the lower left of the cell. This is mathematically correct, but in certain cases such as when instantiati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9a57fcd5c2a
unity_docs
rendering
What is `GUIStyle.Draw` in Unity? Explain its purpose and usage.
GUIStyle.Draw Declaration public void Draw ( Rect position , bool isHover , bool isActive , bool on , bool hasKeyboardFocus ); Description Draw this GUIStyle on to the screen, internal version. Draw plain GUIStyle without text nor image. Declaration public void Draw ( Rect position , string text , b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e22bc0e3a450
unity_docs
performance
What is `Unity.Collections.LowLevel.Unsafe.NativeArrayUnsafeUtility.GetAtomicSafetyHandle` in Unity? Explain its purpose and usage.
NativeArrayUnsafeUtility.GetAtomicSafetyHandle Declaration public static Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle GetAtomicSafetyHandle (NativeArray<T> array ); Parameters Parameter Description array The NativeArray to check. Returns AtomicSafetyHandle The AtomicSafetyHandle of the given ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_938b3b03e198_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A singleton inheriting from MonoBehaviour.Class type. Signature: ```csharp public abstract class SingletonMonoBehaviour<T> : MonoBehaviour where T : SingletonMonoBehaviour<T> ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_20a03f788145
unity_docs
rendering
What are the parameters of `Mesh.GetUVDistributionMetric` in Unity?
Returns float Average of triangle area / uv area. Description The UV distribution metric can be used to calculate the desired mipmap level based on the position of the camera. The example code shows how this value can be used with some camera properties to calculate a required mipmap level. ```csharp using UnityEngine;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04370d5895a0
unity_docs
scripting
What is `Vector3.zero` in Unity? Explain its purpose and usage.
Vector3.zero public static Vector3 zero ; Description Shorthand for writing Vector3(0, 0, 0) . ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Example() { transform.position = Vector3.zero; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8ebb2c2ecadf
unity_docs
scripting
What is `ComputeBufferMode.SubUpdates` in Unity? Explain its purpose and usage.
ComputeBufferMode.SubUpdates Description Dynamic, unsynchronized access to the buffer. Same as ComputeBufferMode.Dynamic except Unity does not perform any CPU-GPU synchronization; if the user modifies an area of the buffer where the GPU is currently reading from, the results are undefined. For example, this mode ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_74d90e4afb6a
unity_docs
math
What are the parameters of `Mathf.Lerp` in Unity?
Returns float The interpolated float result between the two float values. Description Linearly interpolates between a and b by t . The parameter t is clamped to the range [0, 1]. When t = 0 returns a . When t = 1 return b . When t = 0.5 returns the midpoint of a and b . ```csharp using UnityEngine;public class Example ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a784737f61e3
unity_docs
editor
In Unity's 'Set up multiple scenes for occlusion culling', what is 'Loading more than one Scene at a time' and how does it work?
If you load multiple Scenes at a time with LoadSceneMode.Additive , you must bake the data for those Scenes together, like this: In the Unity Editor, open the first Scene of the group that Unity will load at runtime. This becomes the active Scene. Additively open the other Scenes in the group, so that all of them are o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9ba3f1a037d
unity_docs
input
What is `Input.location` in Unity? Explain its purpose and usage.
Input.location public static LocationService location ; Description Property for accessing device location (handheld devices only). (Read Only) Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new projects. For new projects, use the Input Sys...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6d47c61b4bcf
unity_docs
rendering
What is `TextureMipmapLimitGroups.CreateGroup` in Unity? Explain its purpose and usage.
TextureMipmapLimitGroups.CreateGroup Declaration public static void CreateGroup (string groupName ); Parameters Parameter Description groupName Name of the new texture mipmap limit group. Description (Editor Only) Attempts to create a texture mipmap limit group with the indicated groupName . This operati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_33a09b57c7c7
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.CommandBuffer.SetShadowSamplingMode`.
shadows. If you'd like to access the shadowmap values as in a regular texture, set the sampling mode to ShadowSamplingMode.RawDepth . Shadowmap's sampling mode will be reverted to default after the the last command in the current CommandBuffer. Check SystemInfo.supportsRawShadowDepthSampling to verify if current run...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00c7db6dd9c9
unity_docs
audio
What is `AudioSource.SetCustomCurve` in Unity? Explain its purpose and usage.
AudioSource.SetCustomCurve Declaration public void SetCustomCurve ( AudioSourceCurveType type , AnimationCurve curve ); Parameters Parameter Description type The curve type that should be set. curve The curve that should be applied to the given curve type. Description Set the custom curve for the gi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_08c5df748bc4
unity_docs
ui
What is `PenData.penStatus` in Unity? Explain its purpose and usage.
PenData.penStatus public PenStatus penStatus ; Description Specifies the state of the pen. For example, whether the pen is in contact with the screen or tablet, whether the pen is inverted, and whether buttons are pressed. On macOS, penStatus will not reflect changes to button mappings.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac74aca36e10
unity_docs
scripting
Show me a Unity C# example demonstrating `CharacterController.SimpleMove`.
CharacterController.SimpleMove Declaration public bool SimpleMove ( Vector3 speed ); Description Moves the character with speed . Velocity along the y-axis is ignored. Speed is in units/s. Gravity is automatically applied. Returns true if the character is grounded. It is recommended that you make only one c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59d0b5c8775c
unity_docs
scripting
What is `Rendering.RenderPipelineManager` in Unity? Explain its purpose and usage.
RenderPipelineManager class in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Render Pipeline manager. Static Properties Property Description currentPipeline Returns the active RenderPipeline. pipelineSwitchCompleted Indicate when Render Pipeline switch is in progress. Events E...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c04b3b933d09
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.AttributeUnit` in Unity? Explain its purpose and usage.
AttributeUnit class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseAttribute Description An attribute that represents an integer value with Unit type. Public Methods Method Description Get Gets the value of the ValueType? attribute. Set Sets a new ValueType? value fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6ce0ade9d1b7
unity_docs
physics
What is `Physics2D.MaxPolygonShapeVertices` in Unity? Explain its purpose and usage.
Physics2D.MaxPolygonShapeVertices public static int MaxPolygonShapeVertices ; Description The maximum number of vertices allowed per primitive polygon shape type ( PhysicsShapeType2D.Polygon ). (Read Only) The low-level physics engine sets a maximum number of vertices allowed per convex polygon shape. This coun...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6111aa942077
unity_docs
editor
What is `SettingsProvider.label` in Unity? Explain its purpose and usage.
SettingsProvider.label public string label ; Description Gets or sets the display name of the SettingsProvider as it appears in the Settings window. If not set, the Settings window uses last token of SettingsProvider.settingsPath instead. ```csharp using UnityEditor; using UnityEngine; using UnityEngine.UIEle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a2a87796996
unity_docs
physics
What is `PhysicsScene.ResetInterpolationPoses` in Unity? Explain its purpose and usage.
PhysicsScene.ResetInterpolationPoses Declaration public void ResetInterpolationPoses (); Description Resets the Transform positions of interpolated and extrapolated Rigidbodies in this PhysicsScene to Rigidbody.position and Transform rotations to Rigidbody.rotation . Call this method before simulating ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6288839aa4d5
unity_docs
rendering
What are the parameters of `Graphics.DrawMeshNow` in Unity?
Description Draw a mesh immediately. This function will draw a given mesh immediately. Currently set shader and material (see Material.SetPass ) will be used. The mesh will be just drawn once, it won't be per-pixel lit and will not cast or receive real-time shadows. If you want full integration with lighting and shadow...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4210391df061
unity_docs
scripting
What is `Unity.Properties.PropertyContainer.TryGetValue` in Unity? Explain its purpose and usage.
PropertyContainer.TryGetValue Declaration public static bool TryGetValue (TContainer container , string name , out TValue value ); Parameters Parameter Description container The container whose property value will be returned. name The name of the property to get. value When this method returns, contai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8c092ca0398
unity_docs
physics
What is `PhysicsScene2D.GetRayIntersection` in Unity? Explain its purpose and usage.
PhysicsScene2D.GetRayIntersection Declaration public RaycastHit2D GetRayIntersection ( Ray ray , float distance , int layerMask = Physics2D.DefaultRaycastLayers); Parameters Parameter Description ray The 3D ray defining origin and direction to test. distance The maximum distance over which to cast th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d372d5741c35
unity_docs
scripting
What is `GlobalObjectId.GlobalObjectIdentifierToObjectSlow` in Unity? Explain its purpose and usage.
GlobalObjectId.GlobalObjectIdentifierToObjectSlow Declaration public static Object GlobalObjectIdentifierToObjectSlow ( GlobalObjectId id ); Parameters Parameter Description id The GlobalObjectId to lookup. Returns Object Returns a reference to the object. Returns null if the GlobalObjectId ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6eaad215a931
unity_docs
ui
What is `UIElements.IMouseEvent` in Unity? Explain its purpose and usage.
IMouseEvent interface in UnityEngine.UIElements Description Interface for mouse events. Properties Property Description actionKey Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. altKey Return true if the Alt key is pressed. bu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5214abdc1c7
unity_docs
scripting
What is `UIElements.MouseEnterWindowEvent` in Unity? Explain its purpose and usage.
MouseEnterWindowEvent class in UnityEngine.UIElements / Inherits from: UIElements.MouseEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description Event sent when the mouse pointer enters a window. The event bubbles up but does not trickle down. Constructors Constructor Description MouseEnte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_52ee2bdb38d4
unity_docs
editor
In Unity's 'File Access Profiler module reference', what is 'File Summary view' and how does it work?
The File Summary view displays a summary of all file access operations that happened to each file during the capture. One entry in the table represents the full summary for a single file. The following table describes all possible statistics that the File Summary view table can display. Not all statistic columns are en...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1033d61a4618
unity_docs
editor
What is `EditorBuildSettings.RemoveConfigObject` in Unity? Explain its purpose and usage.
EditorBuildSettings.RemoveConfigObject Declaration public static bool RemoveConfigObject (string name ); Parameters Parameter Description name The name in string format of the config object reference to be removed. This is the name given to the object when the reference is first created. Note: This may be di...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acc953344e29
unity_docs
scripting
What is `UnityEngine.XRModule` in Unity? Explain its purpose and usage.
UnityEngine.XRModule Description The XR module contains the VR and AR related platform support functionality. Classes Class Description CommonUsages Defines static variables that are used to retrieve input features from XR.InputDevice.TryGetFeatureValue. InputDevices An interface for accessing devices in the XR...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e2ef076a59aa
unity_docs
scripting
What is `AndroidJNI.IsInstanceOf` in Unity? Explain its purpose and usage.
AndroidJNI.IsInstanceOf Declaration public static bool IsInstanceOf (IntPtr obj , IntPtr clazz ); Description Tests whether an object is an instance of a class. Additional resources: Java Native Interface Specification (Oracle)
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f6bd89d85fbd
unity_docs
rendering
What is `ParticleSystem.NoiseModule.rotationAmount` in Unity? Explain its purpose and usage.
ParticleSystem.NoiseModule.rotationAmount public ParticleSystem.MinMaxCurve rotationAmount ; Description How much the noise affects the particle rotation, in degrees per second. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class ExampleClass : MonoBe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_78fb02deb875
github
scripting
Write a Unity C# script called Anihilation PIP
```csharp using System.Collections; using UnityEngine; public class AnihilationPIP : PipState { public GameObject Flash; public float duration; private bool triggered = false; public override PipState RunState() { if (!triggered) { triggered = true; Start...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_0ea6042d8b90
unity_docs
physics
What is `CollisionDetectionMode2D` in Unity? Explain its purpose and usage.
CollisionDetectionMode2D enumeration Description Controls how collisions are detected when a Rigidbody2D moves. Additional resources: Rigidbody2D.collisionDetectionMode . Properties Property Description Discrete When a Rigidbody2D moves, only collisions at the new position are detected. Continuous Ensures ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_097feec2920a
unity_docs
input
Show me a Unity C# example demonstrating `Input.anyKeyDown`.
e this API in new projects. For new projects, use the Input System package. To learn more about input, refer to Input . You should be polling this variable from the Update function, since the state gets reset each frame. It will not return true until the user has released all keys / buttons and pressed any key / but...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f23a177abe4e
unity_docs
rendering
Explain '2D game development' in Unity.
While Unity is famous for its 3D capabilities, you can also use Unity to create 2D projects. Use this section to learn how to develop 2D projects in Unity, including how to use sprites, create Tilemaps, and use the 2D physics system in your projects. Many areas of Unity’s documentation apply to both 2D and 3D developme...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4fadb8fce520
unity_docs
scripting
What is `TerrainTools.PaintDetailsToolUtility.ResetDetailsUtilityData` in Unity? Explain its purpose and usage.
PaintDetailsToolUtility.ResetDetailsUtilityData Declaration public static void ResetDetailsUtilityData (); Description Resets the paint detail tools utility parameters. Use this method to clear data associated with the paint details tool before changing to a different tool. This method is commonly used when e...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_872388702bdf
unity_docs
editor
Show me a Unity C# example demonstrating `Android.AndroidProjectFiles.SetFileContents`.
eters Parameter Description path The file to write to. This path is relative to the Gradle project path. contents Byte array contents. Description Sets the content of a new file to the specified bytes. To use this method, you must first declare the new file in AndroidProjectFilesModifier.Setup using the And...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_499d4013e775
unity_docs
rendering
Explain 'Streaming Virtual Texturing requirements and compatibility' in Unity.
## Render pipeline support In the High Definition Render Pipeline (HDRP) you can use Streaming Virtual Texturing (SVT) in Shaders you create with Shader Graph . ## GPU requirements GPU compute Texture2DArrays AsyncReadBack ## Supported platforms Windows Mac Linux Note: Streaming Virtual Texturing is not supported ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57f1e5c462b2
unity_docs
performance
What is `Unity.Profiling.LowLevel.ProfilerMarkerDataType.String16` in Unity? Explain its purpose and usage.
ProfilerMarkerDataType.String16 Description Indicates that ProfilerMarkerData.Ptr points to a char* . Use String16 to pass string data to the ProfilerUnsafeUtility.BeginSampleWithMetadata . Note: The size of the string must be set in bytes including the null terminator. ```csharp using System.Diagnostics; u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e67868fa5af4
unity_docs
rendering
What is `XR.XRDisplaySubsystem.XRRenderPass.cullingPassIndex` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.XRRenderPass.cullingPassIndex public int cullingPassIndex ; Description An index that a render pipeline can pass to XRDisplaySubsystem.GetCullingParameters to obtain culling information. Multiple render passes can share the same index. This means that the renderer only needs to cull once,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3bfe7cf8af8
unity_docs
animation
What is `ModelImporterClipAnimation.maskSource` in Unity? Explain its purpose and usage.
ModelImporterClipAnimation.maskSource public AvatarMask maskSource ; Description The AvatarMask used to mask transforms during the import process. A mask can be used to discard transform when importing a clip to reduce memory footprint for this clip. A source mask is only needed if ModelImporterClipAnimation...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_19
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive eight arguments as part of its initialization process.Base interface of . Signature: ```csharp public interface IEightArguments ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_e85cea3a1a3f
unity_docs
scripting
What is `Unity.Properties.Property_2.GetAttribute` in Unity? Explain its purpose and usage.
Property<T0,T1>.GetAttribute Declaration public TAttribute GetAttribute (); Returns TAttribute The attribute of the given type for this property. Description Returns the first attribute of the given type.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98ca7c492279
unity_docs
editor
Give me an overview of the `TransformUtils` class in Unity.
TransformUtils class in UnityEditor Description Editor Transform Utility Class. Static Methods Method Description GetConstrainProportions Returns Constrain Proportions toggle value as it is shown in the Transform Inspector window. GetInspectorRotation Returns the rotation of a transform as it is shown in the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab89119b54e6
unity_docs
rendering
What is `LightingSettings.indirectResolution` in Unity? Explain its purpose and usage.
LightingSettings.indirectResolution public float indirectResolution ; Description Defines the number of texels that Enlighten Realtime Global Illumination uses per world unit when calculating indirect lighting. (Editor only). The default value is 2. Increasing this value can improve lightmap quality, but also ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b35c3eef0102
unity_docs
rendering
What is `Texture3D.GetPixels32` in Unity? Explain its purpose and usage.
Texture3D.GetPixels32 Declaration public Color32[] GetPixels32 (int miplevel ); Declaration public Color32[] GetPixels32 (); Parameters Parameter Description miplevel The mipmap level to get. The range is 0 through the texture's Texture.mipmapCount . The default value is 0 . Returns Color32[] An...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9a4831c0eb3
unity_docs
editor
What is `EditorTools.ToolManager.IsActiveContext` in Unity? Explain its purpose and usage.
ToolManager.IsActiveContext Declaration public static bool IsActiveContext ( EditorTools.EditorToolContext context ); Parameters Parameter Description context The EditorToolContext to compare with the active tool context. Returns bool Returns true if the context is active, false if it is not the activ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe8b86313384
unity_docs
math
What is `HashUtilities` in Unity? Explain its purpose and usage.
HashUtilities class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Utilities to compute hashes. Static Methods Method Description AppendHash Append inHash in outHash. ComputeHash128 Compute a 128 bit hash based on a value. the type of the value must be a value type. QuantisedMatrixHash...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_315f04f396f4
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.CollisionModule.dampenMultiplier`.
ParticleSystem.CollisionModule.dampenMultiplier public float dampenMultiplier ; Description Change the dampen multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall dampen multiplier. ```csharp using UnityEngine; using System.Collections;[R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_410b74c7faaf
unity_docs
performance
What is `Unity.Collections.Allocator.TempJob` in Unity? Explain its purpose and usage.
Allocator.TempJob Description Use a temporary job allocation. A slower allocation than Temp but faster than Persistent. Use it for thread-safe allocations within a lifespan of four frames. Important : You must Dispose of this allocation type within four frames, or the console prints a warning, generated from the n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75cc7f4d1702
unity_docs
scripting
What is `ControllerColliderHit.gameObject` in Unity? Explain its purpose and usage.
ControllerColliderHit.gameObject public GameObject gameObject ; Description The game object that was hit by the controller. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnControllerColliderHit(ControllerColliderHit hit) { // Objects we touch, move them to position (0, 0, 0) hit....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf07078ae20c
unity_docs
xr
What is `Networking.UnityWebRequest.Delete` in Unity? Explain its purpose and usage.
UnityWebRequest.Delete Declaration public static Networking.UnityWebRequest Delete (string uri ); Parameters Parameter Description uri The URI to which a DELETE request should be sent. Returns UnityWebRequest A UnityWebRequest configured to send an HTTP DELETE request. Description Creates a Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_028b6015066e
unity_docs
physics
What is `CharacterJoint.swing1Limit` in Unity? Explain its purpose and usage.
CharacterJoint.swing1Limit public SoftJointLimit swing1Limit ; Description The angular limit of rotation (in degrees) around the primary axis of the character joint. The limit is symmetric. For example, a value of 30 will limit the rotation between -30 and +30 degrees. The limit is relative to the angle the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6f892e8fe0c6
unity_docs
scripting
In Unity's 'Property visitors', what is 'Create a property visitor to get properties' and how does it work?
You can use the following approaches to create your visitors to get properties: Derive from the Unity.Properties.PropertyVisitor base class. For an example, refer to Use PropertyVisitor to create a property visitor . Implement the IPropertyBagVisitor and IPropertyVisitor interfaces. For an example, refer to Use low-lev...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_29d7d02d369a
unity_docs
rendering
In Unity's 'Video Player component targets', what is 'Display your video content on a GameObject’s Material and Texture' and how does it work?
You can use the Video Player component to attach video files to GameObjects , and play the video’s content on the GameObject’s Texture at runtime. When you attach a Video Player component to a GameObject that contains a Renderer component, Unity automatically sets the Material Property of the component to the GameObjec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2c99b972d2cc_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Script responsible for giving access to the sdk calls using reflections. Signature: ```csharp public static class MagicLeapPackageUtility ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_419126019b0c
unity_docs
scripting
What is `PlayerSettings.WSA.transparentSwapchain` in Unity? Explain its purpose and usage.
PlayerSettings.WSA.transparentSwapchain public static bool transparentSwapchain ; Description Sets AlphaMode on the swap chain to DXGI_ALPHA_MODE_PREMULTIPLIED. This setting is only used for UWP projects that use the XAML build type. By enabling this setting, you will be able to compose Unity content with othe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db96bc1454fa
unity_docs
scripting
What is `Accessibility.IAccessibilityNotificationDispatcher.SendAnnouncement` in Unity? Explain its purpose and usage.
IAccessibilityNotificationDispatcher.SendAnnouncement Declaration public void SendAnnouncement (string announcement ); Parameters Parameter Description announcement The string representing the announcement. Description Sends a notification to the screen reader conveying an announcement. Use this notificat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd2de22f968b
unity_docs
math
What are the parameters of `Hash128.Compute` in Unity?
Returns Hash128 The 128-bit hash. Description Compute a hash of input data. The value must be an "unmanaged" C# type. Primitive types like int , float , bool , enums, pointers, or structs containing primitive types are all unmanaged types. See Unmanaged types in C# language reference. The int and float overloads use a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_780746146502
unity_docs
editor
What is `EditorTools.ToolManager.IsActiveTool` in Unity? Explain its purpose and usage.
ToolManager.IsActiveTool Declaration public static bool IsActiveTool ( EditorTools.EditorTool tool ); Parameters Parameter Description tool The EditorTool to compare with the active tool. Returns bool Returns true if the tool is active, false if it is not the active tool. Description Test if an E...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4966c5e37811
unity_docs
rendering
Explain 'Visual effects' in Unity.
This section provides information on the visual effects available in Unity. Topic Description Particle systems How to choose between Unity’s different particle systems, and use them in your project. Decals and projection How to create decal and projector effects. Lens flares How to create lens flare. Light halos How to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4200681f56dc
unity_docs
physics
What is `JointLimitState2D` in Unity? Explain its purpose and usage.
JointLimitState2D enumeration Description Represents the state of a joint limit. Additional resources: DistanceJoint2D , HingeJoint2D , SliderJoint2D . Properties Property Description Inactive Represents a state where the joint limit is inactive. LowerLimit Represents a state where the joint limit is at th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_61bac8e2c9aa
unity_docs
rendering
Show me a Unity C# example demonstrating `GUI.DrawTextureWithTexCoords`.
xture within a rectangle with the given texture coordinates. Use this function for clipping or tiling the image within the given rectangle. The second Rect texCoords describes how the texture is adjusted to fit the position Rect . The first rectangle has its size in pixels provided; the second rectangle is given ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_073b1d9986ad
unity_docs
xr
What is `VersionControl.AssetList.Filter` in Unity? Explain its purpose and usage.
AssetList.Filter Declaration public VersionControl.AssetList Filter (bool includeFolder , params States[] states ); Parameters Parameter Description includeFolder Whether or not folders should be included. states Which states to filter by. Description Based on the current list and the states a new lis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c54fcff64e2e
github
scripting
Write a Unity Editor script for Starter Assets Sample Project Validation
```csharp using System; using System.Collections.Generic; using System.Linq; using Unity.XR.CoreUtils.Editor; using UnityEngine.XR.Interaction.Toolkit; namespace UnityEditor.XR.Interaction.Toolkit.Samples { /// <summary> /// Unity Editor class which registers Project Validation rules for the Starter Assets sam...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_bc0b11048244
unity_docs
editor
What is `Event.Use` in Unity? Explain its purpose and usage.
Event.Use Declaration public void Use (); Description Use this event. Call this method when you've used an event. The event's type will be set to EventType.Used , causing other GUI elements to ignore it. Events of type EventType.Repaint and EventType.Layout should not be used. Attempting to call this metho...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_323fa9cb3ef4
unity_docs
scripting
Show me a Unity C# example demonstrating `UIElements.PanelSettings.SetPanelChangeReceiver`.
e underlying architecture is modified. As this is called at every change marked on any visual element of the panel, the overhead is not negligible. The callback will not be called in release builds as the method is stripped. The following example uses the panelChangeReceiver in a game. To test it, add the component...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_63d1a9201529
unity_docs
rendering
In Unity's 'Low-level native plug-in interface', what is 'Plug-in callbacks on the rendering thread' and how does it work?
You can use multithreading to render in Unity, if the platform and number of available CPUs allows for it. Note : When you use multithreaded rendering, the rendering API commands happen on a thread that’s completely separate from the thread that runs MonoBehaviour scripts . The communication between the main thread and...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd7bd2598e15
unity_docs
scripting
What is `Device.Application.HasUserAuthorization` in Unity? Explain its purpose and usage.
Application.HasUserAuthorization Declaration public static bool HasUserAuthorization ( UserAuthorization mode ); Description This has the same functionality as Application.HasUserAuthorization . At the moment, the Device Simulator doesn't support simulation of this method.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b1a802e3d65b
unity_docs
scripting
Explain 'Make the camera perspective oblique' in Unity.
By default, the view frustum is arranged symmetrically around the camera ’s center line, but it doesn’t necessarily need to be. You can make the frustum oblique, which means that one side is at a smaller angle to the centre line than the opposite side. This makes the perspective on one side of the image seem more conde...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_952a9cd99fd2
unity_docs
math
What is `Rendering.MeshUpdateFlags.DontRecalculateBounds` in Unity? Explain its purpose and usage.
MeshUpdateFlags.DontRecalculateBounds Description Indicates that Unity should not recalculate the bounds when you set Mesh data using Mesh.SetSubMesh . When you use Mesh.SetSubMesh to modify a Mesh's data, Unity's default behaviour is to re-calculate the values of the SubMeshDescriptor.bounds , SubMeshDescripto...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7268d39c852d
unity_docs
scripting
Show me a Unity C# example demonstrating `MeshCollider.sharedMesh`.
MeshCollider.sharedMesh public Mesh sharedMesh ; Description The mesh object used for collision detection. If prior to setting sharedMesh any of the vertices, indices or triangles of the mesh have been changed then the shapes of the MeshCollider will be rebuilt. ```csharp using UnityEngine;public class Ex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b26f9ba83f12
unity_docs
editor
What is `MouseCursor.ArrowMinus` in Unity? Explain its purpose and usage.
MouseCursor.ArrowMinus Description Arrow with the minus symbol next to it. ```csharp //Create a folder and name it “Editor” if this doesn’t already exist //Put this script in the folder//This script creates a new menu (“Examples”) and a menu item (“Mouse Cursor”). Click on this option. This displays a small window ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a26af09d5e3b
unity_docs
rendering
What is `ParticleSystem.CustomDataModule.GetColor` in Unity? Explain its purpose and usage.
ParticleSystem.CustomDataModule.GetColor Declaration public ParticleSystem.MinMaxGradient GetColor ( ParticleSystemCustomData stream ); Parameters Parameter Description stream The name of the custom data stream to retrieve the gradient from. Returns MinMaxGradient The color gradient being used to gen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c017deb109b8
github
scripting
Write a Unity C# XR/VR script for Controller Tutorial Script
```csharp // Copyright 2020 The Tilt Brush Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicab...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_9eed8bcafd29
unity_docs
rendering
Show me a Unity C# example demonstrating `Rendering.RayTracingAccelerationStructure.AddInstances`.
ulation) These members can appear in any order in the structure, but they must have the above name and type. AddInstances ignores any other members you include in the structure for your own use. The following example of a custom structure defines the mandatory objectToWorld member, an optional renderingLayerMask membe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0d351936d75b_doc_1
github
scripting
What does `StopRecording` do in this Unity script? Explain its purpose and signature.
Updates the control UI when the user finishes recording a new eye gaze log file. Signature: ```csharp public void StopRecording() ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_6eb01cd2a7c3
unity_docs
math
What is `Rendering.CommandBuffer.SetComputeBufferParam` in Unity? Explain its purpose and usage.
CommandBuffer.SetComputeBufferParam Declaration public void SetComputeBufferParam ( ComputeShader computeShader , int kernelIndex , string name , ComputeBuffer buffer ); Declaration public void SetComputeBufferParam ( ComputeShader computeShader , int kernelIndex , int nameID , ComputeBuffer buffer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d9755b51128e
unity_docs
scripting
What is `UIElements.TreeViewItemData_1` in Unity? Explain its purpose and usage.
TreeViewItemData<T0> struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Item structure provided to a TreeView using the default implementation. For more information on usage, refer to TreeView and Create list and tree views . Properties Property Description chi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c057c86043b7
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.cameraVelocityScale`.
ParticleSystemRenderer.cameraVelocityScale public float cameraVelocityScale ; Description How much do the particles stretch depending on the Camera 's speed. Use this to make particles become larger if the viewing Camera has a large speed. ```csharp using UnityEngine; using System.Collections;[RequireComponen...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_894e24fe6625
unity_docs
performance
What is `PickingIncludeExcludeList.ctor` in Unity? Explain its purpose and usage.
PickingIncludeExcludeList Constructor Declaration public PickingIncludeExcludeList (List<int> includeRendererInstanceIDs , List<int> excludeRendererInstanceIDs , List<int> includeEntityIndices , List<int> excludeEntityIndices , Unity.Collections.Allocator allocator ); Parameters Parameter Description in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f625afe6f0f0
unity_docs
rendering
What is `UIElements.UxmlObjectAttribute` in Unity? Explain its purpose and usage.
UxmlObjectAttribute class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Declares that a class can be instantiated from UXML and contain UXML attributes. A UXML object is a class that can be instantiated from UXML and contain UXML attributes. By utilizing the UxmlObje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c381cf53ac0a
unity_docs
ui
What is `PenData` in Unity? Explain its purpose and usage.
PenData struct in UnityEngine / Implemented in: UnityEngine.InputLegacyModule Description Structure describing the status of a pen event. The PenData struct is used by Unity to store data relating to a pen event. PenData contains information such as the position, pressure, and tilt of the pen for a given pen in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c31a4005fabb
unity_docs
rendering
In Unity's 'Light component Inspector window reference for the Built-In-Render-Pipeline', what is 'Shadows' and how does it work?
Property: Function: Shadow Type Determine whether this Light casts Hard Shadows, Soft Shadows, or no shadows at all. Hard Shadows produces shadows with a sharp edge. Hard shadows aren’t realistic compared to Soft Shadows but they involve less processing, and are acceptable for many purposes. Soft shadows also tend to r...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_02fbfa991803
unity_docs
editor
What is `Device.SystemInfo.deviceUniqueIdentifier` in Unity? Explain its purpose and usage.
SystemInfo.deviceUniqueIdentifier public static string deviceUniqueIdentifier ; Description This has the same functionality as SystemInfo.deviceUniqueIdentifier 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.