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_b3c185a47247
unity_docs
input
What is `Experimental.GraphView.TokenNode.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. TokenNode Constructor Declaration public TokenNode ( Experimental.GraphView.Port input , Experimental.GraphView.Port output ); Description Constructs a TokenNode with both input and output Ports.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c13463c0845a_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
GOALS: Easily allow a Singleton to be added to hierarchy at runtime with full MonoBehavior access and predictable lifecycle.Usage: Signature: ```csharp public abstract class SingletonMonoBehaviour<T> : SingletonMonoBehaviour where T : MonoBehaviour ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1a7f4c710145
unity_docs
scripting
What is `Rigidbody.MoveRotation` in Unity? Explain its purpose and usage.
Rigidbody.MoveRotation Declaration public void MoveRotation ( Quaternion rot ); Parameters Parameter Description rot The new rotation for the Rigidbody. Description Rotates the rigidbody to rotation . Use Rigidbody.MoveRotation to rotate a Rigidbody , complying with the Rigidbody's interpolation set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e40a9df7ce6
unity_docs
scripting
What are the parameters of `GameObject.GetComponents` in Unity?
Description A variation of the GetComponents method which allows you to supply your own List to be filled with results. This allows you to avoid allocating new List objects for each call to the method. The list you supply is resized to match the number of results found, and any existing values in the list are overritte...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d7a75f4a1f71
unity_docs
editor
In Unity's 'Create a tabbed menu', what is 'Add tabs and tab content' and how does it work?
Add three tabs to the TabView. For each tab, add a label as its child element which displays the tab content. Under TabView, add three Tabs. In the Inspector panel of each Tab, set Label to the following values: London for the first Tab Paris for the second Tab Ottawa for the third Tab Set View Data Key to the followin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_298cf623a779
unity_docs
rendering
In Unity's 'Colors preferences reference', what is 'Scene colors' and how does it work?
Use this setting to customize preferences for a Scene . Property Function Background Set the color for the scene camera to clear to when the Scene FX skybox setting is turned off. Background for Prefabs Set the color for the scene camera to clear to when the Scene FX skybox setting is turned off. Contribute GI: Off / R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14486d2c9365
unity_docs
scripting
What is `LightTransport.IDeviceContext.Wait` in Unity? Explain its purpose and usage.
IDeviceContext.Wait Declaration public bool Wait ( LightTransport.EventID id ); Parameters Parameter Description id ID of the event. Returns bool Returns true if the event completed successfully. Description Wait for an asynchronous event. This is a blocking method which stalls the current CPU thre...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dcc08e137299
unity_docs
scripting
What is `iOSLaunchScreenType` in Unity? Explain its purpose and usage.
iOSLaunchScreenType enumeration Description iOS launch screen settings. Properties Property Description Default Use the default launch screen (dark blue background). ImageAndBackgroundRelative Use a custom launch screen image specified in the iOS Player Settings or with PlayerSettings.iOS.SetLaunchScreenImage ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6af857f57508
unity_docs
rendering
Explain 'Default shader keywords' in Unity.
Unity uses predefined sets of shader keywords to generate shader variants that enable common functionality. Unity adds the following sets of shader variant keywords at compile time: By default, Unity adds this set of keywords to all graphics shader programs: STEREO_INSTANCING_ON, STEREO_MULTIVIEW_ON, STEREO_CUBEMAP_REN...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e4dba359d344
unity_docs
animation
What is `Animations.BlendTreeType` in Unity? Explain its purpose and usage.
BlendTreeType enumeration Description The type of blending algorithm that the blend tree uses. Properties Property Description Simple1D Basic blending using a single parameter. SimpleDirectional2D Best used when your motions represent different directions, such as "walk forward", "walk backward", "walk left", ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cf073d74dd91
unity_docs
scripting
What is `QualitySettings.IncreaseLevel` in Unity? Explain its purpose and usage.
QualitySettings.IncreaseLevel Declaration public static void IncreaseLevel (bool applyExpensiveChanges = false); Parameters Parameter Description applyExpensiveChanges Should expensive changes be applied (Anti-aliasing etc). Description Increase the current quality level. ```csharp using UnityEngine;pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ca29a2dc43f
unity_docs
scripting
What is `UIElements.Focusable` in Unity? Explain its purpose and usage.
Focusable class in UnityEngine.UIElements / Inherits from: UIElements.CallbackEventHandler / Implemented in: UnityEngine.UIElementsModule Description Base class for objects that can get the focus. The focus is used to designate an element that will receive keyboard events. Properties Property Descrip...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_048fd5a79213
unity_docs
rendering
What is `Experimental.Rendering.ShaderWarmup.WarmupShaderFromCollection` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ShaderWarmup.WarmupShaderFromCollection Declaration public static void WarmupShaderFromCollection ( ShaderVariantCollection collection , Shader shader , Experimental.Rendering.ShaderWarmupSetup setup ); Description Pr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cae33593aa55
unity_docs
scripting
What is `AI.NavMesh.OnNavMeshPreUpdate` in Unity? Explain its purpose and usage.
NavMesh.OnNavMeshPreUpdate Declaration public delegate void OnNavMeshPreUpdate (); Description Registers callback methods to be invoked before the NavMesh system updates. This is useful for updating the NavMesh and links before the agents are simulated during the update cycle. Additional resources: onPreUpdate...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16102b9382b2
unity_docs
scripting
What is `PopupWindowContent.OnGUI` in Unity? Explain its purpose and usage.
PopupWindowContent.OnGUI Declaration public void OnGUI ( Rect rect ); Parameters Parameter Description rect The rectangle to draw the GUI inside. Description Callback for drawing GUI controls for the popup window. Additional resources: PopupWindow with full example.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50362a152a16
unity_docs
physics
What is `UnityEngine.TerrainPhysicsModule` in Unity? Explain its purpose and usage.
UnityEngine.TerrainPhysicsModule Description The TerrainPhysics module connects the Terrain and Physics modules by implementing the TerrainCollider component. Classes Class Description TerrainCollider A heightmap based collider.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4339f26c22e4
unity_docs
scripting
What is `FrameTiming.cpuTimePresentCalled` in Unity? Explain its purpose and usage.
FrameTiming.cpuTimePresentCalled public ulong cpuTimePresentCalled ; Description This is the CPU clock time at the point Present was called for the current frame. The CPU clock time at the point Present() is called for the frame. This is the time at which Unity finishes submitting objects for rendering and in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a54be12f25b
unity_docs
editor
Show me a Unity C# example demonstrating `EditorWindow.BeginWindows`.
itor, GUI.Window shows a subwindow inside one of your editor windows. Begin/EndWindows is used to determine where these can go. You need to have all calls to GUI.Window or GUILayout.Window inside a BeginWindows / EndWindows pair. Like this: Simple editor Window with a window and a button inside. An exception...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a6b2d7ba47e
unity_docs
editor
What is `Diagnostics.Utils.ValidateHeap` in Unity? Explain its purpose and usage.
Utils.ValidateHeap Declaration public static void ValidateHeap (); Description Scans the managed heap to check for corrupted objects. This function only works when you use the Mono scripting backend. If this function discovers a corrupted object, the editor log displays a callstack and the Editor crashes, eithe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84f1487fd19f
unity_docs
ui
What is `UIElements.BaseListView.onAdd` in Unity? Explain its purpose and usage.
BaseListView.onAdd public Action<BaseListView> onAdd ; Description This callback allows the user to implement their own code to be executed when the Add Button is clicked. This callback will only be called if showAddRemoveFooter is set to true . Setting this callback to anything other than null will ove...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f602e909827
unity_docs
scripting
What is `AnimationState.wrapMode` in Unity? Explain its purpose and usage.
AnimationState.wrapMode public WrapMode wrapMode ; Description Wrapping mode of the animation. By default wrapMode is initialized to the value set in the Animation component's wrap mode. ```csharp using UnityEngine; using System.Collections;public class ExampleScript : MonoBehaviour { public Animation ani...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55a28ce525c3
unity_docs
scripting
What is `Video.VideoPlayer.Play` in Unity? Explain its purpose and usage.
VideoPlayer.Play Declaration public void Play (); Description Starts or resumes the playback of a video. If the video isn't prepared, this method will prepare the video before it starts playback, but playback won't be instant. To make playback instant, use VideoPlayer.Prepare and wait for preparation to finis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6910d9d9a9ea_doc_17
github
scripting
What does `OnMouseOverAsObservable` do in this Unity script? Explain its purpose and signature.
OnMouseOver is called every frame while the mouse is over the GUIElement or Collider. Signature: ```csharp public static IObservable<Unit> OnMouseOverAsObservable(this Component component) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0afa8dcec792
unity_docs
scripting
What is `Embree.GpuBvhBuildOptions.isTopLevel` in Unity? Explain its purpose and usage.
GpuBvhBuildOptions.isTopLevel public bool isTopLevel ; Description With this option enabled, Unity builds a top level BVH (for instances). When disabled, it builds a bottom level BVH (for a Mesh).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ad3e0c4610db
unity_docs
scripting
What is `Component.TryGetComponent` in Unity? Explain its purpose and usage.
Component.TryGetComponent Declaration public bool TryGetComponent (out T component ); Parameters Parameter Description component The output argument that will contain the component or null . Returns bool Returns true if the component is found, false otherwise. Description Gets the component of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7dbb7a3b7939
unity_docs
scripting
What is `ProjectWindowCallback.EndNameEditAction.OnEnable` in Unity? Explain its purpose and usage.
EndNameEditAction.OnEnable Declaration public void OnEnable (); Description Unity calls this function when an asset is about to be created, allowing user to setup any actions that needs to be called during the asset creation process from the Project Browser.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d18b3dfa711f
unity_docs
rendering
What is `Material.IsKeywordEnabled` in Unity? Explain its purpose and usage.
Material.IsKeywordEnabled Declaration public bool IsKeywordEnabled (ref Rendering.LocalKeyword keyword ); Declaration public bool IsKeywordEnabled (string keyword ); Parameters Parameter Description keyword The LocalKeyword to check. keyword The name of the LocalKeyword to check. Returns bool...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1cfb5ca2a6cb
unity_docs
animation
What is `AnimatorTransitionInfo.durationUnit` in Unity? Explain its purpose and usage.
AnimatorTransitionInfo.durationUnit public DurationUnit durationUnit ; Description The unit of the transition duration. Can be either DurationUnit.Fixed (in seconds) or DurationUnit.Normalized (in percentage). Additional resources: AnimatorTransitionInfo.duration .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c5e0312f714
unity_docs
scripting
Show me a Unity C# example demonstrating `Handles`.
also supplement the 3D Handle GUI in the Scene with 2D buttons and other controls overlaid on the Scene view. This is done by enclosing standard Unity GUI calls in a Handles.BeginGUI and Handles.EndGUI pair within the Editor.OnSceneGUI function. You can use HandleUtility.GUIPointToWorldRay and HandleUtility.Wo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5919017c676e
unity_docs
rendering
What is `Device.SystemInfo.SupportsRandomWriteOnRenderTextureFormat` in Unity? Explain its purpose and usage.
SystemInfo.SupportsRandomWriteOnRenderTextureFormat Declaration public static bool SupportsRandomWriteOnRenderTextureFormat ( RenderTextureFormat format ); Description This has the same functionality as SystemInfo.SupportsRandomWriteOnRenderTextureFormat . At the moment, the Device Simulator doesn't support s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_215d7b2838c4
unity_docs
scripting
What is `PlayerSettings.iOS.appleDeveloperTeamID` in Unity? Explain its purpose and usage.
PlayerSettings.iOS.appleDeveloperTeamID public static string appleDeveloperTeamID ; Description Set this property with your Apple Developer Team ID. You can find this on the Apple Developer website under Account > Membership . This sets the Team ID for the generated Xcode project, allowing developers to use...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c68d0423d300
unity_docs
math
What is `Tilemaps.Tilemap.RemoveTileFlags` in Unity? Explain its purpose and usage.
Tilemap.RemoveTileFlags Declaration public void RemoveTileFlags ( Vector3Int position , Tilemaps.TileFlags flags ); Parameters Parameter Description position Position of the Tile on the Tilemap . flags TileFlags to remove from the Tile . Description Removes the TileFlags from the Tile at the g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e810efc37503
unity_docs
scripting
What are the parameters of `AnimationState.AddMixingTransform` in Unity?
Description Adds a transform which should be animated. This allows you to reduce the number of animations you have to create. For example you might have a handwaving animation. You might want to play the hand waving animation on a idle character or on a walking character. Either you have to create 2 hand waving animati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd15e207fdb4
unity_docs
editor
Show me a Unity C# example demonstrating `Callbacks.RunBeforePackageAttribute.ctor`.
s a dependency graph and uses topological sorting to ensure that all dependencies are run in sequence based on their dependencies. If callbacks dependencies are not present in the project then the instruction will be ignored during the generation of the dependency graph. Note: Defining callback dependencies is current...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69190bcf2b18
unity_docs
performance
What is `Unity.Collections.LowLevel.Unsafe.NativeContainerSupportsMinMaxWriteRestrictionAttribute` in Unity? Explain its purpose and usage.
NativeContainerSupportsMinMaxWriteRestrictionAttribute class in Unity.Collections.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description Indicates that a native container type can restrict its writable ranges to be between a min and a max index. You must mark your native container type with this ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4319231fa07d
unity_docs
scripting
Show me a Unity C# example demonstrating `Collision2D.transform`.
Collision2D.transform public Transform transform ; Description The Transform of the incoming object involved in the collision. Additional resources: Transform class. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void OnCollisionEnter2D(Collision2D collis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9b927c287a56
unity_docs
rendering
What is `TerrainLayer.maskMapTexture` in Unity? Explain its purpose and usage.
TerrainLayer.maskMapTexture public Texture2D maskMapTexture ; Description The mask map texture used by the terrain layer. The content of each channel varies by the terrain shader. For HDRP TerrainLit shader, the channels are: R: Height - used when doing height based blending G: Smoothness B: Metallic.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eadcafc8dc74
unity_docs
scripting
What is `MPE.ChannelClient.Send` in Unity? Explain its purpose and usage.
ChannelClient.Send Declaration public void Send (string data ); Declaration public void Send (byte[] data ); Declaration public static void Send (int connectionId , byte[] data ); Parameters Parameter Description data Data to send. connectionId The connection ID of the client sending the data. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d78ad2499d4a
unity_docs
xr
Explain 'Debug on Android devices' in Unity.
Unity supports the following ways to debug an application on an Android device: USB debugging . Both wired and wireless connection through Android Debug Bridge . ## USB debugging Unity supports USB debugging for Android devices. To use USB debugging, enable developer options on your device. To do this, refer to Andro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da042afadeb7
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector3.Min`.
Vector3.Min Declaration public static Vector3 Min ( Vector3 lhs , Vector3 rhs ); Description Returns a vector that is made from the smallest components of two vectors. Additional resources: Max function. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42cb277d093b
unity_docs
rendering
Give me an overview of the `ParticleSystemVertexStreams` class in Unity.
Method group is Obsolete ParticleSystemVertexStreams enumeration Obsolete ParticleSystemVertexStreams is deprecated. Please use ParticleSystemVertexStream instead. Description All possible Particle System vertex shader inputs.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d499bf6a11b0
unity_docs
input
Explain 'UI Toolkit project settings' in Unity.
To view the UI Toolkit project settings, go to Edit > Project Settings > UI Toolkit . ## UI Builder When you create a new UI Document (UXML) in the UI Builder, certain features are set by default: The UI Document is set to suit runtime UI. The UI Builder library only displays UI controls that are available for runtim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a0a0fe9be44e
unity_docs
scripting
In Unity's 'Best practices for managing elements', what is 'Keep the number of visible elements low' and how does it work?
To keep the number of visual elements low, use ListView when possible. ListView pools elements and recycles elements as the user scrolls. Alternatively, you can implement your own pool and recycle mechanism similar to the ListView , and use the following to manage the visible area: To observe the size of a container, u...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_440f83066c91
unity_docs
scripting
Show me a Unity C# example demonstrating `Video.VideoClip.frameCount`.
metadata of the file. Note : The length VideoClip returns can be inaccurate as the external encoder can be imprecise. Use VideoPlayer.frameCount to get a more accurate value. However, VideoPlayer.frameCount becomes more precise after one playthrough, so won’t be completely accurate until after the clip finishes on...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5d5777603ae
unity_docs
scripting
What is `ClipboardUtility.canDuplicateGameObject` in Unity? Explain its purpose and usage.
ClipboardUtility.canDuplicateGameObject public static Func<GameObject,bool> canDuplicateGameObject ; Description Optional filtering functions invoked to determine if a GameObject can be duplicated before any action is taken. All registered delegates of canDuplicateGameObject will be evaluated and must return tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3428d52561d5
unity_docs
scripting
What is `ArticulationDrive.lowerLimit` in Unity? Explain its purpose and usage.
ArticulationDrive.lowerLimit public float lowerLimit ; Description The lower limit of motion for a particular degree of freedom. Units of measurement - meters for linear and degrees for angular motion.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b690984e54d7
unity_docs
rendering
What is `Cubemap.streamingMipmaps` in Unity? Explain its purpose and usage.
Cubemap.streamingMipmaps public bool streamingMipmaps ; Description Determines whether mipmap streaming is enabled for this Texture. Mipmap streaming can only be enabled using the TextureImporter and cannot be changed at run time.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59e69830a3de
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddRemotePackageFrameworkToProject` in Unity? Explain its purpose and usage.
PBXProject.AddRemotePackageFrameworkToProject Declaration public void AddRemotePackageFrameworkToProject (string targetGuid , string name , string packageGuid , bool weak ); Parameters Parameter Description targetGuid The GUID of the target, such asthe one returned by TargetGuidByName . name The name o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49059dd11aac
unity_docs
scripting
What is `Mesh.vertexAttributeCount` in Unity? Explain its purpose and usage.
Mesh.vertexAttributeCount public int vertexAttributeCount ; Description Returns the number of vertex attributes that the mesh has. (Read Only) This property returns the number of active vertex attributes (see VertexAttributeDescriptor ). Together with GetVertexAttribute it can be used to query information a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_95295ae76e65
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.Free` in Unity? Explain its purpose and usage.
UnsafeUtility.Free Declaration public static void Free (void* memory , Unity.Collections.Allocator allocator ); Parameters Parameter Description memory A pointer to the block of memory you want to free. Ensure this pointer is valid and was previously allocated using UnsafeUtility.Malloc to avoid undefined...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5cf9e89e88e
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.IsSignedFormat` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.IsSignedFormat Declaration public static bool IsSignedFormat ( Experimental.Rendering.GraphicsFormat format ); Declaration public static bool IsSignedFormat ( TextureFormat format ); Description ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b27eebc534d
unity_docs
scripting
What is `Experimental.GraphView.Node.SetPosition` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node.SetPosition Declaration public void SetPosition ( Rect newPos ); Parameters Parameter Description newPos New position. Description Set node position.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_38dc6f663f8a
unity_docs
rendering
What is `Rendering.BatchFilterSettings.batchLayer` in Unity? Explain its purpose and usage.
BatchFilterSettings.batchLayer public byte batchLayer ; Description The batch layer to use for draw commands in this draw range. Use batchLayer to control which ranges Unity draws in a renderer list or shadow renderer list, based on FilteringSettings.batchLayerMask or ShadowDrawingSettings.batchLayerMask ....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5138f48701c
unity_docs
rendering
What is `Rendering.RendererUtils.RendererListDesc.ctor` in Unity? Explain its purpose and usage.
RendererListDesc Constructor Declaration public RendererListDesc ( Rendering.ShaderTagId passName , Rendering.CullingResults cullingResult , Camera camera ); Declaration public RendererListDesc (ShaderTagId[] passNames , Rendering.CullingResults cullingResult , Camera camera ); Parameters Para...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c1bcc39fc96
unity_docs
scripting
What is `VersionControl.Provider` in Unity? Explain its purpose and usage.
Provider class in UnityEditor.VersionControl Description This class provides access to the version control API. Note that the Version Control window is refreshed after every version control operation. This means that looping through multiple assets and doing an individual operation on each (i.e. Checkout) will be...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab780cf363f6
unity_docs
scripting
What is `Progress.GetRunningProgressCount` in Unity? Explain its purpose and usage.
Progress.GetRunningProgressCount Declaration public static int GetRunningProgressCount (); Returns int The number of active and running progress indicators. Description Gets the number of active or running progress indicators.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d932f56a261a
unity_docs
scripting
Give me an overview of the `Light` class in Unity.
Light class in UnityEngine / Inherits from: Behaviour / Implemented in: UnityEngine.CoreModule Description Script interface for light components . Use this to control all aspects of Unity's lights. The properties are an exact match for the values shown in the Inspector. For more information about shadow ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_876d61bceccd
unity_docs
scripting
What is `Experimental.GraphView.Port.orientation` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Port.orientation public Experimental.GraphView.Orientation orientation ; Description Port's orientation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c055dcff5919
unity_docs
rendering
What is `LightTransport.BufferID.Value` in Unity? Explain its purpose and usage.
BufferID.Value public ulong Value ; Description The underlying buffer identifier value. This value is implementation-specific and carries the actual buffer identifier used by the device context. The interpretation of this value depends on the concrete implementation: CPU Implementations: May store memory poin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4dc98a7a674
unity_docs
performance
Show me a Unity C# example demonstrating `Profiling.Profiler.GetTotalUnusedReservedMemoryLong`.
Profiler.GetTotalUnusedReservedMemoryLong Declaration public static long GetTotalUnusedReservedMemoryLong (); Returns long The amount of unused memory in the reserved pools. This returns 0 if the Profiler is not available. Description Unity allocates memory in pools for usage when unity needs to allocate m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f07cb0e76cf
unity_docs
scripting
What is `Component.BroadcastMessage` in Unity? Explain its purpose and usage.
Component.BroadcastMessage Declaration public void BroadcastMessage (string methodName , object parameter = null, SendMessageOptions options = SendMessageOptions.RequireReceiver); Declaration public void BroadcastMessage (string methodName , SendMessageOptions options ); Parameters Parameter Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_54960e138ac4
unity_docs
scripting
Show me a Unity C# example demonstrating `Sprite.Create`.
size of the Sprite. The extrude value defines the number of pixels which surround the Sprite . This is useful if the Sprite is included in an atlas. meshType selects whether FullRect or Tight is used. Finally border determines the slicing of the Sprite and is usually used to define Sprite tiling behaviour....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1f55908e960e
unity_docs
rendering
What is `Experimental.Rendering.GraphicsFormatUtility.GetSwizzleR` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormatUtility.GetSwizzleR Declaration public static Rendering.FormatSwizzle GetSwizzleR ( Experimental.Rendering.GraphicsFormat format ); Declaration public static Rendering.FormatSwizzle GetSwizzleR ( TextureFo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f63293b1a727
unity_docs
input
What is `HandleUtility.acceleration` in Unity? Explain its purpose and usage.
HandleUtility.acceleration public static float acceleration ; Description Get standard acceleration for dragging values (Read Only). Normal acceleration is 1.0. When Shift is pressed, it is 4.0; when Alt is pressed, acceleration is 0.25. Additional resources: niceMouseDelta .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4feebdd92406
unity_docs
physics
Explain 'Sphere collider component reference' in Unity.
The Sphere collider is a built-in sphere-shaped collider. It is useful for in-application items such as balls and marbles, or as a simple collider shape that you can stretch and scale to make marbles, projectiles, planets, and other spherical objects. Sphere colliders are also useful for items that need to roll and tum...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ecf7f6d09fd
unity_docs
scripting
What is `Progress.Item.RegisterCancelCallback` in Unity? Explain its purpose and usage.
Progress.Item.RegisterCancelCallback Declaration public void RegisterCancelCallback (Func<bool> callback ); Parameters Parameter Description callback The function called when a progress indicator's associated task is canceled. Description Registers a callback that is called when the user cancels a running ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_307bee38fa11
unity_docs
scripting
What is `Search.StringView.EndsWith` in Unity? Explain its purpose and usage.
StringView.EndsWith Declaration public bool EndsWith (char c , stringComparison sc ); Parameters Parameter Description c A character. sc A string comparison option. Returns bool True if the StringView ends with c , otherwise false. Description Checks if the StringView ends with the character ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38a1071e82e8_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Optional prefab to spawn for each spawned object.Use a prefab with to make sure the visualization only lives temporarily. Signature: ```csharp public GameObject spawnVisualizationPrefab ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_1c28fd6fd9de
unity_docs
scripting
What is `PlayerSettings.WSAImageScale` in Unity? Explain its purpose and usage.
WSAImageScale enumeration Description Options for the set of sizing values to apply to the Universal Windows Platform logo and icon images. These options specify variations for different screen sizes and resolutions. A Universal Windows Platform application must specify icon and logo images as part of the packa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bd5969e828d3_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Raised when a camera transition ends. Signature: ```csharp public event TransitionEndHandler OnTransitionEnd; ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_4d06268d039c
unity_docs
rendering
Explain 'Configuring material properties in prebuilt shaders' in Unity.
Techniques for using the properties of a prebuilt shader to change how materials look. Page Description Creating a material from a prebuilt shader Learn how the the Standard shader allows for many configurations in order to represent a variety of material types. Metallic and specular workflows Choose a shader workflow ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c4cb40316bd
unity_docs
physics
What is `AssetImporters.ScriptedImporterAttribute.version` in Unity? Explain its purpose and usage.
ScriptedImporterAttribute.version public int version ; Description Importer version number that is used by the import layer to detect new version of the importer and trigger re-imports when such events occur, to apply latest changes made to the scripted imrpoter. ```csharp using UnityEngine; using UnityEditor.A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_4ddfae5222bf_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A hand ray which is used by far pointers to direct interactions.This class is managed and updated by a implementation. Signature: ```csharp public class HandRay : IHandRay ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_287cd65fa042
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.RadeonRaysContext.DestroyEvent`.
vent ( LightTransport.EventID id ); Parameters Parameter Description id ID of the event to destroy. Description Destroy the event with the given ID. You should call this to free temporary resources associated with an event. Attempting to use the event after it has been destroyed, for example using IDeviceCo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_92fd8f458509
unity_docs
performance
Explain 'Job system overview' in Unity.
Unity’s job system lets you create multithreaded code so that your application can use all available CPU cores to execute your code. This provides improved performance because your application uses the capacity of all the CPU cores it’s running on more efficiently, rather than running all code on one CPU core. You can ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2b5e80c2ad22
unity_docs
ui
Show me a Unity C# example demonstrating `GUIStyle.stretchHeight`.
GUIStyle.stretchHeight public bool stretchHeight ; Description Can GUI elements of this style be stretched vertically for better layout? ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { GUI.skin.button.stretchHeight = true; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1398db4ed95d
unity_docs
xr
Explain 'Collect asset loading metrics' in Unity.
Use the AsyncReadManagerMetrics class to monitor runtime asset loading and file reading performance. This class records data for all file read operations managed by the AsyncReadManager . Unity uses the AsyncReadManager to read most files at runtime, including AssetBundles, Addressables, and Resources. You can also loa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c60741c2013e
unity_docs
physics
Give me an overview of the `ContactFilter2D` class in Unity.
ContactFilter2D struct in UnityEngine / Implemented in: UnityEngine.Physics2DModule Description A set of parameters for filtering contact results. Define the angle by referring to their position in world space, where 0 degrees is parallel to the positive x-axis, 90 degrees is parallel to the positive y-axis, 180...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_558f5a8e2381
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchExpressionEvaluationHints.ThreadNotSupported`.
SearchExpressionEvaluationHints.ThreadNotSupported Description Specifies that an evaluator does not support worker thread evaluation and should only be evaluated in the main thread. This could be the case if an evaluator is using non-tread safe Unity API (like AssetDatabase ). ```csharp [Description("Returns asset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1b7034b08ba8
unity_docs
xr
What is `Networking.UnityWebRequest.GetAssetBundle` in Unity? Explain its purpose and usage.
Removed UnityWebRequest.GetAssetBundle Obsolete UnityWebRequest.GetAssetBundle is obsolete. Use UnityWebRequestAssetBundle.GetAssetBundle instead. Upgrade to GetAssetBundle Declaration public static Networking.UnityWebRequest GetAssetBundle (string uri , uint crc ); Obsolete UnityWebRequest.GetAssetBun...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d444f5e74594
unity_docs
audio
What is `PlayerSettings.audioSpatialExperience` in Unity? Explain its purpose and usage.
PlayerSettings.audioSpatialExperience public static AudioSpatialExperience audioSpatialExperience ; Description Determines if the Unity app's final mixed audio stream is spatialized. The value selected here is set once when the app is first started. This value can be changed dynamically at runtime via the C#...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5532d130d0f0
unity_docs
performance
What is `Unity.Profiling.ProfilerRecorder.ToArray` in Unity? Explain its purpose and usage.
ProfilerRecorder.ToArray Declaration public ProfilerRecorderSample[] ToArray (); Description Use to convert collected samples to an array. Note: Accessing this method allocates a new managed array on every access, which contributes to GC allocated memory. As such, this might slow down the performance of your a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c09a93bb4ae7
unity_docs
ui
In Unity's 'Pseudo-classes', what is 'Chain pseudo-classes' and how does it work?
You can chain pseudo-classes together to apply the same style for multiple concurrent states. For example, the following USS rule chains the :checked and :hover pseudo-classes together to change the color of checked Toggle elements when a user hovers the pointer over them. ``` Toggle:checked:hover { background-color: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f3b344373753
unity_docs
rendering
Explain 'Render pipeline feature comparison' in Unity.
This page contains information on feature support in the Built-in Render Pipeline , the Universal Render Pipeline (URP), and the High Definition Render Pipeline (HDRP). It also contains suggested alternatives for certain features. For ease of reference, features are broken down into the following categories: Platform S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ec08417eb5b9
unity_docs
scripting
What is `ModifiableContactPair.SetStaticFriction` in Unity? Explain its purpose and usage.
ModifiableContactPair.SetStaticFriction Declaration public void SetStaticFriction (int i , float staticFriction ); Parameters Parameter Description i Index of the contact point. staticFriction The static friction coefficient at a contact point. Description Set the static friction coefficient at a partic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41841d154f41
unity_docs
performance
What is `Unity.Profiling.ProfilerCategory.Internal` in Unity? Explain its purpose and usage.
ProfilerCategory.Internal public static Unity.Profiling.ProfilerCategory Internal ; Description Internal Unity systems Profiler category. This Profiler category does not have its own visualization in the CPU Usage Profiler chart. Instead, Profiler samples generated with this category will add their self time ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1d5a3cf8226
unity_docs
physics
Show me a Unity C# example demonstrating `UIElements.ManipulatorActivationFilter`.
ManipulatorActivationFilter struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description Defines conditions for manipulators to respond to specific events. ```csharp public class ClickableTest { public void CreateClickable() { var clickable = new Clickable(() => { Debug.Log...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0b7faca2906
unity_docs
scripting
What is `Experimental.GraphView.SelectionDragger.UnregisterCallbacksFromTarget` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SelectionDragger.UnregisterCallbacksFromTarget Declaration protected void UnregisterCallbacksFromTarget (); Description Called to unregister event callbacks from the target element.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21b39e88dd68
unity_docs
physics
Show me a Unity C# example demonstrating `RaycastHit.articulationBody`.
RaycastHit.articulationBody public ArticulationBody articulationBody ; Description The ArticulationBody of the collider that was hit. If the collider is not attached to an articulation body then it is null . ```csharp using UnityEngine;public class Example : MonoBehaviour { // Apply a force to a clicked a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c17a1db9a8d7
unity_docs
animation
What are the parameters of `AssetPostprocessor.OnPreprocessCameraDescription` in Unity?
Description Add this function to a subclass to receive a notification when a camera is imported from a Model Importer. Unity only calls this function when ModelImporter.importCameras is true. This function gives you control over camera properties and animations during the model import process. The CameraDescription str...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_874088ae49ff
unity_docs
physics
What is `Collider2D.compositeCapable` in Unity? Explain its purpose and usage.
Collider2D.compositeCapable public bool compositeCapable ; Description Indicates if this Collider2D is capable of being composited by the CompositeCollider2D . Additional resources: CompositeOperation , Collider2D.compositeOrder and CompositeCollider2D .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c42825d29c2
unity_docs
editor
Show me a Unity C# example demonstrating `Rendering.GraphicsSettings.defaultRenderPipeline`.
e RenderPipeline defined in this RenderPipelineAsset . Unity uses this value and the override value in QualitySettings.renderPipeline to determine the active render pipeline for the current quality level. For more information, see GraphicsSettings.currentRenderPipeline . In the Unity Editor, this property corresp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2d3a12435f7a
unity_docs
ui
In Unity's 'Work with elements', what is 'Read-only elements' and how does it work?
When you drag an element from the Library tab to the Hierarchy tab, you might notice additional child elements appearing in a dimmed state. These are read-only elements. This happens with some built-in UI controls, and some custom elements that create their internal hierarchy upon creation . When you add child elements...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17b4de1e44d4
unity_docs
input
What is `UIElements.MouseLeaveWindowEvent.ctor` in Unity? Explain its purpose and usage.
MouseLeaveWindowEvent Constructor Declaration public MouseLeaveWindowEvent (); Description Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instances.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1c6032a90300
unity_docs
rendering
Show me a Unity C# example demonstrating `Camera.allCamerasCount`.
Camera.allCamerasCount public static int allCamerasCount ; Description The number of cameras in the current Scene. Returns the size of the array that Camera.allCameras returns and the amount of cameras that Camera.GetAllCameras will fill. ```csharp using UnityEngine;public class ExampleScript : MonoBehavi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f918e1b6bc3
unity_docs
performance
In Unity's 'Optimization', what is 'Additional resources and examples' and how does it work?
📖 E-Book : Optimize your game performance for mobile, XR, and the web in Unity (Unity 6 edition) 📖 E-Book : Optimize your game performance for consoles and PCs in Unity (Unity 6 edition) 📖 E-Book : Ultimate guide to profiling Unity games 📝 How-to guide : Performance optimization for high-end graphics on PC and cons...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_548170ff1bee
unity_docs
scripting
What is `UIElements.BaseVerticalCollectionView.onSelectedIndicesChange` in Unity? Explain its purpose and usage.
BaseVerticalCollectionView.onSelectedIndicesChange Description Obsolete. Use BaseVerticalCollectionView.selectedIndicesChanged instead. This callback receives an enumerable that contains the item index or item indices selected.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c0493387d73
unity_docs
rendering
In Unity's 'BlendOp command in ShaderLab reference', what is 'Syntax' and how does it work?
This command makes a change to the render state. Use it in a Pass block to set the render state for that Pass, or use it in a SubShader block to set the render state for all Passes in that SubShader. Signature Example syntax Function BlendOp <operation> BlendOp Sub Sets the blending operation used by the Blend command.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0755f6f39e25
unity_docs
rendering
Show me a Unity C# example demonstrating `ScreenCapture.CaptureScreenshot`.
%userprofile%\AppData\LocalLow\<companyname>\<productname> on Windows Editor), pass a full path: System.IO.Path.Combine(Application.persistentDataPath, "screenshot.png") . When the superSize parameter is more than 1, a larger resolution screenshot is produced. For example, if you pass 4, you create a screenshot 4x4...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e63d60f688f9
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.A2B10G10R10_UIntPack32` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.A2B10G10R10_UIntPack32 Description A four-component, 32-bit packed unsigned integer format that has a 2-bit A component in bits 30..31, a 10-bit B component in bits 20..29, a 10-bit G component in bits 10..19, and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.