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_3ec513781b22
unity_docs
scripting
What are the parameters of `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.PinGCObjectAndGetAddress` in Unity?
Returns void* A pointer to the memory location of the pinned object. Use this pointer for direct memory access to the object's data. Description Pins an object in memory, ensuring it remains at a fixed memory location during garbage collection. The PinGCObjectAndGetAddress method pins a managed object, preventing the g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ba67f8b067ab
unity_docs
rendering
What is `SystemInfo.supportsRawShadowDepthSampling` in Unity? Explain its purpose and usage.
SystemInfo.supportsRawShadowDepthSampling public static bool supportsRawShadowDepthSampling ; Description Is sampling raw depth from shadowmaps supported? (Read Only) Some platforms (most notably Direct3D 9) can not sample raw depth value from a shadowmap. Additional resources: CommandBuffer.SetShadowSamplingM...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6e09198c9733
unity_docs
animation
What is `Animations.IAnimationJobPlayable.SetJobData` in Unity? Explain its purpose and usage.
IAnimationJobPlayable.SetJobData Declaration public void SetJobData (T jobData ); Parameters Parameter Description jobData The new IAnimationJob data to set in the playable. Description Sets a new job data in the playable. The generic type must be the same as the one used for the creation of the playabl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5a430be6715
unity_docs
rendering
What is `LineRenderer.positionCount` in Unity? Explain its purpose and usage.
LineRenderer.positionCount public int positionCount ; Description Set/get the number of vertices. positionCount returns the number of vertices in the line. The example below shows a line with 3 vertices. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(LineRenderer))] public cla...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_28761bce9bb6
unity_docs
scripting
What is `Experimental.GraphView.Node.InstantiatePort` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node.InstantiatePort(Orientation,Direction,Type) Parameters Parameter Description orientation Port's orientation. direction Port's direction. type Port's type. newPres (obsolete). Returns void The new port. Descri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a3761c1f2bcb
unity_docs
rendering
What is `XR.XRDisplaySubsystem.XRRenderPass` in Unity? Explain its purpose and usage.
XRRenderPass struct in UnityEngine.XR / Implemented in: UnityEngine.XRModule Description Contains configuration parameters about which view into the Scene the renderer should rasterize, and a render target (which can be a texture array) for the result of the rasterization. An XRRenderPass can contain more than ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_c24ffea30041_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Determines whether the specified is a reference or has been destroyed. The to check. if the specified is a reference or has been destroyed; otherwise, . Signature: ```csharp public static bool operator ==(Object unityObject, NullComparer @null) => unityObject == null; ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_acac349bf061
unity_docs
scripting
In Unity's 'Override prefab instances', what is 'Transform overrides' and how does it work?
A prefab instance’s Position and Rotation properties always differ from the root prefab asset’s properties and aren’t an explicit override. This is because in most projects, different prefab instances need to be at different positions and rotations to the original prefab asset, so Unity doesn’t consider this to be an o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_48b3605c8f24
unity_docs
ui
What is `UIElements.BaseTreeViewController` in Unity? Explain its purpose and usage.
BaseTreeViewController class in UnityEngine.UIElements / Inherits from: UIElements.CollectionViewController / Implemented in: UnityEngine.UIElementsModule Description Base collection tree view controller. View controllers of this type are meant to take care of data virtualized by any BaseTreeView inheritor....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cf3882857101
unity_docs
rendering
What is `ParticleSystemRenderer.pivot` in Unity? Explain its purpose and usage.
ParticleSystemRenderer.pivot public Vector3 pivot ; Description Modify the pivot point used for rotating particles. The units are expressed as a multiplier of the particle sizes, relative to their diameters. For example, a value of 0.5 adjusts the pivot by the particle radius, allowing particles to rotate aro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_89ee6c6e0fdc
unity_docs
scripting
Explain 'Import an Android Library plug-in' in Unity.
You can import an Android Library plug-in created outside of Unity into your Unity project using the following steps: Copy the Android Library plug-in to the Assets folder of your Unity Project. If the Android Library plug-in root folder doesn’t use the.androidlib extension, add this extension to the folder. For exampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4dce48782854
unity_docs
networking
What is `Networking.MultipartFormFileSection.sectionName` in Unity? Explain its purpose and usage.
MultipartFormFileSection.sectionName public string sectionName ; Returns string The section's name, or null . Description Returns the name of this section, if any. Additional resources: [IMultipartFormSection.sectionName].
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af6237148a97
unity_docs
editor
What is `Device.SystemInfo.supportsConservativeRaster` in Unity? Explain its purpose and usage.
SystemInfo.supportsConservativeRaster public static bool supportsConservativeRaster ; Description This has the same functionality as SystemInfo.supportsConservativeRaster 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_eb10b61d9aba
unity_docs
rendering
What is `TextureImporter.mipmapFadeDistanceStart` in Unity? Explain its purpose and usage.
TextureImporter.mipmapFadeDistanceStart public int mipmapFadeDistanceStart ; Description Mip level where texture begins to fade out. Additional resources: mipmapEnabled , fadeout , mipmapFadeDistanceEnd .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9acbc325dbb
unity_docs
physics
What is `MonoBehaviour.OnControllerColliderHit` in Unity? Explain its purpose and usage.
MonoBehaviour.OnControllerColliderHit(ControllerColliderHit) Parameters Parameter Description hit The ControllerColliderHit data associated with this collision. Description OnControllerColliderHit is called when the CharacterController component hits a collider while performing a Move. Use this to impleme...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a56aed081483
unity_docs
editor
What is `MessageType` in Unity? Explain its purpose and usage.
MessageType enumeration Description User message types. Additional resources: EditorGUI.HelpBox , EditorGUILayout.HelpBox . Properties Property Description None Neutral message. Info Info message. Warning Warning message. Error Error message.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_84f170564f67
unity_docs
xr
What is `PackageManager.GitInfo` in Unity? Explain its purpose and usage.
GitInfo class in UnityEditor.PackageManager Description Identifies a specific revision for a Git package using a Git commit hash. Properties Property Description hash Returns the resolved Git commit hash for the requested revision for this package. revision Returns the requested Git revision for the Git pa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6137ac9f19f5
unity_docs
scripting
What is `Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle.CheckExistsAndThrow` in Unity? Explain its purpose and usage.
AtomicSafetyHandle.CheckExistsAndThrow Declaration public static void CheckExistsAndThrow (ref Unity.Collections.LowLevel.Unsafe.AtomicSafetyHandle handle ); Parameters Parameter Description handle The AtomicSafetyHandle to check. Description Check if an AtomicSafetyHandle is valid. Throws an exception ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bfdf18de3628
unity_docs
scripting
Show me a Unity C# example demonstrating `Projector.farClipPlane`.
Projector.farClipPlane public float farClipPlane ; Description The far clipping plane distance. The projector will not affect anything that is further than this distance. Additional resources: projector component . ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { // Get th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7fa198e05ec7
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.Receiver` in Unity? Explain its purpose and usage.
Receiver class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseElement Description The C# definition of the <receiver> Android Manifest element. For more information about the element, see Android's documentation: Receiver element Properties Property Description Attr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9cbecd94e73e
unity_docs
physics
Explain 'Pre-release packages' in Unity.
When a package is ready for testing, its developer makes sure there is some basic test coverage, and that the package passes internal testing. The package also needs at least preliminary documentation, an updated changelog, and licensing. Pre-release packages are partially tested and verified to use safely with the cur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_344bb9c2ce54
unity_docs
rendering
Explain 'Search provider references' in Unity.
Use search providers to focus your search. This section provides a reference for individual search providers, grouped by their purpose. For information on toggling and using search providers, refer to Use search providers . For information about creating a search provider, refer to Create a custom search provider . ##...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ebefaa3d3e9
unity_docs
rendering
Show me a Unity C# example demonstrating `WebCamTexture.GetPixels32`.
tion. GetPixels32 might fail if the array contains too much data. You can optionally pass in an array of Color32 structs to avoid allocating new memory each frame. This can improve performance if you are continuously reading data from the camera. The array must be initialized to the dimensions width * height of t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e3ab130ecaff
unity_docs
animation
What is `AvatarIKGoal` in Unity? Explain its purpose and usage.
AvatarIKGoal enumeration Description IK Goal. Used to set and get IK weights, position and rotation. Additional resources: Animator.SetIKPosition , Animator.SetIKPositionWeight , Animator.SetIKRotation and Animator.SetIKRotationWeight . Properties Property Description LeftFoot The left foot. RightFoot Th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a6af4ae9365d
unity_docs
scripting
What is `UIElements.Experimental.PointerDownLinkTagEvent.ctor` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PointerDownLinkTagEvent Constructor Declaration public PointerDownLinkTagEvent (); Description Constructor. Avoid creating new event instances. Instead, use GetPooled() to get an instance from a pool of reusable event instan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6535230efb25
unity_docs
audio
What is `AudioLowPassFilter.cutoffFrequency` in Unity? Explain its purpose and usage.
AudioLowPassFilter.cutoffFrequency public float cutoffFrequency ; Description Lowpass cutoff frequency in hz. 10.0 to 22000.0. Default = 5000.0. Note that setting this value will reset any custom cutoff curve set for this AudioLowPassFilter. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8a055e51619
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.ActivityAlias` in Unity? Explain its purpose and usage.
ActivityAlias class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseElement Description The C# definition of the <activity-alias> Android Manifest element. For more information about the element, see Android's documentation: ActivityAlias element Properties Property D...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a50a121793e7
unity_docs
editor
Give me an overview of the `UpdatePrefabInstancesEventArgs` class in Unity.
UpdatePrefabInstancesEventArgs struct in UnityEditor Description A change of this type indicates that prefab instances in an open scene have been updated due to a change to the source prefab. Properties Property Description instanceIds The instance ID for each root GameObject of the prefab instances that have ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9c716e8298a9
unity_docs
rendering
In Unity's 'Light Probes reference', what is 'Edit Light Probe Group tool reference' and how does it work?
Property Function Show Wireframe When this property is enabled, Unity displays the wireframe of the Light Probe Group in the Scene view . When it is disabled, Unity only displays the Light Probe points, and not the wireframe connecting them. Selected Probe Position This gives the x, y and z coordinates of the selected ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_983cb9579222_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
If true, we create a new object if there is no instance in the scene. Signature: ```csharp protected static bool CreateInstanceIfNotPresent = true; ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_083aba6db9d3
unity_docs
scripting
Show me a Unity C# example demonstrating `AudioImporter`.
AudioImporter class in UnityEditor / Inherits from: AssetImporter Description Use this class to modify AudioClip import settings from editor scripts. Use these settings to ensure all or a subset of your audio files have the same import settings. You can also edit these settings in the Audio Clip Inspector. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f816cfc69818
unity_docs
physics
What is `Rigidbody.position` in Unity? Explain its purpose and usage.
Rigidbody.position public Vector3 position ; Description The position of the rigidbody. Rigidbody.position allows you to get and set the position of a Rigidbody using the physics engine. If you change the position of a Rigidbody using Rigidbody.position , the transform will be updated after the next physic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5a2599cc281
unity_docs
scripting
What is `Rendering.ReflectionProbeRefreshMode.ViaScripting` in Unity? Explain its purpose and usage.
ReflectionProbeRefreshMode.ViaScripting Description Sets the probe to never be automatically updated by Unity while your game is running. Use this to completely control the probe refresh behavior by script. Additional resources: ReflectionProbe.RenderProbe .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0fa93753e642_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
This class will use all the power that TinyECS provides Signature: ```csharp public class ImprovedSpawnSystem : BaseReactiveSystem ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_e314d1028b8e
unity_docs
scripting
What is `Unity.IntegerTime.DiscreteTime.operator_subtract` in Unity? Explain its purpose and usage.
DiscreteTime.operator - public static Unity.IntegerTime.DiscreteTime operator - ( Unity.IntegerTime.DiscreteTime lhs , Unity.IntegerTime.DiscreteTime rhs ); public static Unity.IntegerTime.DiscreteTime operator - ( Unity.IntegerTime.DiscreteTime lhs ); Description Returns the substraction of two t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1d24c3d367ca
unity_docs
audio
What is `AudioSourceCurveType` in Unity? Explain its purpose and usage.
AudioSourceCurveType enumeration Description This defines the curve type of the different custom curves that can be queried and set within the AudioSource. The AudioSource can hold a number of custom distance curves, this enum is used within the AudioSource API to differentiate between them. Properties Property ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_80d0b9e3f6ee
unity_docs
scripting
Explain 'Transition events' in Unity.
Transition events inform you of the changes in a transition’s state. UI Toolkit uses transitions when a VisualElement ’s style property is modified. Changes to VisualElement property are immediately reflected visually. However, you can use the transition USS property to interpolate between the initial and end results g...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_38e1fc17ecd9_doc_5
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Get first class attribute Signature: ```csharp public static T GetFirstClassAttribute<T>(Type type) where T : Attribute ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_fbb6ac3b501d
unity_docs
editor
What is `IDataModeController.UpdateSupportedDataModes` in Unity? Explain its purpose and usage.
IDataModeController.UpdateSupportedDataModes Declaration public void UpdateSupportedDataModes (IList<DataMode> supportedDataMode , DataMode preferredDataMode ); Parameters Parameter Description supportedDataMode A list of the supported DataModes. preferredDataMode Preferred data mode to use given the cu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1b9650cdfee6
unity_docs
scripting
Show me a Unity code example for 'Unity attributes'.
ation to indicate special behaviour. There are many attributes defined in the .NET libraries and Unity also provides a number of custom, Unity-specific attributes. For example, you can add the HideInInspector attribute above a property declaration to prevent the Inspector from showing the property, even if it is public...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0b4ffa7c9c2
unity_docs
rendering
What is `Search.SearchProvider.name` in Unity? Explain its purpose and usage.
SearchProvider.name public string name ; Description Unique ID of the search provider. ```csharp using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using UnityEditor; using UnityEditor.Search; using UnityEngine; static class SearchProvider_name { internal static str...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d59f9d7ecdc2
unity_docs
scripting
What is `XR.XRDisplaySubsystem.displayFocusChanged` in Unity? Explain its purpose and usage.
XRDisplaySubsystem.displayFocusChanged Parameters Parameter Description value Delegate method to call when the event is sent. Description Event sent when XR display focus changes. This event is sent on the main thread. ```csharp using UnityEngine; using UnityEngine.XR;public class ExampleClass : MonoBehaviour...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f23a94f4fc56
unity_docs
editor
What is `PrefabUtility.LoadPrefabContents` in Unity? Explain its purpose and usage.
PrefabUtility.LoadPrefabContents Declaration public static GameObject LoadPrefabContents (string assetPath ); Parameters Parameter Description assetPath The path of the Prefab Asset to load the contents of. Returns GameObject The root of the loaded contents. Description Loads a Prefab Asset at a gi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1187ad235cf2
unity_docs
editor
Show me a Unity C# example demonstrating `Search.QueryFilterOperator.AddHandler`.
e returned by a filter handler. <TFilterConstant>: The type of the operator's right-hand side operand. An operator handler is a function that is executed for a particular operator (for example "=") with specific type requirements. The operator handler is chosen by the return value of the filter handler (see AddFilter ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2329a7941cc1_doc_2
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The Game Object which represents the left hand for normal interaction purposes. Signature: ```csharp public GameObject leftBaseController ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_f83d254b2b99
unity_docs
editor
What is `L10n.Tr` in Unity? Explain its purpose and usage.
L10n.Tr Declaration public static string Tr (string str ); Parameters Parameter Description str Original text, basically English. Returns string Localized text. Description This function referes a po file like ja.po as an asset. Asmdef and [assembly: UnityEditor.Localization] is needed. ```csharp us...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_a326a9e5b629_doc_9
github
scripting
What does `Repeat` do in this Unity script? Explain its purpose and signature.
Repeats the passed either thespecified number of times or forever if not specified.You can use to repeat your customaction until a condition is met. This is different from and in that you can be more specific about what you want to yieldbetween repetitions.var launch = Repeat(() => { _rb.AddForce(Vector3.up * Push...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_e3e8e638f1d8
unity_docs
editor
Explain 'Load UXML and USS C# scripts' in Unity.
Unity represents UXML files as VisualTreeAsset objects in C# and represents USS files as StyleSheet objects in C#. Since VisualTreeAsset and StyleSheet are regular Unity assets, you can use Unity’s standard workflows to load them. ## Use serialization references Unity automatically detect fields from your C# scripts ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a42fcef9d54e
unity_docs
editor
Explain 'Cloud Code' in Unity.
com.unity.services.cloudcode ## Description Run your game logic in the cloud as serverless functions and interact with other backend services. This package allows you to call out to Cloud Code from within your project as a secure player. Cloud Code can be used to: -Change game logic for all players without re-distrib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c1e13710115f
unity_docs
rendering
In Unity's 'Functions reference', what is 'Set filtering' and how does it work?
Expression Description eq {Iterable, Selector, Literal | QueryString} Keeps search results that have an equal value. gt {Iterable, Selector, Literal | QueryString} Keeps search results that have a greater value. gte {Iterable, Selector, Literal | QueryString} Keeps search results that have a greater or equal value. lw ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_91b288491aa2
unity_docs
scripting
Explain 'Handling dependencies between AssetBundles' in Unity.
AssetBundles become dependent on others when their objects reference objects in another AssetBundle. If a referenced object isn’t assigned to any AssetBundle, Unity embeds it in the dependent AssetBundles during the build. If multiple AssetBundles reference the same unassigned object, each AssetBundle contains its own ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_68e37d105ab6
unity_docs
math
What are the parameters of `LightTransport.BufferSlice_1.ctor` in Unity?
Description Construct a new BufferSlice struct by defining an offset from the beginning of a buffer. The buffer is defined by the BufferID. Creates a typed view into a buffer starting at the specified element offset. The offset is measured in elements of the type T, not in bytes. Important: The offset must not exceed t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2b46b2e6be8f
unity_docs
rendering
What is `GUILayout.BeginHorizontal` in Unity? Explain its purpose and usage.
GUILayout.BeginHorizontal Declaration public static void BeginHorizontal (params GUILayoutOption[] options ); Declaration public static void BeginHorizontal ( GUIStyle style , params GUILayoutOption[] options ); Declaration public static void BeginHorizontal (string text , GUIStyle style , params GUI...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8e36fd6e9405
unity_docs
scripting
What is `Animations.AnimatorJobExtensions.BindStreamProperty` in Unity? Explain its purpose and usage.
AnimatorJobExtensions.BindStreamProperty Declaration public static Animations.PropertyStreamHandle BindStreamProperty ( Animator animator , Transform transform , Type type , string property ); Declaration public static Animations.PropertyStreamHandle BindStreamProperty ( Animator animator , Transfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9ce25fd1136f
unity_docs
scripting
Show me a Unity C# example demonstrating `AudioType.OGGVORBIS`.
AudioType.OGGVORBIS Description The audio file you want to stream has the Ogg Vorbis audio file format. Use this enumeration value to ensure the format type of the audio file has the Ogg Vorbis audio file format. Use this audio type for files with the extension .ogg . If the audio file has a different format, Unity...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_432910492e0f
unity_docs
rendering
Explain 'HDR color picker reference' in Unity.
The HDR Color picker looks similar to the ordinary color picker, but it contains additional controls for adjusting the color’s exposure. Property: Function: Mode When using HSV or RGB 0–255 mode, the color picker treats exposure adjustments independently from color channel data. However, the color channel data displaye...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdcbfbb070c1
unity_docs
scripting
Show me a Unity C# example demonstrating `Light.intensity`.
Light.intensity public float intensity ; Description The Intensity of a light is multiplied with the Light color. The value can be between 0 and 8. This allows you to create over bright lights. ```csharp using UnityEngine;public class example : MonoBehaviour { Light myLight; void Start() { myLight = GetCom...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_017b0008af27
unity_docs
rendering
Explain 'GI Cache preferences reference' in Unity.
The Global Illumination (GI) system uses a cache on each computer to store intermediate files used to pre-compute real-time Global Illumination. All projects on the computer share the cache. To open the preferences, go to Edit > Preferences > GI Cache (macOS: Unity > Settings > GI Cache ). Property Function Maximum Cac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0ea2794c6095
unity_docs
editor
What is `Device.SystemInfo.maxComputeWorkGroupSizeZ` in Unity? Explain its purpose and usage.
SystemInfo.maxComputeWorkGroupSizeZ public static int maxComputeWorkGroupSizeZ ; Description This has the same functionality as SystemInfo.maxComputeWorkGroupSizeZ 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_2193fe2fd6ca
unity_docs
scripting
What is `UIElements.Experimental.PointerOverLinkTagEvent.Init` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. PointerOverLinkTagEvent.Init Declaration protected void Init (); Description Resets the event members to their initial values.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8a4a6705cd12
unity_docs
rendering
Explain 'Framebuffer orientation' in Unity.
If your application’s framebuffer orientation doesn’t match the device’s native display orientation (portrait, for most devices), Android rotates the application’s framebuffer to match the device’s display every frame. Depending on the device’s hardware capabilities, this additional rotation can negatively affect perfo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_13a724ea1c7a
unity_docs
networking
In Unity's 'Sentis', what is 'Description' and how does it work?
Sentis is a neural network inference library. It enables you to import trained neural network models, connect the network inputs and outputs to your game code, and then run them locally in your end-user app. Use cases include capabilities like natural language processing, object recognition, automated game opponents, s...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8d1dcda649f6
unity_docs
rendering
What is `AssetImporters.TextureGenerator.GenerateTexture` in Unity? Explain its purpose and usage.
TextureGenerator.GenerateTexture Declaration public static AssetImporters.TextureGenerationOutput GenerateTexture ( AssetImporters.TextureGenerationSettings settings , NativeArray<Color> colorBuffer ); Declaration public static AssetImporters.TextureGenerationOutput GenerateTexture ( AssetImporters.Textur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80a1db07028d
unity_docs
scripting
What is `Events.UnityEventTools.RemovePersistentListener` in Unity? Explain its purpose and usage.
UnityEventTools.RemovePersistentListener Declaration public static void RemovePersistentListener ( Events.UnityEventBase unityEvent , int index ); Declaration public static void RemovePersistentListener ( Events.UnityEventBase unityEvent , Events.UnityAction call ); Declaration public static void Rem...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac6cd1d14cff
unity_docs
ui
What is `Input.ResetInputAxes` in Unity? Explain its purpose and usage.
Input.ResetInputAxes Declaration public static void ResetInputAxes (); Description Resets all input. After ResetInputAxes all axes return to 0 and all buttons return to 0 for one frame. Note : This API is part of the legacy Input Manager. The recommended best practice is that you don't use this API in new proje...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b24e0e438013
unity_docs
editor
In Unity's 'Use the Animation view', what is 'Viewing Animations on a GameObject' and how does it work?
The Animation window is linked to the Hierarchy window, the Project window , the Scene view, and the Inspector window. Like the Inspector, the Animation window shows the timeline and keyframes of the Animation for the currently selected GameObject or Animation Clip Asset. You can select a GameObject using the Hierarchy...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1c45cae65477
unity_docs
rendering
Explain 'Rendering lines' in Unity.
Techniques for rendering individual lines in 3D space, and applying materials to those lines. Topic Description Introduction to line rendering Understand how Unity renders continuous polygon-based lines in 3D space. Draw and configure a line in 3D space Draw a continuous line, and configure its shape and materials. Lin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a14c546a4814
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystem.RotationOverLifetimeModule.xMultiplier`.
ParticleSystem.RotationOverLifetimeModule.xMultiplier public float xMultiplier ; Description Rotation multiplier around the x-axis. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall rotation multiplier. ```csharp using UnityEngine; using System.Co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_70841e446413
unity_docs
physics
Show me a Unity C# example demonstrating `Object.operator_eq`.
in standard C#. In addition to checking if the managed object reference is null , the custom == operator in UnityEngine.Object also checks if the underlying native object pointer is null. If either is true, == null evaluates to true . For more information on why and how some managed objects can exist in a so-ca...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_127d69e00df0
unity_docs
math
Show me a Unity C# example demonstrating `Mesh.AcquireReadOnlyMeshData`.
then modify the Mesh, your modifications are not reflected in the MeshData structs. This method will throw an InvalidOperationException if isReadable is false for one or more input meshes. When working in the Unity Editor, use MeshUtility.AcquireReadOnlyMeshData to skip this check. Use Dispose to dispose of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6f0d24344bb1
unity_docs
rendering
What is `Canvas.GetETC1SupportedCanvasMaterial` in Unity? Explain its purpose and usage.
Canvas.GetETC1SupportedCanvasMaterial Declaration public static Material GetETC1SupportedCanvasMaterial (); Returns Material The generated ETC1 Material from the Canvas. Description Gets or generates the ETC1 Material. Uses the UI/DefaultETC1 Shader which must be specified in the Always Included Shade...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b1868eaf4e7a
unity_docs
scripting
What is `GL.InvalidateState` in Unity? Explain its purpose and usage.
GL.InvalidateState Declaration public static void InvalidateState (); Description Invalidate the internally cached render state. This invalidates any cached render state tied to the active graphics API. If for example a (native) plugin alters the render state settings then Unity's rendering engine must be made ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_492f354b812c_doc_71
github
scripting
What does `AddLocalScale` do in this Unity script? Explain its purpose and signature.
ローカル座標におけるスケーリング値を加算します Signature: ```csharp public void AddLocalScale( float x, float y, float z ) ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_man_76d38b68c6cb
unity_docs
rendering
In Unity's 'Introduction to GPU instancing', what is 'Render pipeline compatibility' and how does it work?
GPU instancing is compatible with all Unity render pipelines , with the following limitations: If you use the Universal Render Pipeline (URP) or High Definition Render Pipeline (HDRP), GPU instancing works with custom shaders only if you disable the Scriptable Render Pipeline (SRP) Batcher or make a shader incompatible...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ac78eb5d3549
unity_docs
rendering
In Unity's 'IMGUI Basics', what is 'Making Controls with IMGUI' and how does it work?
Unity’s IMGUI controls make use of a special function called OnGUI() . The OnGUI() function gets called every frame as long as the containing script is enabled - just like the Update() function. IMGUI controls themselves are very simple in structure. This structure is evident in the following example. ```csharp /* Exam...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5fddc2797be
unity_docs
scripting
What is `ArticulationDrive.targetVelocity` in Unity? Explain its purpose and usage.
ArticulationDrive.targetVelocity public float targetVelocity ; Description The velocity of the body this drive will try to reach. Units of measurement - m/s (meters per second) for linear and rad/s (radians per second) for angular motion.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5edb062da37f
unity_docs
scripting
What is `Search.SearchService.GetActiveProviders` in Unity? Explain its purpose and usage.
SearchService.GetActiveProviders Declaration public static IEnumerable<SearchProvider> GetActiveProviders (); Returns IEnumerable<SearchProvider> Enumerate all active providers. Description Returns all active providers. Active providers can be found in the user search preferences. Globally active provider...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d55d8cea1fb2
unity_docs
editor
What is `Application.IsPlaying` in Unity? Explain its purpose and usage.
Application.IsPlaying Declaration public static bool IsPlaying ( Object obj ); Parameters Parameter Description obj The object to test. Returns bool True if the object is part of the playing world. Description Returns true if the given object is part of the playing world either in any kind of built ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f522b91ce703_doc_11
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Represents an object which can receive twelve arguments as part of its initialization process.-derived classes that implement this interface can be instantiated with their dependency using the function.-derived classes that implement this interface can be added to a with their dependency using the function.If the clas...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_918d715e284f
unity_docs
editor
What is `PlatformIconKind` in Unity? Explain its purpose and usage.
PlatformIconKind class in UnityEditor Description Icon kind wrapper. Each platform implements its own icon kinds. See: AndroidPlatformIconKind , iOSPlatformIconKind and tvOSPlatformIconKind for more information.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3170b1703a7f
unity_docs
scripting
What is `Vector3.operator_add` in Unity? Explain its purpose and usage.
Vector3.operator + public static Vector3 operator + ( Vector3 a , Vector3 b ); Description Adds two vectors. Adds corresponding components together. ```csharp // prints (5.0,7.0,9.0)using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { void Start() { print(new Vector...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_10b860288e9c
unity_docs
scripting
Explain 'Notarize with altool' in Unity.
As of November 1st 2023, Apple have deprecated the use of altool for notarization. You must update your workflow to use notarytool to notarize your macOS applications. For more information, refer to Migrating to the latest notarization tool and Enable notarization on an older version of macOS .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_221713f444a3_doc_3
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Destroys the given GameObject if it is not null, then creates a child GameObject from resources and assigns it to the reference.TComponent will be initialized with the given arguments.Can be null, if it is not then it will be destroyed.The path to the resourced asset.The TArgs object to be passed in on initialization.T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d8d86b49c47a
unity_docs
ui
What is `UIElements.DefaultMultiColumnTreeViewController_1` in Unity? Explain its purpose and usage.
DefaultMultiColumnTreeViewController<T0> class in UnityEngine.UIElements / Inherits from: UIElements.MultiColumnTreeViewController / Implemented in: UnityEngine.UIElementsModule Description Default implementation of a MultiColumnTreeViewController . Constructors Constructor Description DefaultMultiColu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_344d79beafda
unity_docs
scripting
What is `VideoImporterTargetSettings.spatialQuality` in Unity? Explain its purpose and usage.
VideoImporterTargetSettings.spatialQuality public VideoSpatialQuality spatialQuality ; Description Controls an internal image resize, resulting in blurrier images but smaller image dimensions and file size. Any downsize chosen here is done on top of resize options that may have been taken with resizeMode.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a8390d93ef7
unity_docs
audio
What is `AudioEchoFilter.wetMix` in Unity? Explain its purpose and usage.
AudioEchoFilter.wetMix public float wetMix ; Description Volume of echo signal to pass to output. 0.0 to 1.0. Default = 1.0. ```csharp using UnityEngine;[RequireComponent(typeof(AudioSource))] [RequireComponent(typeof(AudioEchoFilter))] public class Example : MonoBehaviour { // Mixes both Echo generated sound...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f4a88457baff
unity_docs
ui
Show me a Unity C# example demonstrating `Editor.DrawDefaultInspector`.
s bool Returns true if any GUI controls in the default Inspector changed the value of the input data, otherwise returns false. Description Draws the built-in Inspector. Call this method, within the OnInspectorGUI method, to automatically draw the Inspector. This is useful if you want to add a few buttons withou...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d500f3a0f79c
unity_docs
scripting
What is `PrefabUtility` in Unity? Explain its purpose and usage.
PrefabUtility class in UnityEditor Description Utility class for any Prefab related operations. ```csharp // This script creates a new menu item Examples>Create Prefab in the main menu. // Use it to create Prefab(s) from the selected GameObject(s). // It is placed in the root Assets folder. using System.IO; using...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_95c71f24d65e_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
FIXME: The lifespan of the is too long due to a bug.So, this can optionally be used to help limit collisions of Contexts.Its likely never needed in a typical game project, but the sample projectcontains dozens of samples each with a mini and when running unit testingthey are not always cleaned up properly automaticall...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_95093ff1838b
unity_docs
rendering
What is `Rendering.EditorGraphicsSettings.albedoSwatches` in Unity? Explain its purpose and usage.
EditorGraphicsSettings.albedoSwatches public static AlbedoSwatchInfo[] albedoSwatches ; Description Returns an array of AlbedoSwatchInfo . The physically based rendering validation tools have a set of built-in albedo values it will validate your materials against. Every game may have different albedo values it...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b6b8f0c4343
unity_docs
editor
What is `Device.SystemInfo.graphicsDeviceVersion` in Unity? Explain its purpose and usage.
SystemInfo.graphicsDeviceVersion public static string graphicsDeviceVersion ; Description This has the same functionality as SystemInfo.graphicsDeviceVersion 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_man_450a18a24f6a
unity_docs
rendering
Explain 'Diffuse' in Unity.
Note. Unity 5 introduced the Standard Shader which replaces this shader . ## Diffuse Properties Diffuse 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 this angle, and does not change as the camera moves...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_893b6b7ede27
unity_docs
scripting
Give me an overview of the `GridBrushBase` class in Unity.
GridBrushBase class in UnityEngine / Inherits from: ScriptableObject / Implemented in: UnityEngine.TilemapModule Description Base class for authoring data on a grid with grid painting tools like paint, erase, pick, select and fill. Inheriting this class and/or creating brush asset instances from your inherite...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_49be8a13e4d9
unity_docs
rendering
What is `Material.isVariant` in Unity? Explain its purpose and usage.
Material.isVariant public bool isVariant ; Returns bool True if the material is a variant. Description Returns true if this material is a material variant. This property is Editor-only. Additional resources: Material.parent .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a3f4957c158c
unity_docs
ui
Explain 'Bind a custom control' in Unity.
Version : 2021.3+ This example demonstrates how to bind a custom control to a native Unity type. ## Example overview The example creates a custom control that displays a 2D image. It uses the custom control in a custom Editor for a new asset type, and it binds the custom control to a field in an asset of the new type...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8a25092b0fa
unity_docs
scripting
What is `GizmoUtility.GetGizmoInfo` in Unity? Explain its purpose and usage.
GizmoUtility.GetGizmoInfo Declaration public static GizmoInfo[] GetGizmoInfo (); Returns GizmoInfo[] A collection of GizmoInfo for all component types in the project. Description Get GizmoInfo for all components with gizmos or icons in the project.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0a212619fc54_doc_1
github
scripting
What does `Initialize` do in this Unity script? Explain its purpose and signature.
Initializes the PoolService with the provided pool configuration and prepares the pools for use.The configuration for the pools. Signature: ```csharp public static void Initialize(PoolConfig poolConfig) ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_275043d89fc5
unity_docs
rendering
What is `Terrain.realtimeLightmapIndex` in Unity? Explain its purpose and usage.
Terrain.realtimeLightmapIndex public int realtimeLightmapIndex ; Description The index of the realtime lightmap applied to this terrain. Additional resources: Renderer.realtimeLightmapIndex .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f87d7a98a2da
unity_docs
editor
What is `Device.Screen.autorotateToPortrait` in Unity? Explain its purpose and usage.
Screen.autorotateToPortrait public static bool autorotateToPortrait ; Description This has the same functionality as Screen.autorotateToPortrait 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_man_0ca05f3015e3
unity_docs
rendering
Explain 'Forward rendering path in the Built-In Render Pipeline' in Unity.
The Forward rendering path renders each GameObject in one or more render passes, depending on the lights that affect the object. Lights themselves are also treated differently by the Forward rendering path, depending on their settings and intensity. For more information, refer to Per-pixel and per-vertex lights . ## R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.