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_f8c27317ee66
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.AddSourcesBuildPhase`.
Guid The GUID of the target, such as the one returned by TargetGuidByName . Returns string Returns the GUID of the new phase. Description Creates a new sources build phase for a given target. If the sources build phase is already configured for the target, the function returns the existing phase. The new pha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_842f45aa6654
unity_docs
editor
What is `Android.IPostGenerateGradleAndroidProject` in Unity? Explain its purpose and usage.
IPostGenerateGradleAndroidProject interface in UnityEditor.Android Implements interfaces: IOrderedCallback Description Implement this interface to receive a callback after the Android Gradle project is generated. Inherited from UnityEditor.Build.IOrderedCallback. Public Methods Method Description OnPostGenera...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4d24ea16bdc
unity_docs
scripting
What is `Android.RequestToUseMobileDataAsyncOperation` in Unity? Explain its purpose and usage.
RequestToUseMobileDataAsyncOperation class in UnityEngine.Android / Inherits from: CustomYieldInstruction / Implemented in: UnityEngine.AndroidJNIModule Description Represents an asynchronous operation that requests to use mobile data to download Android asset packs. AndroidAssetPacks.RequestToUseMobileDataAs...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a8b2d4569c3
unity_docs
physics
Show me a Unity C# example demonstrating `Cloth.externalAcceleration`.
Cloth.externalAcceleration public Vector3 externalAcceleration ; Description A constant, external acceleration applied to the cloth. Use this to simulate constant forces on the cloth, such as wind waving a flag. Additional resources: Cloth.randomAcceleration . ```csharp using UnityEngine;public class Examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f335a90e273
unity_docs
scripting
What is `AI.NavMeshAgent.isPathStale` in Unity? Explain its purpose and usage.
NavMeshAgent.isPathStale public bool isPathStale ; Description Is the current path stale. (Read Only) When true, the path may no longer be valid or optimal. This flag will be set if: there are any changes to the areaMask , if any OffMeshLink is enabled or disabled, or if the costs for the NavMeshAreas have bee...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d66c77c88332
unity_docs
rendering
What is `Rendering.SortingSettings.cameraPosition` in Unity? Explain its purpose and usage.
SortingSettings.cameraPosition public Vector3 cameraPosition ; Description Used to calculate the distance to objects. Together with worldToCameraMatrix , this is used to determine distances to objects for sorting. Additional resources: DrawingSettings , ScriptableRenderContext.DrawRenderers.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3cb4054dd70d
unity_docs
editor
Show me a Unity C# example demonstrating `Unity.Profiling.Memory.MemoryProfiler.TakeSnapshot`.
s no way to capture Play mode in isolation, only the entire Editor. Memory usage in the Editor can differ drastically from that in a built Player. Always make sure to analyze memory usage in development Players running on your target devices. * You can only take the next snapshot after the finishCallback is triggered...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f200f42634dd
unity_docs
math
What is `UIElements.ScrollView.scrollOffset` in Unity? Explain its purpose and usage.
ScrollView.scrollOffset public Vector2 scrollOffset ; Description The current scrolling position. You can set this property to scroll the content to a specific position. For example, to scroll to the bottom of the ScrollView, set this property to the maximum value of the vertical scroller. Refer to the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd602f15924f
unity_docs
editor
What is `EditorGUILayout.RectIntField` in Unity? Explain its purpose and usage.
EditorGUILayout.RectIntField Declaration public static RectInt RectIntField ( RectInt value , params GUILayoutOption[] options ); Declaration public static RectInt RectIntField (string label , RectInt value , params GUILayoutOption[] options ); Declaration public static RectInt RectIntField ( G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a77dcf8efbf8
unity_docs
rendering
What is `Random` in Unity? Explain its purpose and usage.
Random class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Easily generate random data for games. This static class provides several easy game-oriented ways of generating pseudorandom numbers . The generator is an Xorshift 128 algorithm, based on the paper Xorshift RNGs by George Mar...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14f8d78a3a1e
unity_docs
editor
What is `Windows.Directory.roamingFolder` in Unity? Explain its purpose and usage.
Directory.roamingFolder public static string roamingFolder ; Description Returns a path to roaming folder. On Windows Store Apps, it will be <main drive>:\Users\<user name>\AppData\Local\Packages\<package id>\RoamingState, directory is writeable, so you can create, read and write files to it. In Editor, it will...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4efca183cc6
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector3.operator_eq`.
Vector3.operator == public static bool operator == ( Vector3 lhs , Vector3 rhs ); Description Returns true if two vectors are approximately equal. To allow for floating point inaccuracies, the two vectors are considered equal if the magnitude of their difference is less than 1e-5. Additional resources: Eq...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6648de64686f
unity_docs
rendering
What is `TerrainTools.PaintContext.ScatterAlphamap` in Unity? Explain its purpose and usage.
PaintContext.ScatterAlphamap Declaration public void ScatterAlphamap (string editorUndoName ); Parameters Parameter Description editorUndoName Unique name used for the undo stack. Description Applies an edited alphamap PaintContext by copying modifications back to the source Terrain tiles. Once the edits...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f203ec3da15
unity_docs
rendering
Explain 'Configure reflections in prebuilt shaders' in Unity.
To configure reflections in a prebuilt shader , use the Metallic or Specular property and the Smoothness property. ## Select a workflow Select a material in the Hierarchy window, then in the Inspector window of the material do one of the following: If your project uses the Universal Render Pipeline (URP), set Workflo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a14cdee61f7
unity_docs
audio
What are the parameters of `Android.AndroidProjectFiles.SetManifestFile` in Unity?
Description Sets a new Android Manifest file. To use this method, you must also declare your new file in AndroidProjectFilesModifier.Setup using the AndroidProjectFilesModifierContext.AdditionalOutputs.AddManifestFile method. ```csharp using System.IO; using Unity.Android.Gradle.Manifest; using UnityEditor.Android;publ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_548b512dc464
unity_docs
editor
What is `PlayerSettings.productName` in Unity? Explain its purpose and usage.
PlayerSettings.productName public static string productName ; Description The name of your product. This will appear on the menu bar when your game is running and is used to locate the preferences file. Custom player settings. ```csharp using UnityEngine; using UnityEditor; // Simple Script that saves and lo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de7ae8c1d9f1
unity_docs
scripting
What is `Mesh.MeshData.GetVertexAttributeOffset` in Unity? Explain its purpose and usage.
Mesh.MeshData.GetVertexAttributeOffset Declaration public int GetVertexAttributeOffset ( Rendering.VertexAttribute attr ); Parameters Parameter Description attr The vertex data attribute to check for. Returns int The byte offset within a atream of the data attribute, or -1 if it is not present. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7c6a853c8fd
unity_docs
animation
What is `Animations.AnimatorTransitionBase` in Unity? Explain its purpose and usage.
AnimatorTransitionBase class in UnityEditor.Animations / Inherits from: Object Description Base class for animator transitions. Transitions define when and how the state machine switches from one state to another. A transition happens when all its conditions are met. Properties Property Description conditio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_76789d37e587
unity_docs
scripting
Explain 'Set a GameObject to use light from Light Probes' in Unity.
To use Light Probes on your moving GameObjects, the Mesh Renderer component on the moving GameObject must be set correctly. The Mesh Renderer component has a Light Probes setting which is set to Blend Probes by default. This means that by default, all GameObjects will use light probes and will blend between the nearest...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ce21a06d0744
unity_docs
rendering
What is `PickingIncludeExcludeList.ExcludeRenderers` in Unity? Explain its purpose and usage.
PickingIncludeExcludeList.ExcludeRenderers public NativeArray<int> ExcludeRenderers ; Description An array of GameObjects that the picking algorithm doesn't consider when it selects the nearest object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00dd0f3909d8
unity_docs
scripting
What is `Gizmos.matrix` in Unity? Explain its purpose and usage.
Gizmos.matrix public static Matrix4x4 matrix ; Description Sets the Matrix4x4 that the Unity Editor uses to draw Gizmos . The Gizmos.matrix stores the position, rotation and scale of the Gizmos . By default, Gizmos always uses world coordinates. The default Gizmos.matrix transforms the world coordin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fabe12cecaa8
unity_docs
editor
Show me a Unity C# example demonstrating `EditorGUI.DisabledScope`.
trols that can be disabled. If disabled is true, the controls inside the group will be disabled. If false, the enabled/disabled state will not be changed. The group cannot be used to enable controls that would otherwise be disabled to begin with. The groups can be nested and the controls within a child group will be d...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2644ca6d56c1
unity_docs
scripting
What is `IMGUI.Controls.TreeView.CanBeParent` in Unity? Explain its purpose and usage.
TreeView.CanBeParent Declaration protected bool CanBeParent ( IMGUI.Controls.TreeViewItem item ); Parameters Parameter Description item Can this item be a parent? Description Override this method to control which items are allowed to be parents. This is called internally by the TreeView to determine drag...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e960bf7dfdb
unity_docs
physics
Give me an overview of the `WheelHit` class in Unity.
WheelHit struct in UnityEngine / Implemented in: UnityEngine.VehiclesModule Description Contact information for the wheel, reported by WheelCollider . Friction for the WheelCollider is computed separately from the rest of the physics, using a slip based tire friction model. This allows for more realistic beh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f57ceb8754f
unity_docs
networking
What is `Networking.MultipartFormDataSection.contentType` in Unity? Explain its purpose and usage.
MultipartFormDataSection.contentType public string contentType ; Returns string The Content-Type header for this section, or null . Description Returns the value to use in this section's Content-Type header. Additional resources: IMultipartFormSection.contentType .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_193bf0927e95
unity_docs
editor
What is `MouseCursor` in Unity? Explain its purpose and usage.
MouseCursor enumeration Description Custom mouse cursor shapes used with EditorGUIUtility.AddCursorRect. ```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...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac1a7423d787
unity_docs
animation
What are the parameters of `ModelImporterClipAnimation.ConfigureMaskFromClip` in Unity?
Description Copy the current masking settings from the clip to an AvatarMask . When writing an AssetPostprocessor , use this method to copy the AvatarMask from your clip configuration so that you can modify it. Note: you will need to use ModelImporterClipAnimation.ConfigureClipFromMask to apply the AvatarMask back on t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_676bd01442cc
unity_docs
scripting
Show me a Unity C# example demonstrating `AnimationState.AddMixingTransform`.
e, one for walking. By using mixing the hand waving animation will have full control of the shoulder. But the lower body will not be affected by it, and continue playing the idle or walk animation. Thus you only need one hand waving animation. If recursive is true all children of the mix transform will also be anim...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32208c744c18
unity_docs
editor
What is `PlayerSettings.Android.autoRotationBehavior` in Unity? Explain its purpose and usage.
PlayerSettings.Android.autoRotationBehavior public static AndroidAutoRotationBehavior autoRotationBehavior ; Description Indicate whether your application window rotates based on device orientation settings (User) or device orientation sensor (Sensor), when default orientation is Auto Rotation. ```csharp usi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3da34154fc96
unity_docs
scripting
What is `SearchService.ISearchContext.engineScope` in Unity? Explain its purpose and usage.
ISearchContext.engineScope public SearchService.SearchEngineScope engineScope ; Description An enum that identifies the current search scope. Additional resources: SearchService.Scene.EngineScope, SearchService.Project.EngineScope, SearchService.ObjectSelector.EngineScope.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c57850948f90
unity_docs
input
What is `Input.anyKeyDown` in Unity? Explain its purpose and usage.
Input.anyKeyDown public static bool anyKeyDown ; Description Returns true the first frame the user hits any key or mouse button. (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 System p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b79e5cb4bc9a
unity_docs
scripting
Explain 'Get started with scripting' in Unity.
Get started with programming in Unity. Create, name, and edit your first scripts and set up your development environment to write, test, and debug your Unity C# scripts effectively. Topic Description Introduction to scripting Understand the role of scripting in your project and how it works at a high level. Creating sc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84f7de0bd176
unity_docs
scripting
What is `UIElements.INotifyBindablePropertyChanged` in Unity? Explain its purpose and usage.
INotifyBindablePropertyChanged interface in UnityEngine.UIElements Description Defines a component that notifies when a property has changed. Events Event Description propertyChanged Called when a property has changed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bfc2a8104e4e
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody.isKinematic`.
igidbodies through collisions or joints. Eg. can connect a kinematic rigidbody to a normal rigidbody with a joint and the rigidbody will be constrained with the motion of the kinematic body. Kinematic rigidbodies are also particularly useful for making characters which are normally driven by an animation, but on certai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebf9a58dec25
unity_docs
rendering
What is `ShaderUtil.GetRayTracingShaderMessageCount` in Unity? Explain its purpose and usage.
ShaderUtil.GetRayTracingShaderMessageCount Declaration public static int GetRayTracingShaderMessageCount ( Rendering.RayTracingShader s ); Parameters Parameter Description s The RayTracingShader instance to check for messages. Returns int The number of errors and warnings generated by the Shader Compi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_114422c052e6
unity_docs
scripting
Show me a Unity C# example demonstrating `Camera.cullingMatrix`.
Camera.cullingMatrix public Matrix4x4 cullingMatrix ; Description Sets a custom matrix for the camera to use for all culling queries. This lasts until it is disabled by calling ResetCullingMatrix . A custom culling matrix can be useful in situations where multiple cameras must be culled identically in order...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4c051886474
unity_docs
scripting
What is `AwaitableCompletionSource.TrySetCanceled` in Unity? Explain its purpose and usage.
AwaitableCompletionSource.TrySetCanceled Declaration public bool TrySetCanceled (); Returns bool Indicates if the cancellation was successfuly raised. Description Raise cancellation (returns false if the awaitable was already completed or canceled).
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_25c88f14ba47
unity_docs
rendering
What is `TextureImporterSettings.spriteAlignment` in Unity? Explain its purpose and usage.
TextureImporterSettings.spriteAlignment public int spriteAlignment ; Description Edge-relative alignment of the sprite graphic. The possible values relate to the SpriteAlignment enum as follows: Center = 0, TopLeft = 1, TopCenter = 2, TopRight = 3, LeftCenter = 4, RightCenter = 5, BottomLeft = 6, BottomCenter =...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c97530cd07c3
unity_docs
scripting
What is `Unity.Hierarchy.Hierarchy.GetName` in Unity? Explain its purpose and usage.
Hierarchy.GetName Declaration public string GetName (ref Unity.Hierarchy.HierarchyNode node ); Parameters Parameter Description node The hierarchy node. Returns string The name of the node. Description Gets the name of a hierarchy node.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_682489da9e13
unity_docs
rendering
Show me a Unity code example for 'Reuse HLSL code'.
lude directive. For more information, refer to include directive in the Microsoft HLSL documentation. ## Duplicate HLSL in multiple places To duplicate HLSL code in all the sections of your code, for example to add the same variables in multiple Pass blocks, wrap the code you want to reuse in HLSLINCLUDE and ENDHLSL ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_59f7e51e9886
github
scripting
Write a Unity C# MonoBehaviour script called Test Factory Method
```csharp using BehaviourInject; using BehaviourInject.Test; using UnityEngine; namespace BehaviourInject.Test { public class TestFactoryMethod : MonoBehaviour { private void Start() { ArgumentDependency dependency = new ArgumentDependency(); ResultDependency resultDepe...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_1dc80f4a3342
unity_docs
scripting
Give me an overview of the `SpritePackerMode` class in Unity.
SpritePackerMode enumeration Description Sprite Packer mode for the current project. Properties Property Description Disabled Doesn't pack sprites. BuildTimeOnlyAtlas Pack all the SpriteAtlas when building player/bundles. AlwaysOnAtlas Always pack all the SpriteAtlas. SpriteAtlasV2 If enabled, will automatic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0edf28c6f428
unity_docs
physics
What is `Physics` in Unity? Explain its purpose and usage.
Physics class in UnityEngine / Implemented in: UnityEngine.PhysicsModule Description Global physics properties and helper methods. Static Properties Property Description AllLayers Layer mask constant to select all layers. autoSyncTransforms Whether or not to automatically sync transform changes with the phy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a4cb2a6d0ad5
unity_docs
rendering
Explain 'Introduction to the Frame Debugger' in Unity.
Debug frames to help identify rendering artefacts and other issues. Unity includes a dedicated Frame Debugger that can pause the application on a particular frame and display the list of rendering events that constitute the frame. The Frame Debugger can step through each event and display the graphical state of the sce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b338a48ab639
unity_docs
physics
What is `PhysicsVisualizationSettings.GetShowTerrainColliders` in Unity? Explain its purpose and usage.
PhysicsVisualizationSettings.GetShowTerrainColliders Declaration public static bool GetShowTerrainColliders (); Description Should TerrainColliders be shown. Additional resources: TerrainCollider .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_272506321cbd
unity_docs
scripting
What is `Hash128.Parse` in Unity? Explain its purpose and usage.
Hash128.Parse Declaration public static Hash128 Parse (string hashString ); Parameters Parameter Description hashString A hexadecimal-encoded hash string. Returns Hash128 The 128-bit hash. Description Convert a hex-encoded string into Hash128 value. This function is the opposite of ToString - gi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_84df3e32b04b
github
scripting
Write a Unity C# UI script for Result Process
```csharp using System.Threading; using AntiMonoBehaviour.Views; using Cysharp.Threading.Tasks; using UnityEngine; using VContainer; namespace AntiMonoBehaviour.Processes { public interface IResultProcessParams { GameObject ResultViewPrefab { get; } } public class ResultProcess : ProcessBase ...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_bcbc04264c18
unity_docs
performance
Explain 'Read frame timing data with ProfilerRecorder' in Unity.
You can use the ProfilerRecorder API to get custom and built-in Profiler counter values, and to read FrameTimingManager values. The benefit of this is that when you use the ProfilerRecorder API, FrameTimingManager only records values when you attach a recorder to a specific counter. This behavior enables you to control...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ef3a0867b33a
unity_docs
scripting
Give me an overview of the `Flare` class in Unity.
Flare class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.CoreModule Description A flare asset. Read more about flares in the components reference . The flare class has no properties. It needs to be setup up in the inspector. You can reference flares and assign them to a Light at ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc52a225e5e6
unity_docs
editor
What is `SceneManagement.RemovedGameObject` in Unity? Explain its purpose and usage.
RemovedGameObject class in UnityEditor.SceneManagement / Inherits from: SceneManagement.PrefabOverride Description Class with information about a GameObject that has been removed from a Prefab instance. Additional resources: PrefabUtility.ApplyRemovedGameObject , PrefabUtility.RevertRemovedGameObject , Prefa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26f8152a7b1f
unity_docs
physics
Give me an overview of the `FixedJoint2D` class in Unity.
FixedJoint2D class in UnityEngine / Inherits from: AnchoredJoint2D / Implemented in: UnityEngine.Physics2DModule Description Connects two Rigidbody2D together at their anchor points using a configurable spring. Properties Property Description dampingRatio The amount by which the spring force is reduced i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c95174555cc4
unity_docs
editor
What is `VersionControl.VersionControlAttribute.displayName` in Unity? Explain its purpose and usage.
VersionControlAttribute.displayName public string displayName ; Description Version control system display name. Can be localized. Used in UI. ```csharp using UnityEditor.VersionControl; using UnityEngine;public class CustomVersionControlAttribute : VersionControlAttribute { static string GetDisplayName() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_42a477774518
unity_docs
physics
What are the parameters of `GUILayout.BeginScrollView` in Unity?
Returns Vector2 The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. Description Begin an automatically laid out scrollview. Automatically laid out scrollviews will take whatever content you have inside them and display normally. If it doesn't fit, scrollbars will appear. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d6c3d7113891
unity_docs
editor
What is `AssetDatabase.GetAllAssetBundleNames` in Unity? Explain its purpose and usage.
AssetDatabase.GetAllAssetBundleNames Declaration public static string[] GetAllAssetBundleNames (); Returns string[] Returns an array of AssetBundle names. Description Obtain all the AssetBundle names registered in the Asset Database. ```csharp using UnityEditor; using UnityEngine;public class GetAssetBund...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91d5ff7e58da
unity_docs
rendering
What is `Texture3D.GetPixels` in Unity? Explain its purpose and usage.
Texture3D.GetPixels Declaration public Color[] GetPixels (int miplevel ); Declaration public Color[] GetPixels (); 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 Color[] An array that ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_461579a06bf9
unity_docs
scripting
What is `UIElements.UxmlObjectReferenceAttribute.name` in Unity? Explain its purpose and usage.
UxmlObjectReferenceAttribute.name public string name ; Description The name of the nested UXML element that the UXML Objects are serialized to. Note : A null or empty value will result in the objects being serialized into the root.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4d0118e141f
unity_docs
rendering
What are the parameters of `ParticleSystemJobs.IJobParticleSystemParallelForBatch.Execute` in Unity?
Description Implement this method to access and modify particle properties. Below is an example of a script that you can use to attract particles to a supplied position. ```csharp using System; using Unity.Collections; using UnityEngine; using UnityEngine.ParticleSystemJobs;public class ParticleJob : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_046d24ba056d
unity_docs
scripting
What is `AndroidJNI.GetFieldID` in Unity? Explain its purpose and usage.
AndroidJNI.GetFieldID Declaration public static IntPtr GetFieldID (IntPtr clazz , string name , string sig ); Description Returns the field ID for an instance (nonstatic) field 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_8d41830170b8
unity_docs
scripting
What is `WaitUntil` in Unity? Explain its purpose and usage.
WaitUntil class in UnityEngine / Inherits from: CustomYieldInstruction / Implemented in: UnityEngine.CoreModule Description Suspends the coroutine execution until the supplied delegate evaluates to true . WaitUntil can only be used with a yield statement in coroutines. The supplied delegate is executed ea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_601de6ea02fc
unity_docs
editor
What are the parameters of `Search.SearchIndexer.Search` in Unity?
Returns IEnumerable<SearchResult> Returns a collection of Search Results matching the query. Description Runs a search query in the index. ```csharp using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; static class Example_SearchIndexer_Search { [MenuItem("Examples/SearchIndexer/Searc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8facdf9dc9e7
unity_docs
rendering
In Unity's 'Enable mipmap streaming', what is 'Custom meshes' and how does it work?
If you create a custom mesh in a Unity script, Unity doesn’t automatically calculate the UV density of the mesh. This means Unity loads the wrong mipmap levels. To prevent this, do either of the following: Use the Mesh.RecalculateUVDistributionMetrics API to manually calculate the UV density of the mesh after you creat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f7bb7e888d06
unity_docs
scripting
What is `TestTools.ExcludeFromCoverageAttribute` in Unity? Explain its purpose and usage.
ExcludeFromCoverageAttribute class in UnityEngine.TestTools / Implemented in: UnityEngine.CoreModule Description Allows you to exclude an Assembly, Class, Constructor, Method or Struct from Coverage .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_387adcc8bc65
unity_docs
editor
What is `UIElements.BaseListView.showBoundCollectionSize` in Unity? Explain its purpose and usage.
BaseListView.showBoundCollectionSize public bool showBoundCollectionSize ; Description This property controls whether the list view displays the collection size (number of items). The default value is true . When this property is set to to true , the ListView includes a TextField to control the array siz...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f53e0232af26
unity_docs
input
What are the parameters of `Color.RGBToHSV` in Unity?
Description Calculates the hue, saturation and value of an RGB input color. The H, S, and V are output in the range 0.0 to 1.0. ```csharp using UnityEngine;// Display an RGBA as an HSVpublic class ExampleScript : MonoBehaviour { void Start() { float H, S, V; Color.RGBToHSV(new Color(0.9f, 0.7f, 0...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_63ebc87ce2bd
unity_docs
input
What is `Touch.deltaTime` in Unity? Explain its purpose and usage.
Touch.deltaTime public float deltaTime ; Description Amount of time that has passed since the last recorded change in Touch values. Values for the various touch properties are updated periodically. The deltaTime value is simply the amount of time that elapsed between the previous update and the current one. Thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0151d074f6a6
unity_docs
physics
What is `Collider2D.CreateMesh` in Unity? Explain its purpose and usage.
Collider2D.CreateMesh Declaration public Mesh CreateMesh (bool useBodyPosition , bool useBodyRotation , bool useDelaunay = true); Parameters Parameter Description useBodyPosition Should the mesh be transformed by the position of the attached Rigidbody2D ? useBodyRotation Should the mesh be transforme...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c523331e146d
unity_docs
rendering
What are the parameters of `Material.SetFloat` in Unity?
Description Sets a named float value. When setting values on materials using the Standard Shader, you should be aware that you may need to use EnableKeyword to enable features of the shader that were not previously in use. For more detail, read Accessing Materials via Script . Additional resources: GetFloat , Materials...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_369742ec57cf
unity_docs
rendering
In Unity's 'Creating models for animation', what is 'Rigging' and how does it work?
3D modeling software provides a number of ways to create joints for your rig. For a Humanoid model, there are specific requirements for the skeleton so that Unity can match it to a Humanoid Avatar : A minimum of 15 bones. Your skeleton needs to have at least the required bones in place. In order to improve your chances...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8fa000b6c350
unity_docs
input
What is `Input.inputString` in Unity? Explain its purpose and usage.
Input.inputString public static string inputString ; Description Returns the keyboard input entered this frame. (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 System package. To learn ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_fda4c80d577f
github
scripting
Write a Unity C# script called Log Util
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using System.Diagnostics; static public class LogUtil { static public readonly string ColorEnd = "</color>"; private static readonly Color methodLogColor = new Color(0, 0.7f, 0.1f); private static readonly Color type...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf3b46108a9c
unity_docs
rendering
What is `MeshDeformation.GPU` in Unity? Explain its purpose and usage.
MeshDeformation.GPU Description Enables Unity using compute shaders to process mesh deformations on the GPU. Unity creates one dispatch call for each mesh and active blendshape. If you build for a graphics API that supports compute shaders and you render many skinned meshes, use MeshDeformation.GPUBatched for bet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a778614afe73
unity_docs
scripting
Give me an overview of the `GUITargetAttribute` class in Unity.
GUITargetAttribute class in UnityEngine / Implemented in: UnityEngine.IMGUIModule Description Allows to control for which display the OnGUI is called. Constructors Constructor Description GUITargetAttribute Default constructor initializes the attribute for OnGUI to be called for all available displays.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9c65b8d4b7a4
unity_docs
animation
What is `Animations.AnimationPlayableOutput.SetTarget` in Unity? Explain its purpose and usage.
AnimationPlayableOutput.SetTarget Declaration public void SetTarget ( Animator value ); Parameters Parameter Description value The targeted Animator . Description Sets the Animator that plays the animation graph.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e29ed2d080e6
unity_docs
rendering
What is `Video.VideoRenderMode.MaterialOverride` in Unity? Explain its purpose and usage.
VideoRenderMode.MaterialOverride Description Draw the video content into a user-specified property of the current GameObject's material. This mode is simpler to use than VideoRenderMode.RenderTexture . Like RenderTexture, use to show a video on the texture of scene objects like TVs, computers, etc. However, you ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38e1fc17ecd9_doc_2
github
scripting
What does `GetAllInheritedTypes` do in this Unity script? Explain its purpose and signature.
Get all inherited types for Signature: ```csharp public static Type[] GetAllInheritedTypes(Type baseType, Assembly[] assemblies = default, Func<string, bool> ValidateNamespaceFunc = default) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_969613fd107b
unity_docs
rendering
In Unity's 'SketchUp Import Settings window reference', what is 'SketchUp section' and how does it work?
To import a SketchUp file directly into Unity, drag it into the Assets folder using the Finder (macOS) or the File Manager (Windows). Then select the Asset file from the Project view inside the Unity Editor. Property: Function: Generate Back Face Generate back-facing polygons in Unity. By default, Unity only imports th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_326957c6a82e
unity_docs
rendering
What is `ParticleSystem.SetMaximumPreMappedBufferCounts` in Unity? Explain its purpose and usage.
ParticleSystem.SetMaximumPreMappedBufferCounts Declaration public static void SetMaximumPreMappedBufferCounts (int vertexBuffersCount , int indexBuffersCount ); Parameters Parameter Description vertexBuffersCount The maximum number of cached vertex buffers. indexBuffersCount The maximum number of cached ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_da9163bc2010
unity_docs
rendering
What is `Camera.scene` in Unity? Explain its purpose and usage.
Camera.scene public SceneManagement.Scene scene ; Description If not null, the camera will only render the contents of the specified Scene. Currently, only Scenes created by EditorSceneManager.NewPreviewScene are supported.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17d19ecaf31d
unity_docs
editor
Show me a Unity C# example demonstrating `Editor.RenderStaticPreview`.
his method if you want to render a static preview. When overridden RenderStaticPreview can be used to render a list of assets converted into a single texture. This function will need user supplied source code that can merge the assets together. The size of the create texture can be supplied by the provided width ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ed7be4c0aa97
unity_docs
scripting
Explain 'Windows' in Unity.
Develop games and applications for the Windows platform. For information on getting started with Windows, refer to the following sections: Page Description Requirements and compatibility Check the supported versions and compatibility information before you start developing for Windows. Integrate Unity into Windows and ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_050c72576e45
unity_docs
animation
What is `AnimationMode.SampleAnimationClip` in Unity? Explain its purpose and usage.
AnimationMode.SampleAnimationClip Declaration public static void SampleAnimationClip ( GameObject gameObject , AnimationClip clip , float time ); Parameters Parameter Description gameObject The root GameObject for the animation. clip The AnimationClip to sample. time The time at which to sample....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f483e833223
unity_docs
rendering
What is `WebCamDevice.availableResolutions` in Unity? Explain its purpose and usage.
WebCamDevice.availableResolutions public Resolution[] availableResolutions ; Description Possible WebCamTexture resolutions for this device. Available on iOS and Android only. Returns null for other platforms. Note: For webcams with depth data support (those of kind WebCamKind.ColorAndDepth ) this array...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f96c66af779
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.ChangeSetDescription`.
public static VersionControl.Task ChangeSetDescription ( VersionControl.ChangeSet changeset ); Parameters Parameter Description changeset Changeset to query description of. Description Given a changeset only containing the changeset ID, this will start a task for quering the description of the changeset. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67f72449af79
unity_docs
physics
What is `MonoBehaviour.OnCollisionExit2D` in Unity? Explain its purpose and usage.
MonoBehaviour.OnCollisionExit2D(Collision2D) Parameters Parameter Description other The Collision2D data associated with this collision. Description Sent when a collider on another object stops touching this object's collider (2D physics only). Further information about the objects involved is reported in the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_fa3771bd978d
unity_docs
rendering
In Unity's 'Additional Search filters', what is 'Type Filters' and how does it work?
These filters are available if the index uses the Types Indexing option (See Index Manager ). Filter Search token Description Type t:<Asset Type> t:texture Searches all Assets containing texture in their type name (ex: Texture2D, Texture). t:prefab Searches all prefab assets. Type <Asset Type> You can search Assets by ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52a7058ac9ed
unity_docs
scripting
Show me a Unity C# example demonstrating `Input.acceleration`.
Input.acceleration public static Vector3 acceleration ; Description Last measured linear acceleration of a device in three-dimensional space. (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...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_96ca596aa528
unity_docs
performance
Show me a Unity C# example demonstrating `Unity.Collections.LowLevel.Unsafe.NativeContainerAttribute`.
container incorrectly, it might crash Unity without throwing an exception. You can also use the Collections package to create a registered custom allocator to allocate your own custom container. For more information, see the Collections documentation on [Custom allocators](https://docs.unity3d.com/Packages/com.unity.c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_38b68e1a941d
unity_docs
scripting
Show me a Unity code example for 'Create TreeView with IMGUI'.
then use SetupDepthsFromParentsAndChildren to set the the parent and children references. ## Examples To view the Project and source code for the examples shown below, download TreeViewExamples.zip . ## Example 1: A simple TreeView To create a TreeView, create a class that extends the TreeView class and implement t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cda22cd89069
unity_docs
rendering
What is `Lightmapping.buildProgress` in Unity? Explain its purpose and usage.
Lightmapping.buildProgress public static float buildProgress ; Description Returns the current lightmapping build progress or 0 if Lightmapping.isRunning is false. The returned range is 0 to 1.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f51324594066
unity_docs
physics
In Unity's 'Search your project and scenes', what is 'Results examples' and how does it work?
To demonstrate the differences between the providers, consider the following example: In a scene with a single GameObject named Dry5818 , based on a prefab of the same name: Provider Query example Results Hierarchy h: Dry5818 GameObjects in the scene that have Dry5818 in their name. Project p: Dry5818 Assets in the Pro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_79d6b6e881c1
unity_docs
rendering
Explain 'Rendering Profiler module reference' in Unity.
The Rendering Profiler displays rendering statistics and information about what the CPU and GPU do to render the Scene . You can use these statistics to measure the resource intensity of different areas of the Scene, which is useful for optimization. To open the Profiler window, go to menu: Window > Analysis > Profiler...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ed67bbca516
unity_docs
math
What is `Rendering.BatchCullingContext.splitExclusionMask` in Unity? Explain its purpose and usage.
BatchCullingContext.splitExclusionMask public ushort splitExclusionMask ; Description A bitmask that represents the BatchCullingContext.cullingSplits Unity ignores in a BatchDrawCommand struct. The bitmask is 8 bits. A bit value of 1 means Unity ignores the culling split. The least significant bit correspon...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aa4d74daba18
unity_docs
scripting
What is `PropertyDrawer.GetPropertyHeight` in Unity? Explain its purpose and usage.
PropertyDrawer.GetPropertyHeight Declaration public float GetPropertyHeight ( SerializedProperty property , GUIContent label ); Parameters Parameter Description property The SerializedProperty to make the custom GUI for. label The label of this property. Returns float The height in pixels. Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5a745dbafe66
unity_docs
performance
Show me a Unity code example for 'Introduction to NativeContainer'.
tance, it has both read and write access. This configuration can slow performance. This is because the job system doesn’t allow you to schedule a job that has write access to a NativeContainer instance at the same time as another job that’s writing to it. However, If a job doesn’t need to write to a NativeContainer ins...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0727281e95db
unity_docs
scripting
Show me a Unity C# example demonstrating `LightTransport.EventID`.
ed to an operation, it cannot be reused. Must be destroyed: Use IDeviceContext.DestroyEvent to prevent resource leaks. Thread-safe: Can be queried from different threads. EventIDs are commonly used with: IDeviceContext.ReadBuffer and IDeviceContext.WriteBuffer operations. IDeviceContext.Wait for blocking unt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_25079a47b12e
unity_docs
math
What is `Rendering.CommandBuffer.SetComputeVectorParam` in Unity? Explain its purpose and usage.
CommandBuffer.SetComputeVectorParam Declaration public void SetComputeVectorParam ( ComputeShader computeShader , string name , Vector4 val ); Declaration public void SetComputeVectorParam ( ComputeShader computeShader , int nameID , Vector4 val ); Parameters Parameter Description computeShader...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_45963696ea72
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.R4G4B4A4_UNormPack16` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.R4G4B4A4_UNormPack16 Description A four-component, 16-bit packed unsigned normalized format that has a 4-bit R component in bits 12..15, a 4-bit G component in bits 8..11, a 4-bit B component in bits 4..7, and a 4-...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab8e9bb1f9dd
unity_docs
math
Show me a Unity C# example demonstrating `EditorPrefs.GetBool`.
EditorPrefs.GetBool Declaration public static bool GetBool (string key ); Declaration public static bool GetBool (string key , bool defaultValue = false); Description Returns the value corresponding to key in the preference file if it exists. If it doesn't exist, it will return defaultValue . Round ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c464aa837f2
unity_docs
editor
What is `EditorUtility.IsUnityExtensionsInitialized` in Unity? Explain its purpose and usage.
EditorUtility.IsUnityExtensionsInitialized Declaration public static bool IsUnityExtensionsInitialized (); Description Returns a boolean value which represents the state of initialization of Unity extensions.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32cf07699b67
unity_docs
rendering
What is `Texture.graphicsTexture` in Unity? Explain its purpose and usage.
Texture.graphicsTexture public Rendering.GraphicsTexture graphicsTexture ; Description GraphicsTexture that represents the texture resource uploaded to the graphics device (Read Only). This returns the current GraphicsTexture object corresponding to the Texture. For RenderTextures , this returns the Graphi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.