id
stringlengths
15
22
source
stringclasses
2 values
category
stringclasses
12 values
instruction
stringlengths
22
180
response
stringlengths
100
46.1k
system
stringclasses
5 values
local_man_a5d04c3147e6
unity_docs
rendering
Explain 'Access material properties in a script' in Unity.
All the parameters of a material asset that you see in the Inspector window are accessible via script, giving you the power to change or animate how a material works at runtime. This allows you to modify numeric values on the material, change colours, and swap textures dynamically during gameplay. Some of the most comm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_33dc8cdcd452
unity_docs
animation
What is `Animations.AnimationHumanStream.SetGoalLocalPosition` in Unity? Explain its purpose and usage.
AnimationHumanStream.SetGoalLocalPosition Declaration public void SetGoalLocalPosition ( AvatarIKGoal index , Vector3 pos ); Parameters Parameter Description index The AvatarIKGoal that is queried. pos The position of this IK goal. Description Sets the position of this IK goal relative to the root. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4512c421516c
unity_docs
animation
Give me an overview of the `Motion` class in Unity.
Motion class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.AnimationModule Description Base class for AnimationClips and BlendTrees. Motions are used by animation States in the Mecanim StateMachines. Inherited Members Properties Property Description hideFlags Should the object be hid...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_43a804e9deb8
unity_docs
physics
Show me a Unity C# example demonstrating `RaycastHit2D.fraction`.
of 0 and 1 which is a representation of the returned RaycastHit2D.distance result (see code example). If the physics query does not allow specifying an explicit end position or it has a default distance of infinity then the fraction is identical to the returned RaycastHit2D.distance and therefore will not b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58d847b42dca
unity_docs
scripting
What is `UIElements.TextElement` in Unity? Explain its purpose and usage.
TextElement class in UnityEngine.UIElements / Inherits from: UIElements.BindableElement / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IExperimentalFeatures , INotifyValueChanged<T0> , ITextEdition , ITextElementExperimentalFeatures , ITextSelection Description Use this as the supe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fce24b84a9b0
unity_docs
audio
Show me a Unity C# example demonstrating `AudioSource.mute`.
AudioSource.mute public bool mute ; Description Un- / Mutes the AudioSource. Mute sets the volume=0, Un-Mute restore the original volume. ```csharp // Mutes-Unmutes the sound from this object each time the user presses space. using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3804d330d238
unity_docs
math
What is `Mathf.PI` in Unity? Explain its purpose and usage.
Mathf.PI public static float PI ; Description The well-known 3.14159265358979... value (Read Only). The ratio of the circumference of a circle to its diameter. Note that this value is a 32-bit floating point number i.e. a float . Approximately seven digits of precision are provided. ```csharp using UnityEn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9a9e0eca2dfe
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeaderState.Column.headerContent` in Unity? Explain its purpose and usage.
MultiColumnHeaderState.Column.headerContent public GUIContent headerContent ; Description This is the GUIContent that will be rendered in the column header. This can be used to show either text only, icon only or both icon and text in the column header.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_28df2cc85443
unity_docs
scripting
In Unity's 'C# compiler and language version reference', what is 'Record support' and how does it work?
C# 9 init and record support comes with a few caveats. The type System.Runtime.CompilerServices.IsExternalInit is required for full record support as it uses init only setters, but is only available in .NET 5 and later (which Unity doesn’t support). Users can work around this issue by declaring the System.Runtime.Compi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ff18b6d9783
unity_docs
editor
What is `Device.SystemInfo.graphicsDeviceVendor` in Unity? Explain its purpose and usage.
SystemInfo.graphicsDeviceVendor public static string graphicsDeviceVendor ; Description This has the same functionality as SystemInfo.graphicsDeviceVendor and also mimics platform-specific behavior in the Unity Editor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50d102c28600
unity_docs
math
What is `Tilemaps.Tilemap.GetUsedTilesNonAlloc` in Unity? Explain its purpose and usage.
Tilemap.GetUsedTilesNonAlloc Declaration public int GetUsedTilesNonAlloc (TileBase[] usedTiles ); Parameters Parameter Description usedTiles The array to be filled. Returns int The number of Tiles filled. Description Fills the given array with the total number of different Tile s used in the Tilema...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_218dd78fdfa8
unity_docs
rendering
Give me an overview of the `CustomRenderTextureUpdateZone` class in Unity.
CustomRenderTextureUpdateZone struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Structure describing an Update Zone. UpdateZones are used when updating the full custom render texture is not required. They are defined by a position, a size and a rotation inside the surface of the texture...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af1374ad4d32
unity_docs
rendering
Show me a Unity C# example demonstrating `Shader.keywordSpace`.
ded via the Fallback command , and all Passes that are included via the UsePass command . All keywords that Unity adds automatically. For more information, see Unity's predefined shader keywords . This example iterates over the local shader keywords in the local keyword space for a graphics shader. It determines w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bf78826d9034
unity_docs
animation
What is `Animations.AnimationStream.GetInputWeight` in Unity? Explain its purpose and usage.
AnimationStream.GetInputWeight Declaration public float GetInputWeight (int index ); Parameters Parameter Description index The input index. Returns float Returns the weight of the Playable input as a float. Description Gets the weight of the Playable connected at a specific input index. Additio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba4c978f4ca7
unity_docs
rendering
What is `Experimental.GlobalIllumination.Cookie.scale` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Cookie.scale public float scale ; Description The uniform scale factor for downscaling cookies during lightmapping. Can be used as an optimization when full resolution cookies are not needed for indirect lighting.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fd45fd02154f
unity_docs
rendering
What is `AudioRenderer.GetSampleCountForCaptureFrame` in Unity? Explain its purpose and usage.
AudioRenderer.GetSampleCountForCaptureFrame Declaration public static int GetSampleCountForCaptureFrame (); Returns int Number of samples available since last recorded frame. Description Returns the number of samples available since the last time AudioRenderer.Render was called. This is dependent on the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2d18136e6cd2
unity_docs
xr
What is `Camera.RenderRequest` in Unity? Explain its purpose and usage.
Removed RenderRequest struct in UnityEngine / Implemented in: UnityEngine.CoreModule Obsolete The RenderRequest struct is obsolete, use the function overload with RequestData of supported types such as RenderPipeline.StandardRequest. Description A request that can be used for making specific rendering reque...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1628a3e2524
unity_docs
scripting
What is `IMGUI.Controls.TreeView.GetCustomRowHeight` in Unity? Explain its purpose and usage.
TreeView.GetCustomRowHeight Declaration protected float GetCustomRowHeight (int row , IMGUI.Controls.TreeViewItem item ); Parameters Parameter Description row Row index. item Item for given row. Returns float Height of row. Description Override to control individual row heights. Override this m...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4de5998bc5ef
unity_docs
rendering
What is `DefaultLightingExplorerExtension.GetEmissivesColumns` in Unity? Explain its purpose and usage.
DefaultLightingExplorerExtension.GetEmissivesColumns Declaration protected LightingExplorerTableColumn[] GetEmissivesColumns (); Returns LightingExplorerTableColumn[] Column definitions for Emissives. Description Returns column definitions for Emissives.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_29c13b812d59
unity_docs
rendering
What is `ComputeBuffer.GetNativeBufferPtr` in Unity? Explain its purpose and usage.
ComputeBuffer.GetNativeBufferPtr Declaration public IntPtr GetNativeBufferPtr (); Returns IntPtr Pointer to the underlying graphics API buffer. Description Retrieve a native (underlying graphics API) pointer to the buffer. Use this function to retrieve a pointer/handle corresponding to the compute buffer,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_779a462c9deb
unity_docs
editor
What are the parameters of `AssetDatabase.GetAssetBundleDependencies` in Unity?
Returns string[] The names of all AssetBundles that the input depends on. Description Given an assetBundleName , returns the list of AssetBundles that it depends on. ```csharp using System.Text; using UnityEditor; using UnityEngine;public class AssetDatabaseExamples : MonoBehaviour { [MenuItem("AssetDatabase/Find B...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ae74d4b792a
unity_docs
rendering
What is `SystemInfo.supportsRayTracingShaders` in Unity? Explain its purpose and usage.
SystemInfo.supportsRayTracingShaders public static bool supportsRayTracingShaders ; Description Checks if ray tracing shaders are supported by the current system configuration. (Read Only) Ray tracing support depends on the following: operating system support, GPU, graphics drivers and graphics API. In DirectX ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ed8e3cea6b7
unity_docs
editor
What is `PrefabReplacingSettings.changeRootNameToAssetName` in Unity? Explain its purpose and usage.
PrefabReplacingSettings.changeRootNameToAssetName public bool changeRootNameToAssetName ; Description Change the name of the root GameObject to match the name of the Prefab Asset used when replacing the Prefab Asset of a Prefab instance.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8fb20791e9a
unity_docs
rendering
What is `Rendering.DefaultReflectionMode.Skybox` in Unity? Explain its purpose and usage.
DefaultReflectionMode.Skybox Description Skybox-based default reflection. Default specular reflection cubemap is calculated from the current skybox. Additional resources: RenderSettings.defaultReflectionMode , Lighting Window .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0a212619fc54_doc_5
github
scripting
What does `IPoolable` do in this Unity script? Explain its purpose and signature.
Releases the specified non-MonoBehaviour object back to its pool.The type of the non-MonoBehaviour object to release.The object to release. Signature: ```csharp public static void ReleasePure<T>(T obj) where T : class, IPoolable => _poolService.ReleasePure(obj); ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_3f50ade2d035
unity_docs
rendering
What are the parameters of `Mesh.CombineMeshes` in Unity?
Description Combines several Meshes into this Mesh. Combining Meshes is useful for performance optimization. If mergeSubMeshes is true, all the Meshes are combined together into a single sub-mesh. Otherwise, each Mesh is placed in a different sub-mesh. If all Meshes share the same Material, this property should be set ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c1a890323d47
unity_docs
math
What is `AndroidJNI.FromShortArray` in Unity? Explain its purpose and usage.
AndroidJNI.FromShortArray Declaration public static short[] FromShortArray (IntPtr array ); Description Converts a Java array of short to a managed array of System.Int16. Additional resources: AndroidJNI.GetShortArrayElement , AndroidJNI.GetArrayLength .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cab783b049b0
unity_docs
scripting
What is `BuildOptions.CompressWithLz4` in Unity? Explain its purpose and usage.
BuildOptions.CompressWithLz4 Description Use chunk-based LZ4 compression when building the Player. This value allows content to be stored in a compressed form when the Player is deployed to a device. Decompression is performed in real time when the Player reads the data. Scene or Asset loading might be faster or sl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_afc7c3e08625
unity_docs
audio
What is `Audio.AudioMixerSnapshot.TransitionTo` in Unity? Explain its purpose and usage.
AudioMixerSnapshot.TransitionTo Declaration public void TransitionTo (float timeToReach ); Parameters Parameter Description timeToReach Relative time after which this snapshot should be reached from any current state. Description Performs an interpolated transition towards this snapshot over the time inter...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_833b87373088
unity_docs
rendering
What is `LightmapParameters.blurRadius` in Unity? Explain its purpose and usage.
LightmapParameters.blurRadius public int blurRadius ; Description The radius (in texels) of the post-processing filter that blurs baked direct lighting. The filter is aware of geometry and visibility between texels and thus light leaking is reduced. In general, a value in the range from 2 to 8 leads to good re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_27ffcaafcc3e
unity_docs
rendering
In Unity's 'Design a tree', what is 'Add a new tree' and how does it work?
To create a new Tree asset, from the main menu, select GameObject > 3D Object > Tree . This action adds a tree to your Scene view. It also adds a tree prefab ( Tree.prefab ) and a texture folder ( Tree_Textures ) in the Assets folder of your Project window.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a85ad0b66e37
unity_docs
scripting
What is `Android.DownloadAssetPackAsyncOperation.isDone` in Unity? Explain its purpose and usage.
DownloadAssetPackAsyncOperation.isDone public bool isDone ; Description Checks if the operation is finished. Returns true if the operation is finished. Otherwise, returns false . Read-only. Additional resources: DownloadAssetPackAsyncOperation.keepWaiting , DownloadAssetPackAsyncOperation.progress , Downl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0322bd87c19
unity_docs
editor
Show me a Unity C# example demonstrating `Editor.OnGetFrameBounds`.
Editor.OnGetFrameBounds() Description Gets custom bounds for the target of this editor. Use this method to retrieve the Bounds for a custom window derived from the Editor class. This method is always used in conjunction with Editor.HasFrameBounds which either returns true or false, depending on the implementati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb0ed62d4b06
unity_docs
scripting
Show me a Unity C# example demonstrating `Rigidbody.inertiaTensorRotation`.
Rigidbody.inertiaTensorRotation public Quaternion inertiaTensorRotation ; Description The rotation of the inertia tensor. If you don't set inertia tensor rotation from a script it will be calculated automatically from all colliders attached to the rigidbody. ```csharp // Resets the inertia tensor to be the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2c7d0d3981d1
unity_docs
rendering
In Unity's 'Preview a 3D texture', what is 'Use the Inspector window' and how does it work?
To preview a 3D texture, select the texture in the Project window. In the Inspector window, Unity displays the preview of the texture at the bottom of the Texture Import Settings window. There are three different 3D texture preview modes available: Volume mode displays the 3D texture as a translucent cube. Click and dr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_96eae83824bc
unity_docs
performance
What is `Unity.IO.LowLevel.Unsafe.AsyncReadManager.CloseCachedFileAsync` in Unity? Explain its purpose and usage.
AsyncReadManager.CloseCachedFileAsync Declaration public static Unity.Jobs.JobHandle CloseCachedFileAsync (string fileName , Unity.Jobs.JobHandle dependency ); Parameters Parameter Description fileName The path to the file to close. dependency (Optional) A JobHandle to wait on before performing the cl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b91757e4e31b
unity_docs
input
What is `UIElements.KeyboardEventBase_1` in Unity? Explain its purpose and usage.
KeyboardEventBase<T0> class in UnityEngine.UIElements / Inherits from: UIElements.EventBase_1 / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IKeyboardEvent Description This is the base class for keyboard events. The typical keyboard event loop is as follows: - When a key is presse...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d9a5aa38a32
unity_docs
animation
What is `UIElements.IExperimentalFeatures` in Unity? Explain its purpose and usage.
IExperimentalFeatures interface in UnityEngine.UIElements Description Give access to UIElement experimental features. Properties Property Description animation Returns the animation experimental interface.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b41289dbef26
unity_docs
editor
Show me a Unity code example for 'Customize error handling'.
and parses error and exception strings from the browser to check for known errors and display error dialogs with more comprehensive error messages. You can customize this handling, for instance, if you want to suppress the warning messages. To customize error handling: Open the index.html file in your Web template . Ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_669e3ace2f67
unity_docs
animation
What is `UIElements.BaseListView.reorderMode` in Unity? Explain its purpose and usage.
BaseListView.reorderMode public UIElements.ListViewReorderMode reorderMode ; Description This property controls the drag and drop mode for the list view. The default value is Simple . When this property is set to Animated , Unity adds drag handles in front of every item and the drag and drop manipulat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3973cfd3627b
unity_docs
rendering
In Unity's 'Check lightmap UVs', what is 'Check baked lightmap UVs' and how does it work?
To see the UVs for the Baked Global Illumination system: Select a GameObject with a Mesh Renderer component. In the Mesh Renderer component, under Lightmapping , open the Baked Lightmap dropdown. Double-click a lightmap texture to open the Viewer window. In the Viewer window, open the dropdown and select Baked UV Chart...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d47782085169
unity_docs
rendering
Explain 'Position an overlay' in Unity.
Move overlays in the Scene view to organize your workspace. Overlays can float or dock to the edges or corners of the Scene view . If you want to save your overlay configuration, refer to Create and manage overlay configurations . ## Move overlays Put overlays anywhere in the Scene view. To move an overlay in the Sce...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d2473b9e8cd
unity_docs
scripting
What is `PlayerLoop.PreUpdate` in Unity? Explain its purpose and usage.
PreUpdate struct in UnityEngine.PlayerLoop / Implemented in: UnityEngine.CoreModule Description Update phase in the native player loop. This is the C# representation of an update phase in the native player loop. It can only be used to identify the update phase in native.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe13bee8d326
unity_docs
scripting
What are the parameters of `GameObject.GetComponentInChildren` in Unity?
Returns T A Component of the matching type T , otherwise null if no matching Component is found. Description Retrieves a reference to a component of type T on the specified GameObject, or any child of the GameObject. This method checks the GameObject on which it is called first, then recurses downwards through all chil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d6d5306eabc
unity_docs
ui
What is `Canvas.referencePixelsPerUnit` in Unity? Explain its purpose and usage.
Canvas.referencePixelsPerUnit public float referencePixelsPerUnit ; Description The number of pixels per unit that is considered the default. Sprites have a Pixels Per Unit that control the pixel density of the sprite. For sprites that have the same Pixels Per Unit as the Reference Pixels Per Unit in the Canvas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c9870d78719f
unity_docs
rendering
What is `Rendering.BatchRendererGroupCreateInfo` in Unity? Explain its purpose and usage.
BatchRendererGroupCreateInfo struct in UnityEngine.Rendering / Implemented in: UnityEngine.CoreModule Description Struct is used to initialize BatchRendererGroup. Properties Property Description cullingCallback Unity calls this callback when this BatchRendererGroup performs culling. finishedCullingCallback ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bb5c1f9bf8c3
unity_docs
scripting
What is `Unity.Android.Gradle.BaseElement.SetRaw` in Unity? Explain its purpose and usage.
BaseElement.SetRaw Declaration public void SetRaw (string rawString ); Parameters Parameter Description rawString Raw string value. Description Sets a raw string value to this element. Empty string is a valid value. Unity throws an exception if the parent element has a raw value set.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5e17c7271e5
unity_docs
scripting
What is `ObjectChangeEventStream.Builder.PushChangeGameObjectParentEvent` in Unity? Explain its purpose and usage.
ObjectChangeEventStream.Builder.PushChangeGameObjectParentEvent Declaration public void PushChangeGameObjectParentEvent (ref ChangeGameObjectParentEventArgs data ); Parameters Parameter Description data The event data to add to the stream. Description Adds an ChangeGameObjectParentEventArgs to the end ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fb93e7dd90bb
unity_docs
editor
Show me a Unity C# example demonstrating `Handles.FreeRotateHandle`.
oved the handle, it will return the same value as you passed into the function. Description Make an unconstrained rotation handle. The handle can rotate freely on all axes. The rotation gizmo has no visible axes and is simply a circle in the Scene view. Users can click and drag from within the circle to provide in...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9361ab99516
unity_docs
physics
What is `ArticulationBody.GetJointPositions` in Unity? Explain its purpose and usage.
ArticulationBody.GetJointPositions Declaration public int GetJointPositions (List<float> positions ); Parameters Parameter Description positions Supplied list of floats to read back and store the joint positions data. Returns int Total degrees of freedom for the entire hierarchy of articulation bodies....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c669d4ffe1e1
unity_docs
animation
Explain 'Animation Parameters' in Unity.
Animation Parameters are variables that are defined within an Animator Controller that can be accessed and assigned values from scripts . This is how a script can control or affect the flow of the state machine . For example, the value of a parameter can be updated by an animation curve and then accessed from a script ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49f240195c53
unity_docs
scripting
What is `ModelImporterIndexFormat.Auto` in Unity? Explain its purpose and usage.
ModelImporterIndexFormat.Auto Description Use 16 or 32 bit index buffer depending on mesh size. Meshes that have less than 65536 vertices will use 16 bit index buffer, and larger meshes will use 32 bit one. Note however that GPU support for 32 bit indices is not guaranteed on all platforms; for example Android devi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c20fe0d9417
unity_docs
editor
Show me a Unity C# example demonstrating `AssetImporter.SaveAndReimport`.
AssetImporter.SaveAndReimport Declaration public void SaveAndReimport (); Description Save asset importer settings if asset importer is dirty. Under the hood this calls AssetDatabase.ImportAsset . Additional resources: EditorUtility.SetDirty . ```csharp using UnityEngine; using UnityEditor; public class Save...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_976e94490db0
unity_docs
input
What is `UIElements.KeyboardEventBase_1.shiftKey` in Unity? Explain its purpose and usage.
KeyboardEventBase<T0>.shiftKey public bool shiftKey ; Description Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39653c0858e8
unity_docs
math
What is `AndroidJNIHelper.CreateJNIArgArray` in Unity? Explain its purpose and usage.
AndroidJNIHelper.CreateJNIArgArray Declaration public static jvalue[] CreateJNIArgArray (object[] args ); Parameters Parameter Description args An array of objects that should be converted to Call parameters. Description Creates the parameter array to be used as argument list when invoking Java code throug...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_18c627bba17d
unity_docs
ui
Explain 'Update an asset package' in Unity.
You can update an asset package that you got from the Asset Store by using the Package Manager window. Note: Follow this task to update an asset package from the Asset Store that’s already in your project. Refer to the following resources for other related tasks: For information about importing an asset package from th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70bacd0c750f
unity_docs
input
Show me a Unity C# example demonstrating `Event.pointerType`.
often mixed with pen events in the event stream, and you can't distinguish them by type because mouse and pen events share the same EventType . Instead, use PointerType to distinguish them. Otherwise, Unity processes all incoming mouse events as pen events, which can lead to unexpected behavior because the mouse eve...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f60f2dd1d2d
unity_docs
math
What is `XR.Eyes.TryGetLeftEyePosition` in Unity? Explain its purpose and usage.
Eyes.TryGetLeftEyePosition Declaration public bool TryGetLeftEyePosition (out Vector3 position ); Parameters Parameter Description positionOut A Vector3 struct to receive the left eye position. Returns bool true if eyes can be queried for the left eye position; otherwise false. Description Gets the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4885229d9dcf
unity_docs
math
What is `ReflectionProbe.center` in Unity? Explain its purpose and usage.
ReflectionProbe.center public Vector3 center ; Description The center of the probe's bounding box in which the probe can contribute to reflections. The center is relative to the position of the probe.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80ec3ff2069e
unity_docs
rendering
What are the parameters of `GL.IssuePluginEvent` in Unity?
Description Send a user-defined event to a native code plugin. Rendering in Unity can be multithreaded if the platform and number of available CPUs will allow for it. When multithreaded rendering is used, the rendering API commands happen on a thread which is completely separate from the one that runs the scripts. Cons...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c9b30718239d_doc_2
github
scripting
What does `Pick` do in this Unity script? Explain its purpose and signature.
Picks tiles from selected Tilemaps and child GameObjects, given the coordinates of the cells.The GroupBrush overrides this to locate groups of Tiles from the picking position.Grid to pick data from.Target of the picking operation. By default the currently selected GameObject.The coordinates of the cells to paint data f...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_a6cc0deeaa2d
unity_docs
rendering
What is `Rendering.RayTracingInstanceCullingMaterialTest.requiredShaderTags` in Unity? Explain its purpose and usage.
RayTracingInstanceCullingMaterialTest.requiredShaderTags public RayTracingInstanceCullingShaderTagConfig[] requiredShaderTags ; Description An array of Shader Tags used by RayTracingAccelerationStructure.CullInstances to ignore Renderers or individual sub-meshes. If a Shader contains a Shader Tag from the lis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47beab379dd2
unity_docs
scripting
What is `UIElements.FillRule` in Unity? Explain its purpose and usage.
FillRule enumeration Description The fill rule to use when filling shapes with Painter2D.Fill . Properties Property Description NonZero The "non-zero" winding rule. OddEven The "odd-even" winding rule.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8801610461da
unity_docs
scripting
Give me an overview of the `EditorUserSettings` class in Unity.
EditorUserSettings class in UnityEditor / Inherits from: Object Description Class for accessing and modifying Editor user settings related to version control and asset import. Use the properties of this class to define local Editor user settings, which you can exclude from version control. Static Properties P...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_326070123fdb
unity_docs
input
What is `Experimental.GraphView.ClickSelector.OnMouseDown` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ClickSelector.OnMouseDown Declaration protected void OnMouseDown ( UIElements.MouseDownEvent e ); Description Called on mouse down event.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_64e054bd83b8
unity_docs
ui
What is `UIElements.Scroller.Adjust` in Unity? Explain its purpose and usage.
Scroller.Adjust Declaration public void Adjust (float factor ); Parameters Parameter Description factor Slider size ratio. Description Updates the slider element size as a ratio of total range. A value greater than or equal to 1 will disable the Scroller.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ca22d5919cfd
github
scripting
Write a Unity C# MonoBehaviour script called AI Transition
```csharp using UnityEngine; namespace Goon.AI { public class AITransition : MonoBehaviour { #if UNITY_EDITOR public string transitionName = "Transition"; public Vector2 nodePos = Vector2.zero; #endif public bool IsTriggered() { return condition.IsT...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_f31c8339e2f6
unity_docs
rendering
What is `Rendering.LocalKeyword.operator_ne` in Unity? Explain its purpose and usage.
LocalKeyword.operator != public static bool operator != ( Rendering.LocalKeyword lhs , Rendering.LocalKeyword rhs ); Description Returns true if the shader keywords are not the same. Otherwise, returns false.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17250b8040e9
unity_docs
editor
What are the parameters of `Handles.DrawAAPolyLine` in Unity?
Description Draw anti-aliased line specified with point array and width. Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles. Note: To get an anti-aliased effect use a texture that is 1x2 pixels with one transparent white pixel and one opaque white pixel. ```csharp using Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4eb12069117b
unity_docs
animation
What is `Animator.playbackTime` in Unity? Explain its purpose and usage.
Animator.playbackTime public float playbackTime ; Description Sets the playback position in the recording buffer. When in playback mode (see StartPlayback ), this value is used for controlling the current playback position in the buffer (in seconds). The value can range between recorderStartTime and record...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cc71284719c3
unity_docs
editor
Show me a Unity C# example demonstrating `PrefabUtility.GetOriginalSourceRootWhereGameObjectIsAdded`.
is passed in as the source to this method, this method returns the asset "B". In this example scenario, if you call GetOriginalSourceRootWhereGameObjectIsAdded and supply the instance of GameObject C as the gameObject , then the method returns the asset B. The Open Prefab button in the Restructure Dialog uses this...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5f61eedc0322
unity_docs
scripting
What is `Search.SearchItem.ToObject` in Unity? Explain its purpose and usage.
SearchItem.ToObject Declaration public Object ToObject (); Declaration public Object ToObject (Type type ); Parameters Parameter Description type Used to validate if the object is assignable to Type. Returns Object Returns a Unity Object or null if there is none. Description Returns any valid Uni...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9e1c5fe87426
unity_docs
xr
In Unity's 'VR feature set', what is 'Getting started' and how does it work?
The Unity VR feature set pre-installs the packages you need for VR development. With OpenXR , you can simplify your VR development by targeting a wide range of VR devices. Alternatively, develop directly for the Oculus platform with the Oculus XR Plugin. Unity directly supports the following VR platforms: Oculus Window...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_13124b4b2db9
unity_docs
scripting
What is `ParticleSystem.ExternalForcesModule.influenceMask` in Unity? Explain its purpose and usage.
ParticleSystem.ExternalForcesModule.influenceMask public LayerMask influenceMask ; Description Particle System Force Field Components with a matching Layer affect this Particle System. Additional resources: LayerMask . ```csharp using UnityEngine;[RequireComponent(typeof(ParticleSystem))] public class Exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_889520c27ec2
unity_docs
editor
What is `VersionControl.ChangeSet` in Unity? Explain its purpose and usage.
ChangeSet class in UnityEditor.VersionControl Description Wrapper around a changeset description and ID. Static Properties Property Description defaultID The ID of the default changeset. Properties Property Description description Description of a changeset. id Version control specific ID of a changeset.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_605602e9742e
unity_docs
scripting
What is `ScreenOrientation.PortraitUpsideDown` in Unity? Explain its purpose and usage.
ScreenOrientation.PortraitUpsideDown Description Portrait orientation, upside down. Available on iOS and on Android 2.3+. On older Androids falls back to Portrait. Additional resources: Screen.orientation .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee2bfbbca0a5
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.AddTarget` in Unity?
Returns string The GUID of the new target. Description Creates a new native target. Target-specific build configurations are automatically created for each known build configuration name. Note, that this is a requirement that follows from the structure of Xcode projects, not an implementation detail of this function. T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e8558c0da99f
unity_docs
scripting
In Unity's 'Vector2IntField', what is 'Create a Vector2IntField' and how does it work?
You can create a Vector2IntField with UI Builder, UXML, and C#. The following C# example creates a Vector2IntField with the default value (15, 12) : ``` Vector2IntField myElement = new Vector2IntField("Label text"); // Set the default value to (15, 12). myElement.value = new Vector2Int(15, 12); ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6a59fc72b10
unity_docs
rendering
What is `Shader.isSupported` in Unity? Explain its purpose and usage.
Shader.isSupported public bool isSupported ; Description Can this shader run on the end-users graphics card? (Read Only) Returns true if the shader itself or any fallbacks setup in the shader are supported. Most often you use this when implementing special effects. ```csharp using UnityEngine;public class Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ebf72fedd520
unity_docs
rendering
In Unity's 'Transparent Bumped Diffuse', what is 'Normal Mapped Properties' and how does it work?
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 change as the camera moves or rotates around. Normal mapping simulates small surface details using a text...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32eab3c29adf
unity_docs
scripting
What is `Time.unscaledDeltaTime` in Unity? Explain its purpose and usage.
Time.unscaledDeltaTime public static float unscaledDeltaTime ; Description The timeScale-independent interval in seconds from the last frame to the current one (Read Only). When called from inside MonoBehaviour's FixedUpdate , it returns the unscaled fixed framerate delta time. Unlike deltaTime this value is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_770e7a8272eb
unity_docs
xr
What is `Networking.UploadHandler.Dispose` in Unity? Explain its purpose and usage.
UploadHandler.Dispose Declaration public void Dispose (); Description Signals that this UploadHandler is no longer being used, and should clean up any resources it is using. This method must be called once you have finished using an UploadHandler object. For convenience, UnityWebRequest exposes the Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ef7481009d0f
unity_docs
rendering
Explain 'Hierarchy window reference' in Unity.
Explore the settings and functions in the Hierarchy window to view and organize objects in your scene . The Hierarchy window displays every GameObject in a scene, including models, cameras, and prefabs . You can use the Hierarchy window to manage and group the GameObjects you use in a Scene. When you add or remove Game...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3290705dad3e
unity_docs
scripting
What is `UIElements.StyleEnum_1` in Unity? Explain its purpose and usage.
StyleEnum<T0> struct in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Implements interfaces: IStyleValue<T0> Description Style value that can be either an enum or a StyleKeyword . Properties Property Description keyword The style keyword. value The style value. Construc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d776f4ef84e
unity_docs
audio
Show me a Unity C# example demonstrating `Handheld.PlayFullScreenMovie`.
Microsoft documentation on Supported audio and video formats (Windows Runtime apps) . Android: When an Android phone is in standby mode, Handheld.PlayFullScreenMovie function pauses the movie playback. When the phone is turned back on, the movie playback resumes over the lock screen if you're using a developement b...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6872df649ae
unity_docs
editor
What is `EditorGUILayout.PropertyField` in Unity? Explain its purpose and usage.
EditorGUILayout.PropertyField Declaration public static bool PropertyField ( SerializedProperty property , params GUILayoutOption[] options ); Declaration public static bool PropertyField ( SerializedProperty property , GUIContent label , params GUILayoutOption[] options ); Declaration public static ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dee858147a06
unity_docs
xr
What is `Mesh.vertexBufferTarget` in Unity? Explain its purpose and usage.
Mesh.vertexBufferTarget public GraphicsBuffer.Target vertexBufferTarget ; Description The intended target usage of the Mesh GPU vertex buffer. By default, Mesh vertex buffers have GraphicsBuffer.Target.Vertex usage target. If you want to access the mesh vertex buffer from a compute shader, additional targe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7c230cd957bd
unity_docs
editor
What is `Build.Content.SerializedLocation` in Unity? Explain its purpose and usage.
SerializedLocation struct in UnityEditor.Build.Content Description Struct containing information about where an object was serialized. Note: this class and its members exist to provide low-level support for the Scriptable Build Pipeline package. This is intended for internal use only; use the Scriptable Build ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32f39847c58c
unity_docs
scripting
What is `Font` in Unity? Explain its purpose and usage.
Font class in UnityEngine / Inherits from: Object / Implemented in: UnityEngine.TextRenderingModule Description Script interface for font assets . You can use this class to dynamically switch fonts on Text Meshes. Additional resources: TextMesh . Properties Property Description ascent The ascent of the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d8bae852de2
unity_docs
rendering
What is `MaterialPropertyBlock.HasConstantBuffer` in Unity? Explain its purpose and usage.
MaterialPropertyBlock.HasConstantBuffer Declaration public bool HasConstantBuffer (string name ); Declaration public bool HasConstantBuffer (int nameID ); Parameters Parameter Description name The name of the property. nameID The name ID of the property. Use Shader.PropertyToID to get this ID. Retu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d04df1924820
unity_docs
scripting
What is `ModelImporter.optimizeGameObjects` in Unity? Explain its purpose and usage.
ModelImporter.optimizeGameObjects public bool optimizeGameObjects ; Description Animation optimization setting. In the GameObjects hierarchy of a character, the GameObjects which only contain Transform component, will be optimized out unless they are specified in extraExposedTransformPaths for better CPU perf...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_550e42b85c77
unity_docs
editor
What is `EditorSettings.cacheServerEnableUpload` in Unity? Explain its purpose and usage.
EditorSettings.cacheServerEnableUpload public static bool cacheServerEnableUpload ; Description Toggle whether to enable uploading from cache server. This toggles on and off whether to upload to a cache server after the asset pipeline have finished importing the asset.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f9f1b10fe6d3
unity_docs
scripting
Show me a Unity C# example demonstrating `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.MemCmp`.
e identical; returns a non-zero value if they differ. Description Checks whether two memory regions are identical. The MemCmp method compares two memory regions to determine if they contain identical data. It returns zero if the memory contents are the same and a non-zero value if they differ. This method can be...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_581a0832a1bd
unity_docs
scripting
In Unity's 'Troubleshooting automatically generated lightmap UVs', what is 'Pack Margin' and how does it work?
To allow filtering, the lightmap contains lighting information in texels near the chart border, so always include some margin between charts to avoid light bleeding when applying the lightmap. The lightmap resolution defines the texel resolution of your lightmaps. Lightmappers dilate some chart texels in the lightmap t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dfda1e4635ab
unity_docs
xr
In Unity's 'Submit a license request from a command line and browser (macOS, Linux)', what is '1) Create a license request file from the command line' and how does it work?
Important : You must run this command from the computer where you installed Unity, but the computer doesn’t need internet access for this step to work. Make sure you know the installation location of your Unity Editor (ending with Unity.app ), described earlier. On macOS, you’ll add /Contents/MacOS/Unity to this path f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ac4475661729_doc_8
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can be initialized using eight arguments.-derived classes that implement this interface can be instantiated with arguments using the function.-derived classes that implement this interface can be added to a with arguments using the GameObject.AddComponent function.These functions can automati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c609f0251941
unity_docs
animation
What is `ModelImporter.autoGenerateAvatarMappingIfUnspecified` in Unity? Explain its purpose and usage.
ModelImporter.autoGenerateAvatarMappingIfUnspecified public bool autoGenerateAvatarMappingIfUnspecified ; Description Generate auto mapping if no avatarSetup is provided when importing humanoid animation. Additional resources: ModelImporter.avatarSetup , ModelImporterAnimationType.Human .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b1ecba46238
unity_docs
rendering
What is `Rendering.CopyTextureSupport.Basic` in Unity? Explain its purpose and usage.
CopyTextureSupport.Basic Description Basic Graphics.CopyTexture support. Generally this means that texture copies work between same texture types (e.g. 2D texture to 2D texture, or cubemap to cubemap). Additional cases that might not necessarily be present are other flags in CopyTextureSupport .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_77f20e7a3c58
unity_docs
scripting
What is `TerrainTools.TerrainPaintToolWithOverlaysBase.HasBrushMask` in Unity? Explain its purpose and usage.
TerrainPaintToolWithOverlaysBase.HasBrushMask public bool HasBrushMask ; Description True if Terrain Tool has brush masks, false otherwise. Returns a boolean indicating whether the Terrain Tool should display a brush mask overlay, used primarily for paint tools.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e95a065a4879
unity_docs
scripting
What is `Unity.Profiling.Memory.CaptureFlags.NativeAllocationSites` in Unity? Explain its purpose and usage.
CaptureFlags.NativeAllocationSites Description Specifies the location that each native allocation was allocated at. This data is needed to connect native allocations to their Memory Labels and to the native call stacks of their allocation call. Native call stacks can only be collected from a build that supports th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.