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_b8a7099108a6
unity_docs
ui
What are the parameters of `EditorWindow.ShowNotification` in Unity?
Description Show a notification message. Displays notification message on the window. Unlike message boxes or log messages notification will fade out automatically after some time. Call RemoveNotification to remove it immediately. Show a notification in an editor window. ```csharp // Simple example that shows a notific...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98ce3bda05e8
unity_docs
scripting
What is `Animations.GameObjectRecorder.root` in Unity? Explain its purpose and usage.
GameObjectRecorder.root public GameObject root ; Description The GameObject root of the animated hierarchy. (Read Only) The root is set by the constructor (See: ctor ). You can bind a property from the root, or any of its children. To bind a property, use one of the following methods: BindComponent , Bin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d5c122883603
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.CanOpenAssetInEditor`.
anceID The instance ID of the asset. Returns bool Returns true if Unity can successfully open the asset in the Editor, otherwise returns false. Description Checks if Unity can open an asset in the Editor. Checks if Unity can open a given asset instance in the Editor if AssetDatabase.OpenAsset is executed. N...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e705b5c5f15b
unity_docs
scripting
What is `IMGUI.Controls.MultiColumnHeader.height` in Unity? Explain its purpose and usage.
MultiColumnHeader.height public float height ; Description Customizable height of the multi column header. Default value is MultiColumnHeader.DefaultGUI.defaultHeight as this height makes room the for sorting arrow above the header text. For minimal height use MultiColumnHeader.DefaultGUI.minimumHeight . Add...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9d50a2f50087
unity_docs
scripting
What is `Experimental.GraphView.MiniMap.graphView` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. MiniMap.graphView public Experimental.GraphView.GraphView graphView ; Description The GraphView that the MiniMap is attached to.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3c57364b4fbc
unity_docs
rendering
Give me an overview of the `ReceiveGI` class in Unity.
ReceiveGI enumeration Description This property only takes effect if you enable a global illumination setting such as Baked Global Illumination or Enlighten Realtime Global Illumination for the target Scene. When you enable ReceiveGI, you can determine whether illumination data at runtime will come from Light ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2a1c49adf32
unity_docs
rendering
What are the parameters of `Experimental.Rendering.GraphicsStateCollection.GetVariants` in Unity?
Description Populate given list with shader variants contained in collection. ```csharp using System.Collections.Generic; using UnityEngine; using UnityEngine.Experimental.Rendering;public class GetVariantsExample : MonoBehaviour { public GraphicsStateCollection graphicsStateCollection; void Start() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0712ba9a081
unity_docs
scripting
What is `ManagedStrippingLevel` in Unity? Explain its purpose and usage.
ManagedStrippingLevel enumeration Description Defines how aggressively Unity strips unused managed (C#) code. When Unity builds your game or application it can strip unused code from the managed dynamically linked libraries used in the project. Stripping code can make the resulting executable significantly smaller...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a2f5507145ae
unity_docs
rendering
In Unity's 'Override the mipmap level of a texture', what is 'Use the Priority property' and how does it work?
Follow these steps: Select the texture asset in the Project window. In the Texture Import Settings window, in the Advanced section, set a Priority value between –128 and 127. When Unity needs to reduce mipmap levels to meet the memory limit, it considers textures in priority order from low to high until it meets the li...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1de24d29d3cd
unity_docs
rendering
What is `LightTransport.ReferenceContext.ReadBuffer` in Unity? Explain its purpose and usage.
ReferenceContext.ReadBuffer Declaration public void ReadBuffer (BufferSlice<T> src , NativeArray<T> dst ); Declaration public void ReadBuffer (BufferSlice<T> src , NativeArray<T> dst , LightTransport.EventID id ); Parameters Parameter Description src The buffer slice to read from. dst The array i...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_951f3fff3de9
unity_docs
rendering
What is `MaterialEditor.HelpBoxWithButton` in Unity? Explain its purpose and usage.
MaterialEditor.HelpBoxWithButton Declaration public bool HelpBoxWithButton ( GUIContent messageContent , GUIContent buttonContent ); Parameters Parameter Description messageContent The message text. buttonContent The button text. Returns bool Returns true, if button was pressed. Description Mak...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fa36b65410d9
unity_docs
rendering
What is `Experimental.Video.VideoClipPlayable.Create` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. VideoClipPlayable.Create Declaration public static Experimental.Video.VideoClipPlayable Create ( Playables.PlayableGraph graph , Video.VideoClip clip , bool looping ); Parameters Parameter Description graph The Pl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a2daca58dc4c
unity_docs
editor
What is `MPE.ChannelClientInfo` in Unity? Explain its purpose and usage.
ChannelClientInfo struct in UnityEditor.MPE Description A structure that contains all of a ChannelClient 's connection data. Properties Property Description clientId The channel's channel ID (see ChannelClient.clientId). connectionId The ChannelClient's connection ID. name The ChannelClient's name (see Chan...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c6ad265e9ead
unity_docs
rendering
What is `Light.bounceIntensity` in Unity? Explain its purpose and usage.
Light.bounceIntensity public float bounceIntensity ; Description The multiplier that defines the strength of the bounce lighting. 0 means no bounce light (only direct lighting) will be produced. 1 is physically correct behaviour and the default. The intensity of indirect lighting scales the same with the inten...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7018bef319b8
unity_docs
physics
What is `ParticleSystem.Burst.probability` in Unity? Explain its purpose and usage.
ParticleSystem.Burst.probability public float probability ; Description The probability that the system triggers a burst. Set this value between 0 and 1. Higher values increase the probability that the system triggers a burst.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_37be28b21728
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.enableGPUInstancing`.
ParticleSystemRenderer.enableGPUInstancing public bool enableGPUInstancing ; Description Enables GPU Instancing on platforms that support it. To use GPU Instancing to render a Particle System, the particle must use a Shader that contains a Procedural Instancing pass (that is, it contains the #pragma instancing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab8b20828533
unity_docs
scripting
What are the parameters of `EditorGUI.CurveField` in Unity?
Returns AnimationCurve The curve edited by the user. Description Makes a field for editing an AnimationCurve . Curve field in an Editor Window. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEditor;public class EditorGUICurveField : EditorWindow { AnimationCurve ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a122694d8816
unity_docs
scripting
What is `Networking.UnityWebRequest.Put` in Unity? Explain its purpose and usage.
UnityWebRequest.Put Declaration public static Networking.UnityWebRequest Put (string uri , byte[] bodyData ); Declaration public static Networking.UnityWebRequest Put (string uri , string bodyData ); Declaration public static Networking.UnityWebRequest Put (Uri uri , byte[] bodyData ); Declara...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_96b337900248
unity_docs
rendering
Give me an overview of the `SketchUpImportScene` class in Unity.
SketchUpImportScene struct in UnityEditor Description Structure to hold scene data extracted from a SketchUp file. When importing a SketchUp file, Unity retrieves all the scenes in the SketchUp file. This can be extracted later from SketchUpImporter with SketchUpImporter.GetScenes . Properties Property Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_86754d34efea
unity_docs
scripting
What is `UIElements.UxmlLongAttributeDescription.GetValueFromBag` in Unity? Explain its purpose and usage.
UxmlLongAttributeDescription.GetValueFromBag Declaration public long GetValueFromBag ( UIElements.IUxmlAttributes bag , UIElements.CreationContext cc ); Parameters Parameter Description bag The bag of attributes. cc The context in which the values are retrieved. Returns long The value of the attrib...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c3f3a0d18f01
unity_docs
editor
What is `ChangeSceneEventArgs` in Unity? Explain its purpose and usage.
ChangeSceneEventArgs struct in UnityEditor Description A change of this type indicates that an open scene has been changed ("dirtied") without any more specific information available. This happens for example when EditorSceneManager.MarkSceneDirty is used. Properties Property Description scene The Scene that...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_912e4714f71c
unity_docs
scripting
What is `AudioSource.spread` in Unity? Explain its purpose and usage.
AudioSource.spread public float spread ; Description Sets the spread angle (in degrees) of a 3d stereo or multichannel sound in speaker space. 0 = all sound channels are located at the same speaker location and is 'mono'. 360 = all subchannels are located at the opposite speaker location to the speaker locatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17f017054a63
unity_docs
audio
What is `Video.VideoPlayer.controlledAudioTrackCount` in Unity? Explain its purpose and usage.
VideoPlayer.controlledAudioTrackCount public ushort controlledAudioTrackCount ; Description Number of audio tracks that this VideoPlayer will take control of. The other audio tracks will be silent. The maximum allowed number of tracks is defined by VideoPlayer.controlledAudioTrackMaxCount . The actual number...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_264af0db1c5a
unity_docs
rendering
Show me a Unity code example for 'Tri-planar texturing shader example in the Built-In Render Pipeline'.
For complex or procedural meshes, instead of texturing them using the regular UV coordinates, it is sometimes useful to just “project” texture onto the object from three primary directions. This is called “tri-planar” texturing. The idea is to use surface normal to weight the three texture directions. Here’s the shader...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d2282724efda
unity_docs
physics
Show me a Unity C# example demonstrating `VersionControl.Provider.Submit`.
f the changeset. saveOnly If true then only save the changeset to be submitted later. Description Starts a task that submits the assets to version control. In version control systems like Git new changes have to be committed and then pushed to the repository separately. In Perforce or Plastic SCM a submit is an al...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_44a49018df76
unity_docs
scripting
What is `SceneManagement.SceneManager.GetSceneByName` in Unity? Explain its purpose and usage.
SceneManager.GetSceneByName Declaration public static SceneManagement.Scene GetSceneByName (string name ); Parameters Parameter Description name Name of Scene to find. Returns Scene A reference to the Scene, if valid. If not, an invalid Scene is returned. Description Searches through the Scenes loa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_56dc9d3c9b24
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.GetComponentsInParent`.
then call GetComponentsInParent on that reference. Note : If the type you request is a derivative of MonoBehaviour and the associated script can't be loaded then this function will return `null` for that component. The following example gets a reference to all hinge joint components on the same GameObject as the scri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_333264a8a5b2
unity_docs
scripting
What is `UIElements.NavigationEventBase_1` in Unity? Explain its purpose and usage.
NavigationEventBase<T0> class in UnityEngine.UIElements / Inherits from: UIElements.EventBase_1 / Implemented in: UnityEngine.UIElementsModule Implements interfaces: INavigationEvent Description Navigation events abstract base class. By default, navigation events trickle down and bubble up. Disabled element...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72d8103fbf5e
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.NoiseModule.remapZ`.
ParticleSystem.NoiseModule.remapZ public ParticleSystem.MinMaxCurve remapZ ; Description Define how the noise values are remapped on the z-axis, when using the ParticleSystem.NoiseModule.separateAxes option. Additional resources: MinMaxCurve . ```csharp using UnityEngine; using System.Collections;[Requir...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c7987b16db0e
unity_docs
scripting
Explain 'Enable automatic snapping to grid' in Unity.
When you enable automatic grid snapping, the Move , Rotate , and Scale transform tools snap the selected GameObject to the grid along the active gizmo axis. If you want the GameObject to move in smaller increments, you can modify the values it uses to transform incrementally . To enable automatic snapping to the grid: ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4076fe9a13c5
unity_docs
scripting
What is `Experimental.GraphView.GraphViewMinimapWindow` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphViewMinimapWindow class in UnityEditor.Experimental.GraphView / Inherits from: Experimental.GraphView.GraphViewToolWindow Description A floating window containing a MiniMap. Properties Property Description ToolName T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6b45bb08fd0c
unity_docs
ui
What is `UIElements.Clickable.clickedWithEventInfo` in Unity? Explain its purpose and usage.
Clickable.clickedWithEventInfo Description Callback triggered when the target element is clicked, including event data. Encapsulates a method that has an EventBase parameter and does not return a value. ```csharp using UnityEngine; using UnityEngine.UIElements;[RequireComponent(typeof(UIDocument))] public ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_200c1b66d3d6
unity_docs
math
What is `Mesh.SetBindposes` in Unity? Explain its purpose and usage.
Mesh.SetBindposes Declaration public void SetBindposes (NativeArray<Matrix4x4> poses ); Parameters Parameter Description poses The array of bind poses to assign to the Mesh. Description Sets the bind poses of the Mesh. The bind pose at each index corresponds to the bone with the same index. Additional re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b206457ba3f1
unity_docs
rendering
What is `TerrainLayer.diffuseRemapMax` in Unity? Explain its purpose and usage.
TerrainLayer.diffuseRemapMax public Vector4 diffuseRemapMax ; Description A Vector4 value specifying the maximum RGBA value that the diffuse texture maps to when the value of the channel is 1.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4c47819cccfb
unity_docs
physics
What is `MonoBehaviour.OnTriggerStay2D` in Unity? Explain its purpose and usage.
MonoBehaviour.OnTriggerStay2D(Collider2D) Parameters Parameter Description other The other Collider2D involved in this collision. Description Sent once per physics update when another object is within a trigger collider attached to this object (2D physics only). Further information about the other collider is...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e77077f89d62
unity_docs
physics
What is `ParticleSystemForceField.directionY` in Unity? Explain its purpose and usage.
ParticleSystemForceField.directionY public ParticleSystem.MinMaxCurve directionY ; Description Apply a linear force along the local Y axis to particles within the volume of the Force Field. Additional resources: ParticleSystemForceField .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_69bfa0dc08b5
unity_docs
scripting
What is `ShortcutManagement.ShortcutBinding.Equals` in Unity? Explain its purpose and usage.
ShortcutBinding.Equals Declaration public bool Equals ( ShortcutManagement.ShortcutBinding other ); Parameters Parameter Description other The ShortcutBinding to compare to this instance. Returns bool true if the value of the other parameter is the same as the value of this instance; otherwise, fal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_383225aec735_doc_1
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Enable fallback to head tracking if eye tracking is unavailable. Signature: ```csharp public bool fallbackIfEyeTrackingUnavailable ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_20808fcfcf7c
unity_docs
xr
In Unity's 'Unity XR Input', what is 'Accessing input devices' and how does it work?
An InputDevice represents any physical device, such as a controller, mobile phone, or headset. It can contain information about device tracking, buttons, joysticks, and other input controls. For more information on the InputDevice API, see documentation on InputDevice . Use the XR.InputDevices class to access input dev...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_51e78ac5660c
unity_docs
rendering
Show me a Unity C# example demonstrating `EditorGUIUtility.PingObject`.
ation public static void PingObject (int targetInstanceID ); Parameters Parameter Description obj The object to be pinged. Description Ping an object in the Scene like clicking it in an inspector. PingObject will cause the Hierarchy to highlight the pinged object. The pinged object does not have to be sel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d561e1163de6
github
scripting
Write a Unity C# script called Test Action
```csharp using UnityEngine; using System.Collections; namespace Goon.AI.Test { public class TestAction : AIAction { public string actionText = ""; private bool complete = false; public override void Perform() { Debug.Log(actionText); complete = true; ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5dcbe7c3fc8a
unity_docs
scripting
What are the parameters of `SceneManagement.SceneManager.sceneUnloaded` in Unity?
Description Add a delegate to this to get notifications when a Scene has unloaded. Rather than being called directly this script code shows use of a delegate. This means the sceneUnloaded value is added into a list of delegates. In the script example below a method call is shown. Specifically a function called OnScene...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e4cc6d974167
unity_docs
rendering
In Unity's 'Store light direction with Directional Mode', what is 'Using Directional Mode with additive loading' and how does it work?
Unity can load Scenes additively. This means you can use Multi-Scene editing , for example. When you load Scenes additively, all of them must use the same Directional Mode. This includes Scenes that are not baked, such as UI elements or loading screens. Using the same Lightmap Parameters asset for all of the Scenes in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f0a9e6b5a96b
unity_docs
rendering
What is `Renderer.isPartOfStaticBatch` in Unity? Explain its purpose and usage.
Renderer.isPartOfStaticBatch public bool isPartOfStaticBatch ; Description Indicates whether the renderer is part of a static batch with other renderers. Unity sets this flag after it generates the static batch that contains the renderer. Be aware that Unity generates static batches at different times for th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e7fdb6c05a86
unity_docs
scripting
What is `Video.VideoPlayer.canSetPlaybackSpeed` in Unity? Explain its purpose and usage.
VideoPlayer.canSetPlaybackSpeed public bool canSetPlaybackSpeed ; Description Whether you can change the playback speed. (Read Only) This value is only valid after the movie has been prepared. See VideoPlayer.Prepare .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34bcd1df7416
unity_docs
input
What is `Playables.PlayableGraph.Disconnect` in Unity? Explain its purpose and usage.
PlayableGraph.Disconnect Declaration public void Disconnect (U input , int inputPort ); Parameters Parameter Description input The source playabe or its handle. inputPort The port used in the source playable. Description Disconnects the Playable . The connections determine the topology of the Playable...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_596b62985950
unity_docs
scripting
Give me an overview of the `AndroidJavaProxy` class in Unity.
AndroidJavaProxy class in UnityEngine / Implemented in: UnityEngine.AndroidJNIModule Description This class can be used to implement any java interface. Any java vm method invocation matching the interface on the proxy object will automatically be passed to the c# implementation. Note : this API can be used fro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_49d7554b6575_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Class to handle polling a register address over ModBus. Signature: ```csharp public class ModBusPoll ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_d32d072f5180
unity_docs
scripting
What is `ClipboardUtility.cuttingGameObjects` in Unity? Explain its purpose and usage.
ClipboardUtility.cuttingGameObjects Parameters Parameter Description value An array containing the GameObjects that will be cut. Description Event triggered before the selected GameObjects are cut to the clipboard. Occurs after the selected GameObjects have been optionally filtered through canCutGameObject .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0701a98d159
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchIndexer.keywordCount`.
SearchIndexer.keywordCount public int keywordCount ; Description Returns the number keywords in the index. ```csharp using UnityEditor; using UnityEditor.Search; using UnityEngine; static class Example_SearchIndexer_keywordCount { [MenuItem("Examples/SearchIndexer/keywordCount")] public static void Run() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_47828d3edc62
github
scripting
Write a Unity C# XR/VR script for Velocities From Transform
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; using UnityEngine.XR; public class VelocitiesFromTransform : MonoBehaviour { public Vector3 Velocity { get; private set; } public Vector3 AngularVelocity { get; private set; } private float HistoryTimePeriod = 0.125...
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_3dfa564c33ca
unity_docs
scripting
What is `Assertions.Assert.AreNotEqual` in Unity? Explain its purpose and usage.
Assert.AreNotEqual Declaration public static void AreNotEqual ( Object expected , Object actual , string message ); Declaration public static void AreNotEqual (sbyte expected , sbyte actual ); Declaration public static void AreNotEqual (sbyte expected , sbyte actual , string message ); Declarat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_17fa7f697453
unity_docs
scripting
What is `MPE.ChannelClientScope.ctor` in Unity? Explain its purpose and usage.
ChannelClientScope Constructor Declaration public ChannelClientScope (bool autoTick , string channelName , Action<string> handler , bool closeClientOnExit ); Declaration public ChannelClientScope (bool autoTick , string channelName , Action<byte[]> handler , bool closeClientOnExit ); Parameters Param...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_52abda0596cf
unity_docs
math
Show me a Unity C# example demonstrating `Matrix4x4.TRS`.
Matrix4x4.TRS Declaration public static Matrix4x4 TRS ( Vector3 pos , Quaternion q , Vector3 s ); Description Creates a translation, rotation and scaling matrix. The returned matrix is such that it places objects at position pos , oriented in rotation q and scaled by s . ```csharp using UnityEngi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a934fa16717
unity_docs
input
What is `LocationService.Start` in Unity? Explain its purpose and usage.
LocationService.Start Declaration public void Start (); Declaration public void Start (float desiredAccuracyInMeters ); Declaration public void Start (float desiredAccuracyInMeters , float updateDistanceInMeters ); Parameters Parameter Description desiredAccuracyInMeters The service accuracy you wa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c936b87beb18
unity_docs
scripting
What is `Experimental.GraphView.StickyNoteChange.FontSize` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. StickyNoteChange.FontSize Description Specify that the size of the font used by the [StickyNote] has changed.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ecac194c16fb_doc_12
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Allows accessing the geographic API endpoints to position objects on the map. Signature: ```csharp public GeographicApi GeographicApi ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_951f68b02d88
unity_docs
scripting
What is `Tools.viewToolActive` in Unity? Explain its purpose and usage.
Tools.viewToolActive public static bool viewToolActive ; Description Returns true if the active tool is a view or navigation tool. Use this property to determine whether a tool should consume the current Event .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2300d3ebd89f
unity_docs
scripting
What is `WSA.Launcher.LaunchFileWithPicker` in Unity? Explain its purpose and usage.
Launcher.LaunchFileWithPicker Declaration public static void LaunchFileWithPicker (string fileExtension ); Parameters Parameter Description fileExtension File extension. Description Opens a dialog for picking the file.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_287a40876f58
unity_docs
scripting
What is `Experimental.ArtifactKey.importerType` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ArtifactKey.importerType public Type importerType ; Description The managed type of the importer to use for producing the artifact.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a62ce8a24e5a
unity_docs
editor
What are the parameters of `AssetDatabase.GetImplicitAssetBundleName` in Unity?
Returns string Returns the name of the AssetBundle that a given asset belongs to. See the method description for more details. Description Returns the name of the AssetBundle that a given asset belongs to. If the asset has been explicitly assigned to an AssetBundle, then that value is returned. If the asset doesn't bel...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2dba28191df9
unity_docs
editor
What is `Compilation.AssemblyBuilderFlags` in Unity? Explain its purpose and usage.
AssemblyBuilderFlags enumeration Description Flags used by AssemblyBuilder to control assembly build. Properties Property Description None None value. Default. EditorAssembly Defines whether the output assembly is an editor assembly. DevelopmentBuild Defines whether the output assembly is an development build...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e424012bf335
unity_docs
scripting
What is `Video.VideoClip.sRGB` in Unity? Explain its purpose and usage.
VideoClip.sRGB public bool sRGB ; Description Whether the imported clip contains sRGB color data (Read Only). This setting controls whether sRGB->Linear color space conversion is done when the VideoPlayer is loading the video data into textures. This setting is only relevant when Linear color space is used....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5c4f834b48ac
unity_docs
editor
What is `TakeInfo` in Unity? Explain its purpose and usage.
TakeInfo struct in UnityEditor Description A Takeinfo object contains all the information needed to describe a take. Additional resources: ModelImporter.importedTakeInfos . Properties Property Description bakeStartTime Start time in second. bakeStopTime Stop time in second. defaultClipName This is the defa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_69394b8f4af4
unity_docs
rendering
Explain 'Toggle shader keywords in the Editor' in Unity.
To toggle shader keywords in the Editor, add a material property for the keyword. This allows you to set different keyword states for different materials without needing to use code. Follow these steps: Add _ON to the end of the keyword you declare. For example, change _RED to _RED_ON . Make sure you update your branch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_50fd7276b53b
unity_docs
rendering
What is `ModelImporter.materialLocation` in Unity? Explain its purpose and usage.
ModelImporter.materialLocation public ModelImporterMaterialLocation materialLocation ; Description Material import location options. When importing a new model, Unity imports materials as either external assets or sub-assets, based on this property. Additional resources: ModelImporterMaterialLocation .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e28094cbb548
unity_docs
editor
Show me a Unity C# example demonstrating `PrefabUtility.GetCorrespondingObjectFromOriginalSource`.
mple scenario, if you supply the instance of GameObject C as the componentOrGameObject parameter to GetCorrespondingObjectFromOriginalSource , then the method returns the asset C. For more information about source objects, refer to Introduction to prefabs . The following example adds a menu item to the Editor, whic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39899091886d
unity_docs
editor
What is `EditorCurveBinding.DiscreteCurve` in Unity? Explain its purpose and usage.
EditorCurveBinding.DiscreteCurve Declaration public static EditorCurveBinding DiscreteCurve (string inPath , Type inType , string inPropertyName ); Parameters Parameter Description inPath The transform path to the object to animate. inType The type of the object to animate. inPropertyName The name of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e19eafebeb0c
unity_docs
audio
What is `AudioSource.playOnAwake` in Unity? Explain its purpose and usage.
AudioSource.playOnAwake public bool playOnAwake ; Description Enable this property to automatically play the audio source when the component or GameObject becomes active. If you enable this property and the GameObject isn't active or if the AudioSource component is disabled, the audio won't play until they bec...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8348234fd1e7
unity_docs
math
What is `Graphics.RenderPrimitives` in Unity? Explain its purpose and usage.
Graphics.RenderPrimitives Declaration public static void RenderPrimitives (ref RenderParams rparams , MeshTopology topology , int vertexCount , int instanceCount = 1); Parameters Parameter Description rparams The parameters Unity uses to render the primitives. topology Primitive topology (for examp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_5e4dfe6fc88a
github
scripting
Write a Unity C# physics script for Game Deck Trigger
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; public class GameDeckTrigger : MonoBehaviour { private Solitaire solitaire; void Start() { solitaire = FindObjectOfType<Solitaire>(); } void OnTriggerEnter(Collider other) { // print("Touchi...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_f7d12d4d407d
unity_docs
scripting
What is `AudioType.AUDIOQUEUE` in Unity? Explain its purpose and usage.
AudioType.AUDIOQUEUE Description The audio file you want to stream uses Apple’s Audio Queue file format. Use Apple’s Audio Queue audio type to stream an AAC, ALAC or MP3 file on iOS or macOS. Extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure. Use this type to stream files with the extension...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4e07b5b166fd
unity_docs
scripting
What is `UIElements.BaseVerticalCollectionView.virtualizationMethod` in Unity? Explain its purpose and usage.
BaseVerticalCollectionView.virtualizationMethod public UIElements.CollectionVirtualizationMethod virtualizationMethod ; Description The virtualization method to use for this collection when a scroll bar is visible. Takes a value from the CollectionVirtualizationMethod enum. The default value is FixedH...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55c69264a8fa
unity_docs
physics
What is `MonoBehaviour.IsInvoking` in Unity? Explain its purpose and usage.
MonoBehaviour.IsInvoking Declaration public bool IsInvoking (string methodName ); Description Is any invoke on methodName pending? ```csharp using UnityEngine; using System.Collections.Generic;// Instantiates a projectile two seconds after the spacebar was pressed. // LaunchProjectile is called when a previ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ccc22ef019bc
unity_docs
performance
What is `Profiling.ProfilerTimeSampleSelection.ctor` in Unity? Explain its purpose and usage.
ProfilerTimeSampleSelection Constructor Declaration public ProfilerTimeSampleSelection (long frameIndex , string threadGroupName , string threadName , ulong threadId , int rawSampleIndex , string sampleName ); Declaration public ProfilerTimeSampleSelection (long frameIndex , string threadGroupName , stri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab53759a9e7e
unity_docs
animation
What is `MatchTargetWeightMask` in Unity? Explain its purpose and usage.
MatchTargetWeightMask struct in UnityEngine / Implemented in: UnityEngine.AnimationModule Description Use this struct to specify the position and rotation weight mask for Animator.MatchTarget . Properties Property Description positionXYZWeight Position XYZ weight. rotationWeight Rotation weight. Construct...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_82d82d432490
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.IsPowerOfTwo`.
Mathf.IsPowerOfTwo Declaration public static bool IsPowerOfTwo (int value ); Description Returns true if the value is power of two. ```csharp using UnityEngine;public class Example : MonoBehaviour { void Start() { // prints false Debug.Log(Mathf.IsPowerOfTwo(7)); // prints true Debug.Log(Mathf.IsPowerOfT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e92c62ea086a
unity_docs
physics
Explain 'Configurable Joint component reference' in Unity.
Configurable Joints incorporate all the functionality of the other joint types and provide greater control of character movement. They are particularly useful when you want to customize the movement of a ragdoll and enforce certain poses on your characters. You can also use them to adapt joints into highly specialized ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fdbf258027a7
unity_docs
editor
What is `Device.Screen.autorotateToLandscapeLeft` in Unity? Explain its purpose and usage.
Screen.autorotateToLandscapeLeft public static bool autorotateToLandscapeLeft ; Description This has the same functionality as Screen.autorotateToLandscapeLeft 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.
gh_1e9002985791_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
The display name in the PlayMode Inspector titlebar.It displays "TypeName.MethodName" by default, the displayName property allows you to override it. Signature: ```csharp public string displayName ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6987e31937a6
unity_docs
physics
Explain 'Particle physics forces' in Unity.
Understand how the Particle System can simulate physics forces that act on a particle. ## Force over lifetime The Force over Lifetime module can change the strength of simulated physics forces on a particle based on how long the particle has existed. Fluids are often affected by forces as they move. For example, smok...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0a921f49de4a
unity_docs
scripting
What are the parameters of `Handles.Label` in Unity?
Description Creates a text label for a handle that is positioned in 3D space. Labels have no user interaction and canot be clicked on. Labels are always rendered in normal style. Label in the Scene view. ```csharp //This script is not an Editor script //Attach this script to a GameObject in your Sceneusing System.Colle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75f987631135
unity_docs
scripting
Give me an overview of the `ISerializationCallbackReceiver` class in Unity.
ISerializationCallbackReceiver interface in UnityEngine Description Interface for receiving callbacks before serialization and after deserialization, to process datatypes that can't otherwise be serialized or deserialized. The Unity serializer can automatically serialize most data types, but not all of them. In c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_53abcc11c1a9
unity_docs
animation
What is `Animations.IConstraint.locked` in Unity? Explain its purpose and usage.
IConstraint.locked public bool locked ; Description Lock or unlock the offset and position at rest. In Edit mode, unlock the constraint to update its offsets. In Play mode, the constraint is always locked.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a557ea50a218
unity_docs
xr
In Unity's 'Mesh data for deformable meshes', what is 'Blend shapes' and how does it work?
Blend shapes describe versions of the mesh that are deformed into different shapes. Unity interpolates between these shapes. You use blend shapes for morph target animation , which is a common technique for facial animation. Blend shape data is stored as blend shape vertices. Blend shape data is “sparse”. This means th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3077eadeef54
unity_docs
rendering
What is `Texture2D.activeMipmapLimit` in Unity? Explain its purpose and usage.
Texture2D.activeMipmapLimit public int activeMipmapLimit ; Description The number of high resolution mipmap levels from the texture that Unity doesn't upload to the GPU. (Read Only) Unity takes a texture's mipmap limit settings into account to determine its active mipmap limit that affects how many texture mipm...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ced1feb2f017
unity_docs
scripting
What is `Experimental.GraphView.GraphElement.ResetLayer` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphElement.ResetLayer Declaration public void ResetLayer (); Description Reset the GraphElement to its original layer.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e29a9300b623
unity_docs
editor
In Unity's 'Web development and publishing process', what is 'Profile and optimize' and how does it work?
Before you publish, gather performance metrics and reduce the build size to make a project that runs smoothly with the best quality possible. Use the Unity Profiler to get performance data and refer to Optimize your Web build and Optimize Web platform for mobile .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_dd77601fc3da
github
scripting
Write a Unity C# XR/VR script for XR Poke Follow Affordance
```csharp using Unity.Mathematics; using Unity.XR.CoreUtils.Bindings; using UnityEngine.XR.Interaction.Toolkit.AffordanceSystem.State; using UnityEngine.XR.Interaction.Toolkit.Filtering; using UnityEngine.XR.Interaction.Toolkit.Utilities.Tweenables.Primitives; namespace UnityEngine.XR.Interaction.Toolkit.Samples.Star...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_d2da48249403
unity_docs
scripting
In Unity's 'Create a bindable custom control', what is 'Create the custom control class' and how does it work?
Create a C# class to define the custom control. Create a Unity project with any template. Create a folder named ExampleField to store your files. In the ExampleField folder, create a C# script named ExampleField.cs and replace its content with the following: ```csharp using UnityEngine.UIElements; namespace UIToolkitE...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_07e8664f17ce
unity_docs
scripting
What are the parameters of `Unity.Collections.LowLevel.Unsafe.UnsafeUtility.Malloc` in Unity?
Returns void* A pointer to the allocated memory block. Manage this pointer carefully to prevent memory leaks and ensure proper deallocation. Description Allocates a block of memory of a specified size and alignment. The Malloc method allocates a block of unmanaged memory. It allows developers to specify the size in byt...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e855d354f8c9
unity_docs
scripting
What is `UIElements.Painter2D.strokeGradient` in Unity? Explain its purpose and usage.
Painter2D.strokeGradient public Gradient strokeGradient ; Description The stroke gradient to use when using Stroke. Setting a stroke gradient will override the currently set strokeColor. Setting a null stroke gradient will remove it and fall back on the currently set strokeColor.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_54353a829919
unity_docs
editor
What is `AssetDatabase.IsForeignAsset` in Unity? Explain its purpose and usage.
AssetDatabase.IsForeignAsset Declaration public static bool IsForeignAsset ( Object obj ); Declaration public static bool IsForeignAsset (int instanceID ); Parameters Parameter Description obj The object of the asset. entityId The EntityID of the asset. instanceID The InstanceID of the asset. Retu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_97f59799f4b3
unity_docs
rendering
What is `LineRenderer.widthMultiplier` in Unity? Explain its purpose and usage.
LineRenderer.widthMultiplier public float widthMultiplier ; Description Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(LineRenderer))] public class ExampleClass : MonoB...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9daafbed93bd
unity_docs
scripting
What is `Search.ParsedQuery_2.Apply` in Unity? Explain its purpose and usage.
ParsedQuery<T0,T1>.Apply Declaration public IEnumerable<TData> Apply (TPayload payload ); Parameters Parameter Description payload The data to filter. Returns IEnumerable<TData> A filtered IEnumerable. Description Applies the filtering on a payload.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_560a31e145e3
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.SearchViewFlags.EnableSearchQuery`.
SearchViewFlags.EnableSearchQuery Description This flag enables the use of the Saved Searches workflow in the Search Picker window. This flag is not set by default. When it is not set, the Search Picker window will not show any panel or button related to the Saved Searches workflow. The flag OpenLeftSidePanel wil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c07f3b5aab2a
unity_docs
performance
What is `Unity.IO.LowLevel.Unsafe.ReadCommandArray` in Unity? Explain its purpose and usage.
ReadCommandArray struct in Unity.IO.LowLevel.Unsafe / Implemented in: UnityEngine.CoreModule Description An array of ReadCommand instances to pass to AsyncReadManager.Read and AsyncReadManager.ReadDeferred . To create a ReadCommandArray object, use UnsafeUtility.Malloc to allocate an array of ReadCommand...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_d881f0a6e318
unity_docs
rendering
In Unity's 'Create a quad mesh via script', what is 'Vertex array' and how does it work?
The first thing you need to do is set up the array of vertices that your shape uses. This example assumes that the quad lies on the x-axis and y-axis, and that your script contains the variables width and height. ``` Vector3[] vertices = new Vector3[4] { new Vector3(0, 0, 0), new Vector3(width, 0, 0), new Vector3(0,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14225f5cfdc4
unity_docs
scripting
What are the parameters of `Handles.DrawWireArc` in Unity?
Description Draws a circular arc in 3D space. The Handles.color and Handles.matrix properties colorize and additionally transform the arc position. Unity ignores DrawWireArc (that is, nothing happens) when the current GUI event type is not Repaint . Wire Arc in the Scene View. ```csharp using UnityEditor; using UnityEn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57974ea7428a
unity_docs
rendering
What is `TerrainTools.TerrainPaintUtility.CollectNormals` in Unity? Explain its purpose and usage.
TerrainPaintUtility.CollectNormals Declaration public static TerrainTools.PaintContext CollectNormals ( Terrain terrain , Rect boundsInTerrainSpace , int extraBorderPixels = 0, bool fillOutsideTerrain = true); Parameters Parameter Description terrain Reference Terrain tile. boundsInTerrainSpace T...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.