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_b4173e759069
unity_docs
scripting
Show me a Unity C# example demonstrating `Bounds.extents`.
Bounds.extents public Vector3 extents ; Description The extents of the Bounding Box. This is always half of the size of the Bounds. Note: If Bounds.extents has a negative value for any axis, Bounds.Contains always returns False. ```csharp //Attach this script to a visible GameObject. //Click on the G...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_26ebf454f11e
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchExpressionContext.ResolveAlias`.
If no exeuction frames are present this becomes the default alias to be resolved. expr Default expression to look to resolve the alias. If null, use the runtime to resolve the alias. Returns string Returns a resolved alias. Description Try to resolve an alias value using the SearchExpressionRuntime attached...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_79c8cb2baf36
unity_docs
rendering
What is `LightProbesQuery.ctor` in Unity? Explain its purpose and usage.
LightProbesQuery Constructor Declaration public LightProbesQuery ( Unity.Collections.Allocator allocator ); Parameters Parameter Description allocator Memory allocation context. Description "Constructor for creating Light Probe sample queries."
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_209db776c3b2
unity_docs
rendering
What is `PlayerSettings.SetShaderChunkCountForPlatform` in Unity? Explain its purpose and usage.
PlayerSettings.SetShaderChunkCountForPlatform Declaration public static void SetShaderChunkCountForPlatform ( BuildTarget buildTarget , int chunkCount ); Parameters Parameter Description buildTarget The build target to set the shader chunk count for. chunkCount The maximum number of chunks to keep in me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_27b19a973619
unity_docs
scripting
What is `Apple.FrameCapture.CaptureNextFrameToFile` in Unity? Explain its purpose and usage.
FrameCapture.CaptureNextFrameToFile Declaration public static void CaptureNextFrameToFile (string path ); Description Begin capture to the specified file at the beginning of the next frame, and end it at the end of the next frame. This is the same as calling FrameCapture.BeginCaptureToFile and FrameCapture....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d172d61c0051
unity_docs
editor
What are the parameters of `EditorGUI.RectField` in Unity?
Returns Rect The value entered by the user. Description Makes an X, Y, W, and H field for entering a Rect . Rect field in an Editor Window. ```csharp using UnityEngine; using UnityEditor;// Find all the cameras in the Scene and shows all their viewports togheterclass EditorGUIRectField : EditorWindow { Camera[] cam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cd8deaec75ab
unity_docs
editor
What is `AndroidJNI.UnregisterNatives` in Unity? Explain its purpose and usage.
AndroidJNI.UnregisterNatives Declaration public static int UnregisterNatives (IntPtr clazz ); Returns int Zero on success, negative value on error. Falsely succeeds in Editor. Description Unregisters native methods of a class. The class goes back to the state before it was linked or registered with its na...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3136de65c051
unity_docs
editor
Show me a Unity C# example demonstrating `Callbacks.PostProcessBuildAttribute`.
PostProcessBuildAttribute class in UnityEditor.Callbacks / Inherits from: CallbackOrderAttribute Description Add this attribute to a method to get a notification just after building the player. ```csharp // C# example: using UnityEngine; using UnityEditor; using UnityEditor.Callbacks;public class MyBuildPostpro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04ede7a86cb1
unity_docs
physics
Show me a Unity C# example demonstrating `PhysicsShapeGroup2D.Add`.
eGroup2D.Add Declaration public void Add ( PhysicsShapeGroup2D physicsShapeGroup ); Parameters Parameter Description physicsShapeGroup The PhysicsShapeGroup2D to add to this shape group. (Read Only) Description Adds a copy of all the PhysicsShape2D and their geometry from the specified physicsShapeGr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ebc0a8b8001c
unity_docs
math
What is `TerrainTools.PaintDetailsToolUtility.ClampedDetailPatchesGUI` in Unity? Explain its purpose and usage.
PaintDetailsToolUtility.ClampedDetailPatchesGUI Declaration public static int ClampedDetailPatchesGUI ( Terrain terrain , out Vector2 detailMinMaxHeight , out List<Vector4> clampedDetailPatchIconScreenPositions ); Parameters Parameter Description terrain The target terrain. detailMinMaxHeight The mini...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e3d5d11c09a
unity_docs
animation
What is `AnimationCurve.Linear` in Unity? Explain its purpose and usage.
AnimationCurve.Linear Declaration public static AnimationCurve Linear (float timeStart , float valueStart , float timeEnd , float valueEnd ); Parameters Parameter Description timeStart The start time for the linear curve. valueStart The start value for the linear curve. timeEnd The end time for the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a7b2590b1134
unity_docs
rendering
What is `ParticleSystem.SizeBySpeedModule` in Unity? Explain its purpose and usage.
SizeBySpeedModule struct in UnityEngine / Implemented in: UnityEngine.ParticleSystemModule Description Script interface for the SizeBySpeedModule. This module controls the size of particles based on their speeds. Additional resources: ParticleSystem , ParticleSystem.sizeBySpeed . Properties Property Descr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e1f0ad20d4b
unity_docs
ui
What is `UIElements.ToolbarButton.ctor` in Unity? Explain its purpose and usage.
ToolbarButton Constructor Declaration public ToolbarButton ( Unity.Android.Gradle.Manifest.Action clickEvent ); Parameters Parameter Description clickEvent The action to be called when the button is pressed. Description Constructor. Declaration public ToolbarButton (); Description Constructor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7f9253104821
unity_docs
rendering
Give me an overview of the `LODFadeMode` class in Unity.
LODFadeMode enumeration Description The LOD (level of detail) fade modes. Modes other than LODFadeMode.None will result in Unity calculating a blend factor for blending/interpolating between two neighbouring LODs and pass it to your shader. Properties Property Description None Indicates the LOD fading is turn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f117546173df
unity_docs
scripting
What is `AI.NavMeshAgent.hasPath` in Unity? Explain its purpose and usage.
NavMeshAgent.hasPath public bool hasPath ; Description Does the agent currently have a path? (Read Only) This property will be true if the agent has a path calculated to the desired destination and false otherwise. Additional resources: pathPending.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b3b7d538e845
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGB_A1_ETC2_SRGB` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGB_A1_ETC2_SRGB Description A four-component, ETC2 compressed format where each 64-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGB texel data with sRGB nonlinear encoding, and provide...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_458ba593ed58
unity_docs
rendering
What is `TerrainData.enableHolesTextureCompression` in Unity? Explain its purpose and usage.
TerrainData.enableHolesTextureCompression public bool enableHolesTextureCompression ; Description Enable the Terrain holes Texture compression. Set to true to compress the Terrain holes Texture. This property takes effect only at runtime, and is true by default. Terrain holes Textures are never compressed i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6d3e0eda8244
unity_docs
scripting
In Unity's 'Migrating from MovieTexture to VideoPlayer', what is 'VideoPlayer' and how does it work?
```csharp using UnityEngine; public class DownloadMovieVP : MonoBehaviour { void Start() { var vp = gameObject.AddComponent<UnityEngine.Video.VideoPlayer>(); vp.url = "https://myserver.com/mymovie.mp4"; vp.isLooping = true; vp.renderMode = UnityEngine.Video.VideoRenderMode.MaterialOverride; vp.targetMaterialRe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf84802347b6
unity_docs
scripting
What is `RuntimePlatform.PS4` in Unity? Explain its purpose and usage.
RuntimePlatform.PS4 Description In the player on the Playstation 4. Additional resources: RuntimePlatform , Platform dependent compilation . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { if (Application.platform == RuntimePlatform.PS4) { Debug.Log("Do something special he...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d13c8dee8941
unity_docs
scripting
In Unity's 'Create a new keystore', what is 'Choose the keystore location' and how does it work?
You can create a new keystore anywhere on your computer, however there are two special locations: the Project folder and what is called the keystores dedicated location. If you place a keystore in either of these places, Unity saves a relative path to the keystore. Otherwise Unity saves an absolute path to the keystore...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_52cdb4eddbc6
unity_docs
rendering
In Unity's 'Configure lightmapping with a Lighting Settings Asset', what is 'Creating a Lighting Settings Asset' and how does it work?
There are two ways to create a Lighting Settings Asset in the Unity Editor. To create a Lighting Settings Asset from the Project view: In the Project view, either click the add (+) button, or open the context menu and navigate to Create . Click Lighting Settings . Unity creates a new Lighting Settings Asset in the Proj...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e84597d927b3
unity_docs
scripting
What is `Events.UnityEventTools.AddStringPersistentListener` in Unity? Explain its purpose and usage.
UnityEventTools.AddStringPersistentListener Declaration public static void AddStringPersistentListener ( Events.UnityEventBase unityEvent , UnityAction<string> call , string argument ); Parameters Parameter Description unityEvent Event to modify. call Function to call. argument Argument to use when in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_12fd089ad28e
unity_docs
scripting
What is `DetailInstanceTransform.posZ` in Unity? Explain its purpose and usage.
DetailInstanceTransform.posZ public float posZ ; Description The Z coordinate of the detail object in the Terrain's local space. To get the Z in world space, add this value to position Z of the Terrain.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_46c1a8232e88
unity_docs
scripting
What is `Event.GetEventCount` in Unity? Explain its purpose and usage.
Event.GetEventCount Declaration public static int GetEventCount (); Returns int Current number of events currently in the event queue. Description Returns the current number of events that are stored in the event queue.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ff6613a5a58
unity_docs
performance
What is `Unity.Jobs.LowLevel.Unsafe.JobsUtility.ThreadIndexCount` in Unity? Explain its purpose and usage.
JobsUtility.ThreadIndexCount public static int ThreadIndexCount ; Description Gets the maximum number of job workers that can work on a job at the same time. The job system creates a number of job worker threads no greater than the number of logical CPU cores for the platform. However, because arbitrary thread...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8640d0fd2600
unity_docs
rendering
What is `GUI.Box` in Unity? Explain its purpose and usage.
GUI.Box Declaration public static void Box ( Rect position , string text ); Declaration public static void Box ( Rect position , Texture image ); Declaration public static void Box ( Rect position , GUIContent content ); Declaration public static void Box ( Rect position , string text , ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c91c60174a21
unity_docs
editor
What are the parameters of `PrefabUtility.UnpackAllInstancesOfPrefab` in Unity?
Description Unpacks all instances of a given Prefab Asset root GameObject in all open scenes so that all instances are replaced with the contents of the Prefab Asset while retaining all override values. The Prefab instances will not be unpacked in closed scenes. This function uses PrefabUtility.FindAllInstancesOfPrefab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_6655e428c769
github
scripting
Write a Unity Editor script for Curve Picker GUI
```csharp using System; using System.Collections.Generic; using UnityEditor; using UnityEditor.Graphs; using UnityEngine; namespace CurvePickerTool { public class CurvePickerGUI { private bool isInitialze = false; private GridDrawer gridDrawer; private CurveDrawer curveDrawer; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2f6115b3ed9c
unity_docs
rendering
In Unity's 'Dedicated Server Player settings', what is 'API Compatibility Level' and how does it work?
You can choose your mono API compatibility level for all targets. Sometimes a third-party .NET library uses functionality that’s outside of your .NET compatibility level. To understand what’s going on in such cases, and how to best fix it, try following these suggestions: Install ILSpy for Windows. Drag the .NET assemb...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_537fe7b1a4a2
unity_docs
scripting
What is `AndroidJNI.SetStaticCharField` in Unity? Explain its purpose and usage.
AndroidJNI.SetStaticCharField Declaration public static void SetStaticCharField (IntPtr clazz , IntPtr fieldID , char val ); Description Sets the value of a static field in the specified object. 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_5592051bb7dc
unity_docs
rendering
What is `Accessibility.VisionUtility.GetColorBlindSafePalette` in Unity? Explain its purpose and usage.
VisionUtility.GetColorBlindSafePalette Declaration public static int GetColorBlindSafePalette (Color[] palette , float minimumLuminance , float maximumLuminance ); Parameters Parameter Description palette An array of colors to populate with a palette. minimumLuminance Minimum allowable perceived luminanc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50addf702e6b
unity_docs
math
What is `Windows.File.WriteAllBytes` in Unity? Explain its purpose and usage.
File.WriteAllBytes Declaration public static void WriteAllBytes (string path , byte[] bytes ); Parameters Parameter Description path The file to write to. bytes The bytes to write to the file. Description Creates a new file, writes the specified byte array to the file, and then closes the file. If the t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b2f96d651774
unity_docs
performance
What is `ContactPair.CopyToNativeArray` in Unity? Explain its purpose and usage.
ContactPair.CopyToNativeArray Declaration public void CopyToNativeArray (NativeArray<ContactPairPoint> buffer ); Parameters Parameter Description buffer A native buffer that will be filled with ContactPairPoint data. Description Copies the internal ContactPairPoint buffer to the provided buffer .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c55044d51f01
unity_docs
rendering
Explain 'Cinematic Studio feature set' in Unity.
Important: Support for the Cinematic Studio feature set is scheduled to end in an upcoming release. Enable the creation of films, TV shows, and other animated linear content: Organize, assemble, edit and swap your assets in a structured sequence hierarchy. Automate complex camera movements and camera shot transitions. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f349989f5a9e
unity_docs
scripting
What is `SerializedProperty.enumValueFlag` in Unity? Explain its purpose and usage.
SerializedProperty.enumValueFlag public int enumValueFlag ; Description Int32 representation of an enum property with Mixed Values. Additional resources: propertyType , SerializedPropertyType.Enum , enumNames .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_91cd2862e759
unity_docs
math
Show me a Unity C# example demonstrating `Search.QueryFilterOperator`.
QueryFilterOperator struct in UnityEditor.Search Description A QueryFilterOperator defines a boolean operator between a value returned by a filter and an operand inputted in the search query. You get an object of this type whenever you add a new operator on a QueryEngine or IQueryEngineFilter . ```csharp usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_60e06f07c6dd
github
scripting
Write a Unity C# ScriptableObject for Gaussian Splat Asset
```csharp // SPDX-License-Identifier: MIT using System; using Unity.Collections.LowLevel.Unsafe; using Unity.Mathematics; using UnityEngine; using UnityEngine.Experimental.Rendering; namespace GaussianSplatting.Runtime { public class GaussianSplatAsset : ScriptableObject { public const int kCurrentVer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_df7333c20f45
unity_docs
physics
Explain 'Set fixed timestep to optimize physics simulation frequency' in Unity.
Adjust the fixed timestep value to optimize physics simulation performance. The physics system updates at a fixed time interval , which is important for accurate and consistent physics simulations. Configuring this frequency impacts the runtime performance of your project. To review available project Time settings in t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_973b3c54b44d
unity_docs
xr
Show me a Unity C# example demonstrating `LightTransport.BakeProgressState.Cancel`.
to react to the request and terminate the operation. Cancellation Behavior: - The cancellation request is cooperative - operations must check for cancellation. - Not all operations support cancellation. - Cancellation may take time to take effect. - Use WasCancelled to check if cancellation was requested. Note: Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7fd6bcbc30d8
unity_docs
editor
Show me a Unity C# example demonstrating `VersionControl.Provider.GetAssetByGUID`.
Provider.GetAssetByGUID Declaration public static VersionControl.Asset GetAssetByGUID (string guid ); Parameters Parameter Description guid GUID of asset. Description Returns version control information about an asset from a given GUID. Returns null if the GUID is not known by the Unity Editor. ```csha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_418189c82538
unity_docs
input
In Unity's 'GUI Style (IMGUI System)', what is 'Properties' and how does it work?
Property: Function: Name The text string that can be used to refer to this specific Style Normal Background image & Text Color of the Control in default state Hover Background image & Text Color when the mouse is positioned over the Control Active Background image & Text Color when the mouse is actively clicking the Co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a91660934092
unity_docs
xr
In Unity's 'Search for files', what is 'Glob wildcards' and how does it work?
You can use a glob queries and C# Regex to match patterns. Global wildcards Description Example Matches Doesn’t match Equivalent regex * Matches any number of any characters including none Law* Law , Laws , Lawyer Groklaw , La , aw .* . Matches any single character including none Law. Law , Laws , Lawyer Groklaw , La ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_30f4315927fc
unity_docs
physics
In Unity's 'Advanced Text Generator', what is 'In UI Builder' and how does it work?
To use Advanced Text Generator in UI Builder, do the following: Select the visual element that you want to apply to. In the Inspector panel, select Inlined Styles > Text . From the Text Generator Type dropdown, select Advanced .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_904d799f1505
unity_docs
editor
What is `iOS.Xcode.PBXProject.WriteToFile` in Unity? Explain its purpose and usage.
PBXProject.WriteToFile Declaration public void WriteToFile (string path ); Parameters Parameter Description path Path to write the project contents to. Description Writes the project contents to the specified file. ```csharp using UnityEditor; using System.IO; using UnityEditor.Callbacks; using UnityEdito...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1f5773316bc4
unity_docs
scripting
Explain 'Create and view a Particle System' in Unity.
The Built-in Particle System uses a component, so placing a Particle System in a Scene is a matter of adding a pre-made GameObject (menu: GameObject > Effects > Particle System ) or adding the component to an existing GameObject (menu: Component > Effects > Particle System ). Because the component is quite complicated,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_edd854ccf277
unity_docs
physics
What is `AI.NavMeshQueryFilter` in Unity? Explain its purpose and usage.
NavMeshQueryFilter struct in UnityEngine.AI / Implemented in: UnityEngine.AIModule Description Specifies which agent type and areas to consider when searching the NavMesh. This struct is used with the NavMesh query methods overloaded with the query filter argument. Additional resources: NavMesh.CalculatePath ,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_18b65a86ecbe
unity_docs
rendering
What is `Rendering.RayTracingShader.SetInt` in Unity? Explain its purpose and usage.
RayTracingShader.SetInt Declaration public void SetInt (int nameID , int val ); Declaration public void SetInt (string name , int val ); Parameters Parameter Description name The name of the property being set. nameID The ID of the property as given by Shader.PropertyToID. val The int value to set...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_31506c12012f
unity_docs
scripting
What is `Search.PropertyDatabase.InvalidateMask` in Unity? Explain its purpose and usage.
PropertyDatabase.InvalidateMask Declaration public void InvalidateMask (ulong documentKeyMask ); Parameters Parameter Description documentKeyMask A document key mask. Description Invalidate all properties stored from multiple documents that match a document key mask. This operation is slower than the simp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f24003dc736
unity_docs
math
What is `RectInt.SetMinMax` in Unity? Explain its purpose and usage.
RectInt.SetMinMax Declaration public void SetMinMax ( Vector2Int minPosition , Vector2Int maxPosition ); Description Sets the bounds to the min and max value of the rect. Use this function to set both the minimum and maximum value of the RectInt at the same time, faster than setting the values separa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ff8a935fcd0e
unity_docs
rendering
Explain 'Bumped Diffuse' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces this shader . ## Normal Mapped Properties Like a Diffuse shader, this computes a simple (Lambertian) lighting model. The lighting on the surface decreases as the angle between it and the light decreases. The lighting depends only on the angle, and does not c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f4349e33b54
unity_docs
physics
What is `ModifiableContactPair.SetSeparation` in Unity? Explain its purpose and usage.
ModifiableContactPair.SetSeparation Declaration public void SetSeparation (int i , float separation ); Parameters Parameter Description i Index of the contact point. separation The separation at a contact point. Description Set the separation value at a particular contact point in this contact pair. Se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_08924184ed74_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A based class that will automatically set its with a When deriving from , fields and properties with will automatically be set on the .Properties are automatically updated upon Awake(), Start(), Reset() and OnValidate(). To enable animated properties, or force update, call . Signature: ```csharp public abstract cla...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_dacd65224bb3
unity_docs
ui
Explain 'Deploy a UWP application' in Unity.
To deploy your Universal Windows Platform (UWP) application, you first need to build your project . After Unity generates your Visual Studio solution, you can deploy your application. For more information, refer to Microsoft documentation on deploying UWP apps from Visual Studio . Use the following steps to deploy your...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86ee39c61b41
unity_docs
rendering
What are the parameters of `AssetDatabase.CopyAsset` in Unity?
Returns bool Returns true if the copy operation is successful or false if part of the process fails. Description Duplicates the asset at path and stores it at newPath . All paths are relative to the project folder, for example: "Assets/MyTextures/hello.png". ```csharp using UnityEngine; using UnityEditor;public class A...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e2aeeca86d7
unity_docs
rendering
What is `ParticleSystemMeshShapeType` in Unity? Explain its purpose and usage.
ParticleSystemMeshShapeType enumeration Description The mesh emission type. Properties Property Description Vertex Emit from the vertices of the mesh. Edge Emit from the edges of the mesh. Triangle Emit from the surface of the mesh.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bbf0cfcb3c7e
unity_docs
rendering
In Unity's 'Introduction to Dynamic Resolution', what is 'Render pipeline compatibility' and how does it work?
Dynamic resolution support depends on which render pipeline your project uses. Feature Universal Render Pipeline (URP) High Definition Render Pipeline (HDRP) Built-in Render Pipeline Dynamic resolution Yes (1) Yes (2) Yes (1) Notes : The Built-in Render Pipeline , and the Universal Render Pipeline (URP) both support dy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_946fd44deba6
unity_docs
performance
What is `Unity.Jobs.JobHandle.ScheduleBatchedJobs` in Unity? Explain its purpose and usage.
JobHandle.ScheduleBatchedJobs Declaration public static void ScheduleBatchedJobs (); Description Makes Schedule methods available to worker threads. By default, jobs are only put on a local queue when using job Schedule methods. ScheduleBatchedJobs makes them available to the worker threads to execute. The ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3215f518b61
unity_docs
input
What is `TouchScreenKeyboard.inputFieldAppearance` in Unity? Explain its purpose and usage.
TouchScreenKeyboard.inputFieldAppearance public static TouchScreenKeyboard.InputFieldAppearance inputFieldAppearance ; Description Returns the current visibility status of the on-screen keyboard's input field. (Read Only) The input field can be always visible, always hidden, or customizable. If the input fiel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_727a6a9db112
unity_docs
rendering
What is `Material.IsPropertyLockedByAncestor` in Unity? Explain its purpose and usage.
Material.IsPropertyLockedByAncestor Declaration public bool IsPropertyLockedByAncestor (string name ); Declaration public bool IsPropertyLockedByAncestor (int nameID ); Parameters Parameter Description nameID Property name ID, use Shader.PropertyToID to get it. name Property name, e.g. "_SrcBlend"....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b93e8a5d1e44
unity_docs
rendering
What is `Lightmapping.ClearLightingDataAsset` in Unity? Explain its purpose and usage.
Lightmapping.ClearLightingDataAsset Declaration public static void ClearLightingDataAsset (); Description For the currently loaded Scenes, this method deletes the Lighting Data Asset and any linked lightmaps and Reflection Probe assets.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d665b6b6edc
unity_docs
performance
What is `Experimental.Rendering.ExternalGPUProfiler.EndGPUCapture` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ExternalGPUProfiler.EndGPUCapture Declaration public static void EndGPUCapture (); Description Ends the current GPU frame capture in the external GPU profiler.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c8606e54889f
unity_docs
rendering
What is `ParticleSystem.Particle` in Unity? Explain its purpose and usage.
Particle struct in UnityEngine / Implemented in: UnityEngine.ParticleSystemModule Description Script interface for a Particle. Additional resources: ParticleSystem , ParticleSystem.GetParticles , ParticleSystem.SetParticles . Properties Property Description angularVelocity The angular velocity of the pa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64844be7e23a
unity_docs
editor
Show me a Unity C# example demonstrating `PrefabUtility.SaveAsPrefabAsset`.
milar problem in the case of preserving references to existing Components when you save over an existing Prefab, if a single GameObject within the Prefab has more than one of the same Component type attached. In this case you cannot predict which of them will be matched to the existing references. Additional resources:...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_884a974cffaa
unity_docs
editor
What is `InSceneAssetInformation` in Unity? Explain its purpose and usage.
InSceneAssetInformation struct in UnityEditor Description Provides information related to an in-scene asset collected during a InSceneAssetUtility.CollectInSceneAssets call. Additional resources: InSceneAssetUtility . Properties Property Description inSceneAsset The collected in-scene asset. referencingOb...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0f71a393601f
unity_docs
rendering
Explain 'Shadow casting shader example in the Built-In Render Pipeline' in Unity.
Our shader currently can neither receive nor cast shadows. Let’s implement shadow casting first. In order to cast shadows, a shader has to have a ShadowCaster pass type in any of its subshaders or any fallback . The ShadowCaster pass is used to render the object into the shadowmap, and typically it is fairly simple - t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_730a4298293d
unity_docs
editor
Explain 'Set up your environment for UWP' in Unity.
To create a Unity application for Universal Windows Platform (UWP), you first need to set up your Unity project to support UWP. To support UWP, a Unity project requires the UWP Build Support module. Before you get started, check UWP Requirements and compatibility to make sure you’re aware of any limitations for develop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca75c19e9bb1
unity_docs
scripting
What is `Application.genuineCheckAvailable` in Unity? Explain its purpose and usage.
Application.genuineCheckAvailable public static bool genuineCheckAvailable ; Description Returns true if application integrity can be confirmed. Otherwise returns false. Note : Use Application.genuineCheckAvailable along with Application.genuine to verify app integrity. Accessing the Application.genuine p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_97e53f9fcc07_doc_3
github
scripting
What does `GetActiveSceneInstance` do in this Unity script? Explain its purpose and signature.
Returns singleton instance related to currently active scene.Singleton instance. Value is never null unless application is closing. Signature: ```csharp public static T GetActiveSceneInstance() ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_b43ccf9eac6f
unity_docs
rendering
In Unity's 'Web Player settings', what is 'Resolution' and how does it work?
You can customize the screen mode and default size of the Web canvas element by editing the following options: Setting Function Default Canvas Width Set the width of the Web canvas element. Default Canvas Height Set the height of the Web canvas element. Run In Background Enable this option to allow your content to cont...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_426f7ffa4e67
unity_docs
scripting
Explain 'Reference type management' in Unity.
Because all non-null reference-type objects and all boxed value-typed objects in managed code must be allocated on the managed heap, these objects might be the cause of performance issues in your application. The following sections outline approaches you can take to improve the performance of your code. ## Avoid repea...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f6efe3995e2
unity_docs
rendering
What is `TerrainLayer.diffuseRemapMin` in Unity? Explain its purpose and usage.
TerrainLayer.diffuseRemapMin public Vector4 diffuseRemapMin ; Description A Vector4 value specifying the minimum RGBA value that the diffuse texture maps to when the value of the channel is 0.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c29725536ba3
unity_docs
rendering
Show me a Unity C# example demonstrating `AssetImporters.AssetImportContext.GetOutputArtifactFilePath`.
ed by Unity and stores the preview data of the imported Main Object. The following example shows how to add an Artifact File for a TextureImporter AssetPostprocessor to save the color of the first pixel of the texture inside an ArtifactFile. See AssetImportContext.GetArtifactFilePath to see how this information can b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0fcd274f315
unity_docs
editor
What is `AssetDatabase.LoadAllAssetsAtPath` in Unity? Explain its purpose and usage.
AssetDatabase.LoadAllAssetsAtPath Declaration public static Object[] LoadAllAssetsAtPath (string assetPath ); Parameters Parameter Description assetPath Filesystem path to the asset. Returns Object[] Returns an array of all assets at assetPath . Description Obtains an array of all assets at assetPa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_653faa3309cf
unity_docs
rendering
In Unity's 'Introduction to shaders', what is 'Terminology' and how does it work?
The terminology around shaders can be confusing; people commonly use the word “shader” to mean different things. In this documentation, the terminology is as follows: shader or shader program - a program that runs on a GPU. Unless otherwise specified, this means shader programs that are part of the graphics pipeline. S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_290ad41c3d06
unity_docs
animation
Show me a Unity C# example demonstrating `AnimationUtility.GetObjectReferenceCurveBindings`.
rence properties are animatable. Unity has two types of animation: float curve and object reference curve. A float curve is a classic curve that animates a float property over time. An object reference curve is a construct that animates an object reference property over time. This method only retrieves the object refer...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_34ec78b32477
unity_docs
editor
In Unity's 'Define logging levels', what is 'In Unity Editor windows' and how does it work?
You can set logging levels from the More (⋮) menu in a Unity Editor window that supports data binding, such as UI Builder, Scene view, Game view, and the PanelSettings’s Inspector windows. To set logging levels: Open the More (⋮) menu in the Unity Editor window. Select Binding Console Logs . Choose one of the logging l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51c7e69f31d7
unity_docs
rendering
What is `ParticleSystem.MinMaxGradient.colorMin` in Unity? Explain its purpose and usage.
ParticleSystem.MinMaxGradient.colorMin public Color colorMin ; Description Set a constant color for the lower bound. Useful when ParticleSystem.MinMaxGradient.mode is set to ParticleSystemGradientMode.TwoColors .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60e9bae047f7
unity_docs
input
What is `HDROutputSettings.minToneMapLuminance` in Unity? Explain its purpose and usage.
HDROutputSettings.minToneMapLuminance public int minToneMapLuminance ; Description Minimum input luminance at which gradation is identifiable. Measured in nits. This value is -1 if Unity cannot obtain a value from the HDR display. Accessing this member results in an exception if HDR is not available on the disp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ee35df991f3
unity_docs
math
What is `Screen.resolutions` in Unity? Explain its purpose and usage.
Screen.resolutions public static Resolution[] resolutions ; Description Returns all full-screen resolutions that the monitor supports (Read Only). Unity dynamically returns the supported resolutions for the monitor on which the application window is currently displayed, sorting them first by width and then by a...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b031e9f7296e
unity_docs
math
What is `AndroidJNI.CallCharMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallCharMethod Declaration public static char CallCharMethod (IntPtr obj , IntPtr methodID , jvalue[] args ); Description Calls a Java instance method defined by methodID , optionally passing an array of arguments ( args ) to the method. Additional resources: Java Native Interface Specification ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9f2bb172525c
unity_docs
animation
What is `Animations.TransformSceneHandle.GetLocalRotation` in Unity? Explain its purpose and usage.
TransformSceneHandle.GetLocalRotation Declaration public Quaternion GetLocalRotation ( Animations.AnimationStream stream ); Parameters Parameter Description stream The AnimationStream that manages this handle. Returns Quaternion The rotation of the transform relative to the parent. Description Get...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9e8dd8591e21
unity_docs
scripting
What is `UIElements.Experimental.StyleValues.borderTopRightRadius` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StyleValues.borderTopRightRadius public float borderTopRightRadius ; Description The radius of the top-right corner when a rounded rectangle is drawn in the element's box.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_bf5cf5c5d6e1_doc_6
github
scripting
What does `IsRingGrabbing` do in this Unity script? Explain its purpose and signature.
Returns true if the given hand's ring finger tip is closer to the wrist than the ring proximal joint.Hand to check for the required pose.True if the given hand's ring finger tip is closer to the wrist than the ring proximal joint, false otherwise. Signature: ```csharp static bool IsRingGrabbing(XRHand hand) ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_751a9d780676
unity_docs
scripting
Give me an overview of the `AssetPipelineMode` class in Unity.
AssetPipelineMode enumeration Description Selects the Assetpipeline mode to use. Properties Property Description Version1 Use this if you want to use assetpipeline version 1. Version2 Use this if you want to use assetpipeline version 2.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d1b716522fd
unity_docs
math
What is `AndroidJNI.CallStaticStringMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallStaticStringMethod Declaration public static string CallStaticStringMethod (IntPtr clazz , IntPtr methodID , jvalue[] args ); Description Invokes the specified methodID static method on a Java object, optionally passing in an array of arguments ( args ). This is a convenience function that c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c5b418ce1173
unity_docs
math
Show me a Unity C# example demonstrating `LightTransport.BufferSlice_1`.
allocation while maintaining type safety. BufferSlice is commonly used with: IDeviceContext.ReadBuffer and IDeviceContext.WriteBuffer for data transfers. IProbeIntegrator methods for input/output buffer specifications. Memory-efficient batching of related data structures. The slice maintains a reference to the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac066d233fec
unity_docs
editor
What is `GameObjectUtility.GetStaticEditorFlags` in Unity? Explain its purpose and usage.
GameObjectUtility.GetStaticEditorFlags Declaration public static StaticEditorFlags GetStaticEditorFlags ( GameObject go ); Parameters Parameter Description go The GameObject whose flags you are interested in. Returns StaticEditorFlags The static editor flags of the GameObject specified. Description...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e610cbbaf8b0
unity_docs
xr
Show me a Unity C# example demonstrating `Scripting.RequireAttributeUsagesAttribute`.
RequireAttributeUsagesAttribute class in UnityEngine.Scripting / Implemented in: UnityEngine.CoreModule Description Only allowed on attribute types. If the attribute type is marked, then so too will all CustomAttributes of that type. Note that Low and Medium Managed Stripping Levels do not remove any CustomAttr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ae9b8c90ad87
unity_docs
scripting
What is `Playables.PlayableExtensions.IsNull` in Unity? Explain its purpose and usage.
PlayableExtensions.IsNull Declaration public static bool IsNull (U playable ); Parameters Parameter Description playable The Playable used by this operation. Description Returns true if the Playable is null, false otherwise.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d3047fd16edd
unity_docs
physics
Explain 'Hinge Joint component reference' in Unity.
The Hinge Joint groups together two Rigidbodies , constraining them to move like they are connected by a hinge. It is perfect for doors, but can also be used to model chains, pendulums, and other objects that have a similar hinge-like motion. A single Hinge Joint should be applied to a GameObject . The hinge rotates at...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1ef482c542d
unity_docs
math
What is `IMGUI.Controls.MultiColumnHeaderState.visibleColumns` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.visibleColumns public int[] visibleColumns ; Description This is the array of currently visible column indices. This property is the array of column indices of the currently visible columns. The user can toggle visibility on columns using the context menu of the MultiColumnHeader. Additio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6abd1e99506e
unity_docs
editor
What is `iOS.Xcode.PBXProject.GetRealPathsOfAllFiles` in Unity? Explain its purpose and usage.
PBXProject.GetRealPathsOfAllFiles Declaration public IReadOnlyList<string> GetRealPathsOfAllFiles ( iOS.Xcode.PBXSourceTree sourceTree ); Parameters Parameter Description sourceTree The source tree the path is relative to. The default source tree is PBXSourceTree.Source . This does not support the PBXSour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e67607604f81
unity_docs
scripting
What is `ObjectFactory.AddComponent` in Unity? Explain its purpose and usage.
ObjectFactory.AddComponent Declaration public static Component AddComponent ( GameObject gameObject , Type type ); Declaration public static T AddComponent ( GameObject gameObject ); Parameters Parameter Description gameObject The GameObject to add the new component to. type The type of component...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e0b8fb9ffe39
unity_docs
xr
Show me a Unity C# example demonstrating `Networking.DownloadHandlerAssetBundle.ctor`.
bypass the caching system and simply download the AssetBundle from url . If the crc argument is non-zero, then the crc argument will be compared to the checksum of the downloaded data. If the CRCs do not match, an error will be logged, the asset bundle will not be loaded, and assetBundle will return null . If y...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f526ba12391f
unity_docs
math
What is `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.MemClear` in Unity? Explain its purpose and usage.
UnsafeUtility.MemClear Declaration public static void MemClear (void* destination , long size ); Parameters Parameter Description destination A pointer to the start of the memory block you want to clear. Ensure this pointer is valid and that the memory region is correctly allocated. size The number of byt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_295bcb39f99b
unity_docs
scripting
What is `RectTransform.anchoredPosition` in Unity? Explain its purpose and usage.
RectTransform.anchoredPosition public Vector2 anchoredPosition ; Description The position of the pivot of this RectTransform relative to the anchor reference point. The Anchored Position is the position of the pivot of the RectTransform taking into consideration the anchor reference point. The anchor referenc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d7ad828c1e32
unity_docs
physics
What is `Physics.BakeMesh` in Unity? Explain its purpose and usage.
Physics.BakeMesh Declaration public static void BakeMesh (int meshID , bool convex ); Parameters Parameter Description meshID The instance ID of the mesh to bake collision data from. convex A flag to indicate whether to bake convex geometry or not. Description Prepares the mesh for use with a MeshColli...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c373de714fb8_doc_2
github
scripting
What does `ApplyToAll` do in this Unity script? Explain its purpose and signature.
Apply SearchableEditor to all MonoBehaviour flag Signature: ```csharp public bool ApplyToAll => applyToAll; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_73724612dcbc
unity_docs
physics
What is `UnityEngine.ParticleSystemModule` in Unity? Explain its purpose and usage.
UnityEngine.ParticleSystemModule Description The ParticleSystem module implements Unity's Particle System. Classes Class Description IJobParticleSystemExtensions Extension methods for Jobs using the IJobParticleSystem interface. IJobParticleSystemParallelForBatchExtensions Extension methods for Jobs using the I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86d6a26ff2a1
unity_docs
scripting
What is `Search.QueryListBlock.GetPropositions` in Unity? Explain its purpose and usage.
QueryListBlock.GetPropositions Declaration public IEnumerable<SearchProposition> GetPropositions ( Search.SearchPropositionFlags flags ); Parameters Parameter Description flags Flags that can be used to know which type of proposition to yield. Returns IEnumerable<SearchProposition> Propositions. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.