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_720a697dd3df
unity_docs
scripting
Show me a Unity C# example demonstrating `SphereCollider.radius`.
SphereCollider.radius public float radius ; Description The radius of the sphere measured in the object's local space. The sphere radius will be scaled by the transform's scale. ```csharp using UnityEngine;//Always attach a SphereCollider component to your GameObject public class Example : MonoBehaviour { //...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c11b58a3608
unity_docs
ui
Show me a Unity C# example demonstrating `Time.timeSinceLevelLoad`.
Time.timeSinceLevelLoad public static float timeSinceLevelLoad ; Description The time in seconds since the last non-additive scene finished loading (Read Only). This behaves in the same way as Time.time with a negative offset. ```csharp //Attach this script to a GameObject //Create a Button (Create>UI>Button...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_178849ba040b
unity_docs
editor
What are the parameters of `QualitySettings.GetActiveQualityLevelsForPlatformCount` in Unity?
Returns int The total amount of Quality Levels active for the given platform. Description [Editor Only] Obtains the number of Quality Levels that are selected for a given platform. ```csharp public int GetActiveActiveQualityLevelsForPlatform(BuildTarget platform) { var activeBuildTargetGroup = BuildPipeline.GetBuil...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0f18655685f9
unity_docs
math
Show me a Unity C# example demonstrating `Light.color`.
Light.color public Color color ; Description Specifies the color emitted by the light. To modify the light intensity you change the light's color luminance. Lights always add illumination, so a light with a black color is the same as no light at all. For more information, refer to Light component . ```csha...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90473f3a3f04
unity_docs
rendering
What is `NVIDIA.DLSSCommandInitializationData` in Unity? Explain its purpose and usage.
DLSSCommandInitializationData struct in UnityEngine.NVIDIA / Implemented in: UnityEngine.NVIDIAModule Description Represent the initialization state of a DLSSContext . You can only use and set this when calling GraphicsDevice.CreateFeature . Properties Property Description featureFlags Bit mask containing ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fccf7b9476a5
unity_docs
scripting
What is `UIElements.SerializedObjectChangeEvent` in Unity? Explain its purpose and usage.
SerializedObjectChangeEvent class in UnityEditor.UIElements / Inherits from: UIElements.EventBase_1 Description An event sent when any value in a SerializedObject changes Properties Property Description changedObject The SerializedObject whose value changed. Constructors Constructor Description Se...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1c5696b324c
unity_docs
physics
What is `ColliderDistance2D.distance` in Unity? Explain its purpose and usage.
ColliderDistance2D.distance public float distance ; Description Gets the distance between two colliders. The distance between two colliders is defined as the length of a Vector2 between pointA and pointB . The distance between these points can be positive indicating that the Collider2D are separated (n...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9a2ee467173
unity_docs
scripting
What is `Application.streamingAssetsPath` in Unity? Explain its purpose and usage.
Application.streamingAssetsPath public static string streamingAssetsPath ; Description The path to the StreamingAssets folder (Read Only). Use the StreamingAssets folder to store assets. Create it in your project at Assets/StreamingAssets . At runtime, Application.streamingAssetsPath provides the path to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f16b900f5297
github
scripting
Write a Unity C# script called Logger
```csharp using System.Linq; using TMPro; using UnityEngine; using System; using UnityEngine.UI; namespace LearnXR.Core { public class Logger : Singleton<Logger> { [SerializeField] private TextMeshProUGUI debugAreaText = null; [SerializeField] private bool enableDebug = false;...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_1fc61294f464
unity_docs
scripting
In Unity's 'Text Mesh component reference', what is 'Text Mesh properties' and how does it work?
Property: Function: Text The text that will be rendered Offset Z How far should the text be offset from the transform.position.z when drawing Character Size The size of each character (This scales the whole text.) Line Spacing How much space will be in-between lines of text. Anchor Which point of the text shares the po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9be696e209d4
unity_docs
scripting
What is `Video.VideoPlayer.url` in Unity? Explain its purpose and usage.
VideoPlayer.url public string url ; Description The file URL or web URL that the VideoPlayer reads content from. In addition to URLs, this property also accepts raw paths to local files. The raw paths can either be absolute on the platform or relative to the Player root. If the user sets both a VideoPlayer.c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_94c216cb2541_doc_9
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
What feedback (correct or incorrect) is shown. Either None, Always Right, Always Wrong or Random. Signature: ```csharp public FeedbackType feedbackType = FeedbackType.ShowAnswers; ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_00303e0fd0f4
unity_docs
physics
What is `Physics.ContactEvent` in Unity? Explain its purpose and usage.
Physics.ContactEvent Parameters Parameter Description value A delegate to call. Description Subscribe to this event to read all collisions that occurred during the physics simulation step. Each subscriber to this event gets invoked with a physics scene and a native array of ContactPairHeader s. Each ContactP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e04f78b04a7f
unity_docs
physics
Give me an overview of the `CharacterController` class in Unity.
CharacterController class in UnityEngine / Inherits from: Collider / Implemented in: UnityEngine.PhysicsModule Description A CharacterController allows you to easily do movement constrained by collisions without having to deal with a rigidbody. A CharacterController is not affected by forces and will only mo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7378e426f032
unity_docs
rendering
What is `Camera.anamorphism` in Unity? Explain its purpose and usage.
Camera.anamorphism public float anamorphism ; Description The camera anamorphism. To use this property, enable UsePhysicalProperties. Stretches the sensor to simulate an anamorphic look. Positive values distort the Camera vertically, negative will distort the Camera horizontally.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a4500b1a0c6e
unity_docs
editor
What are the parameters of `PluginImporter.SetIcon` in Unity?
Description Sets the custom icon to associate with a MonoScript imported by a managed plugin. Each MonoScript imported by managed plugins can have an associated custom icon. This icon is used in the Scene view, the Inspector, and the Project window. To remove a MonoScript 's associated custom icon, pass null to this me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_598c788383fd
unity_docs
rendering
What is `Rendering.RayTracingAccelerationStructure.UpdateInstanceTransform` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.UpdateInstanceTransform Declaration public void UpdateInstanceTransform ( Renderer renderer ); Parameters Parameter Description renderer The Renderer associated with a ray tracing instance. Description Updates the transformation of a ray tracing instance. For a ray tracing...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4bdb1d705952
unity_docs
scripting
What is `Transform.TransformPoints` in Unity? Explain its purpose and usage.
Transform.TransformPoints Declaration public void TransformPoints (Span<Vector3> positions ); Parameters Parameter Description positions The positions of the points to be transformed, each is replaced by the transformed version. Description Transforms multiple points from local space to world space overwr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_209f1c6addbe
unity_docs
physics
Show me a Unity C# example demonstrating `Physics.CheckSphere`.
ters Parameter Description position Center of the sphere. radius Radius of the sphere. layerMask A Layer mask that is used to selectively ignore colliders when casting a capsule. queryTriggerInteraction Specifies whether this query should hit Triggers. Description Returns true if there are any colliders o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_418279730179
unity_docs
physics
What is `Collider2D.compositeOrder` in Unity? Explain its purpose and usage.
Collider2D.compositeOrder public int compositeOrder ; Description The composite operation order to be used when a CompositeCollider2D is used. When this Collider2D is using any composite operation other than Collider2D.CompositeOperation.None , the composite operation uses the previous composite operation ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c0acb93cd422
unity_docs
rendering
In Unity's 'Static GameObjects', what is 'The Static Editor Flags property' and how does it work?
The Static Editor Flags property lists a number of Unity systems which can include a static GameObject in their precomputations. Use the drop-down to define which systems include the GameObject in their precomputations. Setting Static Editor Flags at runtime has no effect on these systems. Only include a GameObject in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d5f9d370f872_doc_4
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Controls which movement control scheme to use. Signature: ```csharp public MoveScheme moveScheme ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_edf0b8014550
unity_docs
rendering
What is `Rendering.RayTracingInstanceMaterialConfig.optionalShaderKeywords` in Unity? Explain its purpose and usage.
RayTracingInstanceMaterialConfig.optionalShaderKeywords public string[] optionalShaderKeywords ; Description An array of Shader Keyword names used to determine the Material type. Additional resources: RayTracingAccelerationStructure.CullInstances .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f07f17e03fb
unity_docs
editor
What is `Android.AndroidProjectFilesModifier` in Unity? Explain its purpose and usage.
AndroidProjectFilesModifier class in UnityEditor.Android Implements interfaces: IOrderedCallback Description An abstract class that contains methods to modify custom Android Gradle project files during the build process. Note : You can use this class to modify the Gradle project files that you set up in the modu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15a7bb4ce5ca
unity_docs
networking
What is `Networking.IMultipartFormSection.sectionData` in Unity? Explain its purpose and usage.
IMultipartFormSection.sectionData public byte[] sectionData ; Returns byte[] The raw binary data contained in this section. Must not be null or empty. Description Returns the raw binary data contained in this section. Must not return null or a zero-length array.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6faec75e51a6
unity_docs
math
What is `ComputeShader.SetFloat` in Unity? Explain its purpose and usage.
ComputeShader.SetFloat Declaration public void SetFloat (string name , float val ); Declaration public void SetFloat (int nameID , float val ); Parameters Parameter Description name Variable name in shader code. nameID Property name ID, use Shader.PropertyToID to get it. val Value to set. Desc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_933d559019b7
unity_docs
math
Give me an overview of the `FindObjectsInactive` class in Unity.
FindObjectsInactive enumeration Description Options to control whether object find functions return inactive objects. The Object.FindObjectsByType(), Object.FindFirstObjectByType() and Object.FindAnyObjectByType() functions can take a parameter of this type to indicate whether they should include inactive objects ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7bf5f1205917
unity_docs
scripting
What is `Application.LogCallback` in Unity? Explain its purpose and usage.
Application.LogCallback Declaration public delegate void LogCallback (string condition , string stackTrace , LogType type ); Description Use this delegate type with Application.logMessageReceived or Application.logMessageReceivedThreaded to monitor what gets logged. Additional resources: Application.l...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0c2ad8f69484
unity_docs
scripting
What is `UIElements.CollectionViewController.GetIndexForId` in Unity? Explain its purpose and usage.
CollectionViewController.GetIndexForId Declaration public int GetIndexForId (int id ); Parameters Parameter Description id The item id.. Returns int The item index. Description Returns the index for the specified id. For example, the index will be different from the id in a tree.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67777462c517
unity_docs
scripting
What is `Unity.Android.Gradle.Manifest.CompatibleScreens` in Unity? Explain its purpose and usage.
CompatibleScreens class in Unity.Android.Gradle.Manifest / Inherits from: Unity.Android.Gradle.Manifest.BaseElement Description The C# definition of the <compatible-screens> Android Manifest element. For more information about the element, see Android's documentation: CompatibleScreens element Properties ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2c16652d3a4d
unity_docs
physics
What is `Collider2D.shapeCount` in Unity? Explain its purpose and usage.
Collider2D.shapeCount public int shapeCount ; Description The number of active PhysicsShape2D the Collider2D is currently using. If the Collider2D is disabled, inactive or in error then this count will be zero.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_db96b4cf96d9
unity_docs
scripting
What is `UIElements.PanelSettings.SetPanelChangeReceiver` in Unity? Explain its purpose and usage.
PanelSettings.SetPanelChangeReceiver Declaration public void SetPanelChangeReceiver ( UIElements.IDebugPanelChangeReceiver value ); Description Sets a custom IPanelChangeReceiver in the panelChangeReceiver setter to receive every change event. This method is available only in development builds and the edito...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_189423b07f10
unity_docs
scripting
What is `ModifiableContactPair.IgnoreContact` in Unity? Explain its purpose and usage.
ModifiableContactPair.IgnoreContact Declaration public void IgnoreContact (int i ); Parameters Parameter Description i Index of the contact point. Description Ignore the specified contact point in this contact pair. Note that this is the same as setting the maximum impulse to be applied at this contact po...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_75cad82a7898
github
scripting
Write a Unity Editor script for Layout Properties Preview
```csharp using System.Collections.Generic; using System.Linq; using UnityEngine; using UnityEngine.UI; using System.Globalization; namespace UnityEditor.Events { [CustomPreview(typeof(GameObject))] /// <summary> /// Custom preview drawing that will draw the layout properties of a given object. /// <...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_543a99a61dbf
unity_docs
performance
Explain 'Frame timing manager introduction' in Unity.
You can use the FrameTimingManager class to capture high level timing data about individual frame performance in an application. You can then use this data to assess whether your application meets performance targets. You can use the FrameTimingManager class in the following situations: You need to monitor performance ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_578cd5377f11
unity_docs
scripting
Give me an overview of the `AudioImporter` class in Unity.
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_247414ecf97d
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.AddPublicHeaderToBuild` in Unity?
Description Configures a file for building for the given native target as a public header. In projects containing multiple native targets, you can configure a file to build in all, some, or, none of the targets. The file reference is added to appropriate build section. ```csharp using UnityEditor; using System.IO; usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9f0401e6180
unity_docs
animation
Give me an overview of the `ClipAnimationMaskType` class in Unity.
ClipAnimationMaskType enumeration Description AnimationClip mask options for ModelImporterClipAnimation . Mask can be used to specify which transforms animation should be imported when generating the clip. Additional resources: ModelImporterClipAnimation.maskType . Properties Property Description CreateFromT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ccbee81ba0e7
unity_docs
editor
What is `Build.BuildFailedException` in Unity? Explain its purpose and usage.
BuildFailedException class in UnityEditor.Build Description An exception class that represents a failed build. Constructors Constructor Description BuildFailedException Constructs a BuildFailedException object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d845a19e6150
unity_docs
scripting
What are the parameters of `Animations.GameObjectRecorder.BindComponentsOfType` in Unity?
Description Adds bindings for all the properties of the first component of type T found in target , and also for all the target 's children if recursive is true . ```csharp using UnityEngine; using UnityEditor; using UnityEditor.Animations;public class BindComponentScript : MonoBehaviour { void Start() { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4a581c0e68e4
unity_docs
xr
What is `Networking.DownloadHandlerAssetBundle.ctor` in Unity? Explain its purpose and usage.
DownloadHandlerAssetBundle Constructor Declaration public DownloadHandlerAssetBundle (string url , uint crc ); Parameters Parameter Description url The nominal (pre-redirect) URL at which the asset bundle is located. crc A checksum to compare to the downloaded data for integrity checking, or zero to skip ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_200ce2d45602
unity_docs
rendering
What is `Camera.GateFitMode` in Unity? Explain its purpose and usage.
GateFitMode enumeration Description Enum used to specify how the sensor gate (sensor frame) defined by Camera.sensorSize fits into the resolution gate (render frame). Properties Property Description Vertical Fit the resolution gate vertically within the sensor gate. Horizontal Fit the resolution gate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a0e6b4ecea23
unity_docs
rendering
What is `UnityEngine.UIModule` in Unity? Explain its purpose and usage.
UnityEngine.UIModule Description The UI module implements basic components required for Unity's UI system Classes Class Description Canvas Element that can be used for screen rendering. CanvasGroup A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state. CanvasRenderer A ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9f2bcb3ead27
unity_docs
editor
In Unity's 'Scriptable Build Pipeline', what is 'Compatible with Unity' and how does it work?
These package versions are available in Unity version 6000.0: Documentation location: State Versions available: com.unity.scriptablebuildpipeline@3.0 released 3.0.0 com.unity.scriptablebuildpipeline@2.6 released 2.6.1
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_41dc32f75b3d
unity_docs
scripting
What is `Experimental.GraphView.GraphView.UnserializeAndPasteOperation` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphView.UnserializeAndPasteOperation Declaration protected void UnserializeAndPasteOperation (string operationName , string data ); Parameters Parameter Description operationName Name of operation for undo/redo labels....
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_60fac44ce229
unity_docs
animation
What is `Animations.AnimatorState.cycleOffset` in Unity? Explain its purpose and usage.
AnimatorState.cycleOffset public float cycleOffset ; Description Offset at which the animation loop starts. Useful for synchronizing looped animations. Units is normalized time. AnimationClip loop time needs to be checked to use cycle offset, otherwise cycle offset won't have any effect. Valid range is 0 to 1.0...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_166069bea929
unity_docs
input
What is `TouchScreenKeyboardType` in Unity? Explain its purpose and usage.
TouchScreenKeyboardType enumeration Description Enumeration of the different types of supported touchscreen keyboards. Properties Property Description Default The default keyboard layout of the target platform. ASCIICapable Keyboard with standard ASCII keys. NumbersAndPunctuation Keyboard with numbers and pun...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_160532f71be8
unity_docs
scripting
Show me a Unity C# example demonstrating `Debug.LogWarning`.
ies is highlighted in the Hierarchy window. You can click the hyperlinks in the stack trace to go directly to the relevant lines of code in your code editor. When the message is a string, rich text markup can be used to add emphasis. See the manual page about rich text for details of the different markup tags availab...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_14383b51e998
unity_docs
editor
What is `Unity.CodeEditor.CodeEditor.Unregister` in Unity? Explain its purpose and usage.
CodeEditor.Unregister Declaration public static void Unregister ( Unity.CodeEditor.IExternalCodeEditor externalCodeEditor ); Parameters Parameter Description externalCodeEditor The instance of IExternalCodeEditor to remove. Description Remove an instance of IExternalCodeEditor from the list of registe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6782800dba7b
unity_docs
scripting
What is `WSA.Application.InvokeOnAppThread` in Unity? Explain its purpose and usage.
Application.InvokeOnAppThread Declaration public static void InvokeOnAppThread ( WSA.AppCallbackItem item , bool waitUntilDone ); Parameters Parameter Description item Item to execute. waitUntilDone Wait until item is executed. Description Executes callback item on application thread. More information...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1fa251abf7c4
unity_docs
ui
Give me an overview of the `HideInCallstackAttribute` class in Unity.
HideInCallstackAttribute class in UnityEngine / Implemented in: UnityEngine.CoreModule Description Marks the methods you want to hide from the Console window call stack. When you hide these methods they are removed from the detail area of the selected message in the Console window. Note : The intended use for ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac74e9d27aab
unity_docs
editor
What is `PrefabUtility.ApplyAddedComponent` in Unity? Explain its purpose and usage.
PrefabUtility.ApplyAddedComponent Declaration public static void ApplyAddedComponent ( Component component , string assetPath , InteractionMode action ); Parameters Parameter Description action The interaction mode for this action. assetPath The path of the Prefab Asset to apply to. component The ad...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a22af9392bf
unity_docs
scripting
Give me an overview of the `WebGLWasmArithmeticExceptions` class in Unity.
WebGLWasmArithmeticExceptions enumeration Description An enum containing different trapping modes for WebAssembly code. This enum is used within the WebGL platform to define the type of trapping that is used when performing arithmetic operations in WebAssembly code. Properties Property Description Ignore This ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1ad38eb067d6
unity_docs
scripting
What is `Windows.WebCam.PhotoCapture.PhotoCaptureResult` in Unity? Explain its purpose and usage.
PhotoCaptureResult struct in UnityEngine.Windows.WebCam / Implemented in: UnityEngine.CoreModule Description A data container that contains the result information of a photo capture operation. Properties Property Description hResult The specific HResult value. resultType A generic result that indicates whet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc3fb262865d
unity_docs
rendering
What is `Mesh.uv8` in Unity? Explain its purpose and usage.
Mesh.uv8 public Vector2[] uv8 ; Description The texture coordinates (UVs) in the eighth channel. This channel is also commonly called "UV7". It maps to the shader semantic `TEXCOORD7`. When you call Mesh.HasVertexAttribute , this channel corresponds to VertexAttribute.TexCoord7 . Unity stores UVs in 0-1 spac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_43c41beade82
unity_docs
audio
What is `AudioImporterSampleSettings.quality` in Unity? Explain its purpose and usage.
AudioImporterSampleSettings.quality public float quality ; Description Audio compression quality (0-1) Amount of compression. The value roughly corresponds to the ratio between the resulting and the source file sizes.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f54feb58c33
unity_docs
rendering
Show me a Unity C# example demonstrating `Material.DisableKeyword`.
lKeyword struct, cache it, and use that. Note: A LocalKeyword is specific to a single Shader or ComputeShader instance. You cannot use it with other Shader or ComputeShader instances, even if they declare keywords with the same name. The following example creates a LocalKeyword struct with the name EXAMP...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_577c18e8c44b
unity_docs
animation
What is `Animations.ChildMotion` in Unity? Explain its purpose and usage.
ChildMotion struct in UnityEditor.Animations Description Structure that represents a motion in the context of its parent blend tree. Properties Property Description cycleOffset Normalized time offset of the child. directBlendParameter The parameter used by the child when used in a BlendTree of type BlendTreeT...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_a6d4a628e3be
unity_docs
rendering
Explain 'Configure a GameObject to sample more Light Probes in the Built-In Render Pipeline' in Unity.
To make lighting more realistic, use a Light Probe Proxy Volume to configure a GameObject to sample multiple Light Probes. Page Description Light Probe Proxy Volumes Understand how a Light Probe Proxy Volume component generates a 3D grid and texture that Unity uses to create gradients on GameObjects. Set a GameObject t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a8419c3547a
unity_docs
scripting
Show me a Unity C# example demonstrating `SceneManagement.SceneManager.LoadScene`.
setBundle . For opening Scenes in the Editor see EditorSceneManager.OpenScene . SceneA can additively load SceneB multiple times. The regular name is used for each loaded scene. If SceneA loads SceneB ten times each SceneB will have the same name. Finding a particular added scene is not possible. If a single...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c74bfb8c6a5e
unity_docs
rendering
What is `SystemInfo.SupportsRenderTextureFormat` in Unity? Explain its purpose and usage.
SystemInfo.SupportsRenderTextureFormat Declaration public static bool SupportsRenderTextureFormat ( RenderTextureFormat format ); Parameters Parameter Description format The format to look up. Returns bool True if the format is supported. Description Is render texture format supported? Returns tru...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_486e7f3e6617_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Sample monobehaviour with specific inspector Signature: ```csharp public class SampleSearchableMonoBehaviour : BaseSampleSearchableMonoBehaviour ```
You are an expert Unity game developer. Provide clear, accurate, and practical answers about Unity development.
local_sr_503a33f9cd13
unity_docs
ui
What is `GUI.EndScrollView` in Unity? Explain its purpose and usage.
GUI.EndScrollView Declaration public static void EndScrollView (); Declaration public static void EndScrollView (bool handleScrollWheel ); Description Ends a scrollview started with a call to BeginScrollView. ```csharp using UnityEngine; using System.Collections;public class ExampleClass : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_80db1ca8e139
unity_docs
editor
Show me a Unity C# example demonstrating `SerializationUtility.ClearAllManagedReferencesWithMissingTypes`.
with managed reference fields that have missing types. This API is useful for removing missing type warning messages when an asset is loaded, for example if there is a reference to a class in a package that is not being used anymore. This method returns false if the object had no references with missing types. Addition...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_32d44be82ae0
unity_docs
math
What is `LineRenderer.GetPosition` in Unity? Explain its purpose and usage.
LineRenderer.GetPosition Declaration public Vector3 GetPosition (int index ); Parameters Parameter Description index The index of the position to retrieve. Returns Vector3 The position at the specified index in the array. Description Get the position of a vertex in the line. Additional resources:...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b8dbf202009
unity_docs
rendering
What is `Texture.targetTextureMemory` in Unity? Explain its purpose and usage.
Texture.targetTextureMemory public static ulong targetTextureMemory ; Description The total amount of Texture memory that Unity allocates to the Textures in the scene after it applies the memory budget and finishes loading Textures. `targetTextureMemory`also takes mipmap streaming settings into account. This v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a53830d71a7e
unity_docs
rendering
Show me a Unity C# example demonstrating `Search.SearchService.Request`.
text used to track asynchronous requests. You need to dispose of the context yourself. options Options defining how the query is performed. Returns ISearchList Asynchronous list of search items. Description Executes a search request that will fetch search results asynchronously. The following example execute...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_300d41e83e10
unity_docs
rendering
What is `PlayerSettings.SetDefaultShaderChunkSizeInMB` in Unity? Explain its purpose and usage.
PlayerSettings.SetDefaultShaderChunkSizeInMB Declaration public static void SetDefaultShaderChunkSizeInMB (int sizeInMegabytes ); Parameters Parameter Description sizeInMegabytes The chunk size in megabytes. Description Sets the default size for compressed shader variant chunks. Unity stores multiple sh...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c40dce1d41a0
unity_docs
scripting
Explain 'Native plug-ins for Android' in Unity.
Unity supports native plug-ins for Android applications so you can integrate middleware libraries or existing C/C++ code into your Unity application. Topic Description Introducing native plug-ins for Android Understand native plug-ins for Android and their use-cases. Create a native plug-in for Android Create a new nat...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bd5de20ed47a
unity_docs
editor
Explain 'Mobile Notifications' in Unity.
com.unity.mobile.notifications ## Description Mobile Notifications package adds support for scheduling local repeatable or one-time notifications on iOS and Android. On iOS receiving of push notifications is also supported. ## Released for Unity Package version 2.4.3 is released for Unity Editor version 6000.0.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_97af3e260409
github
scripting
Write a Unity C# script called FB Depth Test Extension
```csharp // SPDX-FileCopyrightText: 2024 Michael Nisbet <me@mikesky.dev> // SPDX-License-Identifier: MIT using UnityEngine; using Unity.Collections; using Unity.Collections.LowLevel.Unsafe; using Unity.XR.CompositionLayers; using UnityEngine.XR.OpenXR.NativeTypes; namespace OpenXR.Extensions { [ExecuteAlways] ...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_d2f77bd9d842
unity_docs
math
What is `AndroidJNI.CallDoubleMethodUnsafe` in Unity? Explain its purpose and usage.
AndroidJNI.CallDoubleMethodUnsafe Declaration public static double CallDoubleMethodUnsafe (IntPtr obj , IntPtr methodID , jvalue* args ); Description Calls a Java instance method defined by methodID , optionally passing an array of arguments ( args ) to the method. Additional resources: Java Native Interfa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57478e38b037
unity_docs
scripting
What is `Experimental.GraphView.ContentZoomer.DefaultReferenceScale` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. ContentZoomer.DefaultReferenceScale public static float DefaultReferenceScale ; Description Default reference zoom level.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6a4de540f21c
unity_docs
rendering
What is `Camera.farClipPlane` in Unity? Explain its purpose and usage.
Camera.farClipPlane public float farClipPlane ; Description The distance of the far clipping plane from the Camera, in world units. The far clipping plane is furthest point of the Camera's view frustum. The Camera cannot see geometry that is further this distance. For more information, see Understanding the v...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e93096494354
unity_docs
rendering
What is `MaterialEditor.GetRightAlignedFieldRect` in Unity? Explain its purpose and usage.
MaterialEditor.GetRightAlignedFieldRect Declaration public static Rect GetRightAlignedFieldRect ( Rect r ); Parameters Parameter Description r Field Rect. Returns Rect A sub rect of the input Rect. Description Utility method for GUI layouting ShaderGUI.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e6d14fac278b
unity_docs
rendering
What is `Overlays.Overlay.collapsedIcon` in Unity? Explain its purpose and usage.
Overlay.collapsedIcon public Texture2D collapsedIcon ; Description Defines a custom icon to use when that overlay is in collapsed form. This will override the default icon defined using the Icon attribute, set the value to null to reset to the default icon.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_21faf17582ba
unity_docs
physics
What is `Rigidbody2D.SlideMovement.gravity` in Unity? Explain its purpose and usage.
Rigidbody2D.SlideMovement.gravity public Vector2 gravity ; Description The gravity to be applied to the slide position. In a similar way to how the Physics2D.gravity works, the gravity vector here is scaled by time and applied as movement to the slide position. However, unlike Physics2D.gravity , this has ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6c04c3668205
unity_docs
editor
What is `Device.SystemInfo.constantBufferOffsetAlignment` in Unity? Explain its purpose and usage.
SystemInfo.constantBufferOffsetAlignment public static int constantBufferOffsetAlignment ; Description This has the same functionality as SystemInfo.constantBufferOffsetAlignment 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_36ac698fe099
unity_docs
editor
In Unity's 'Tooltip event', what is 'Examples' and how does it work?
The following examples display the behavior of the ToolTipEvent . To view an example: Under Assets > Scripts > Editor , create a C# script called SampleWindow. Copy one of the following examples into the C# script. From the Editor Toolbar, select Window > UI Toolkit > SampleWindow .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8e798026e197
unity_docs
rendering
In Unity's 'Introduction to AssetBundles', what is 'Reasons to use AssetBundles' and how does it work?
Using AssetBundles can help with content distribution and optimizing your application’s performance. The following are benefits of using the AssetBundle system: Dynamic content delivery : You can use AssetBundles to load assets on demand, which is especially useful for games with downloadable content (DLC), episodic up...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e377022a0aa
unity_docs
scripting
What is `OcclusionArea` in Unity? Explain its purpose and usage.
OcclusionArea class in UnityEngine / Inherits from: Component / Implemented in: UnityEngine.CoreModule Description OcclusionArea is an area in which occlusion culling is performed. Properties Property Description center Center of the occlusion area relative to the transform. size Size that the occlusion ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e9397b5f9e3e
unity_docs
math
What is `AndroidJNI.CallStaticBooleanMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallStaticBooleanMethod Declaration public static bool CallStaticBooleanMethod (IntPtr clazz , IntPtr methodID , jvalue[] args ); Description Invokes the specified methodID static method on a Java object, optionally passing in an array of arguments ( args ). Additional resources: Java Native In...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_988dc5246098
unity_docs
scripting
What is `HandleUtility.DistanceToCube` in Unity? Explain its purpose and usage.
HandleUtility.DistanceToCube Declaration public static float DistanceToCube ( Vector3 position , Quaternion rotation , float size ); Parameters Parameter Description position Position of the cube. rotation Rotation of the cube. size Size of the cube. Returns float Distance from mouse to cube in ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ab29673e1ef1
unity_docs
scripting
What is `Experimental.GraphView.Node.ToggleCollapse` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Node.ToggleCollapse Declaration protected void ToggleCollapse (); Description Toggle node's collapse state.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9355cf6f81fd
unity_docs
performance
Explain 'Search profiler markers' in Unity.
The Profiler Markers search provider searches the Profiler data of scripts that use the ProfilerMarker API. You can use the Profiler Markers search provider in two windows: In a dedicated window. From the main menu, select Window > Analysis > Performance Markers . In the Search window, using a visual or textual query w...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_637027c0d8fc
unity_docs
math
What is `Rendering.RayTracingAccelerationStructure.Release` in Unity? Explain its purpose and usage.
RayTracingAccelerationStructure.Release Declaration public void Release (); Description Destroys this RayTracingAccelerationStructure and frees the GPU memory used for storing acceleration structure data. Additional resources: RayTracingAccelerationStructure.Dispose .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_589bac5934b4
unity_docs
animation
What is `Animations.AnimatorJobExtensions.UnbindAllStreamHandles` in Unity? Explain its purpose and usage.
AnimatorJobExtensions.UnbindAllStreamHandles Declaration public static void UnbindAllStreamHandles ( Animator animator ); Parameters Parameter Description animator The Animator instance that calls this method. Description Removes all PropertyStreamHandles and TransformStreamHandles associated with the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9397c5974e1
unity_docs
rendering
What is `LightTransport.PostProcessing.IProbePostProcessor.ConvolveRadianceToIrradiance` in Unity? Explain its purpose and usage.
IProbePostProcessor.ConvolveRadianceToIrradiance Declaration public bool ConvolveRadianceToIrradiance ( LightTransport.IDeviceContext context , BufferSlice<SphericalHarmonicsL2> radianceIn , BufferSlice<SphericalHarmonicsL2> irradianceOut , int probeCount ); Parameters Parameter Description context Devic...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_824bb06b0efc
unity_docs
xr
What is `XR.XRMeshSubsystem.meshDensity` in Unity? Explain its purpose and usage.
XRMeshSubsystem.meshDensity public float meshDensity ; Description Call this function to request a change in the density of the generated Meshes. Unity gives the density level as a value within the range 0.0 to 1.0 and the provider determines how to map that value to their implementation. Setting this value does...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ece3c76087f3
unity_docs
xr
What is `Search.Dispatcher.ProcessOne` in Unity? Explain its purpose and usage.
Dispatcher.ProcessOne Declaration public static bool ProcessOne (); Returns bool Returns true if an enqueued action was processed. Description This function can called in the main thread to force the execution of one enqueued action. This can be used to prevent the main thread from waiting for an action t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_f777a8fad240
github
scripting
Write a Unity C# script called Grid Minimap Renderer
```csharp using FactoryMustScale.Simulation; using Unity.Collections; using UnityEngine; namespace FactoryMustScale.Runtime.Visualization { /// <summary> /// Stateless-style minimap renderer over deterministic grid data. /// Coordinate convention: y-up simulation indexing and y-up texture addressing (row-m...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_038b0d42e10b
unity_docs
ui
Show me a Unity C# example demonstrating `GUILayout.EndHorizontal`.
GUILayout.EndHorizontal Declaration public static void EndHorizontal (); Description Close a group started with BeginHorizontal. Horizontal Layout. ```csharp using UnityEngine;public class ExampleScript : MonoBehaviour { void OnGUI() { GUILayout.BeginHorizontal("box"); GUILayout.Button("I'm the first button...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4a436854c30
unity_docs
performance
What are the parameters of `Unity.Profiling.ProfilerMarker.ctor` in Unity?
Description Constructs a new performance marker for code instrumentation. Use ProfilerMarker to markup a piece of code for the Profiler and Recorder . ```csharp using Unity.Profiling;public class MySystemClass { static readonly ProfilerMarker s_PreparePerfMarker = new ProfilerMarker("MySystem.Prepare"); static ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3e3e8e81981d
unity_docs
rendering
What is `ParticleSystem.LightsModule.ratio` in Unity? Explain its purpose and usage.
ParticleSystem.LightsModule.ratio public float ratio ; Description Choose what proportion of particles receive a dynamic light. Use a value between 0 and 1, where 0 attaches Lights to no particles, and 1 attaches Lights to every particle. ```csharp using UnityEngine; using System.Collections;// For best resul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af70bb48f34f
unity_docs
rendering
What are the parameters of `Gizmos.DrawGUITexture` in Unity?
Description Draw a texture in the Scene. The chosen texture is drawn in 3D space on a "screen" defined by the XY plane (ie, the plane where the Z coordinate is zero). The values of the texture rectangle are given in Scene units. The optional border values specify an inset from each edge within the rectangle in Scene un...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_315b0cc441cf
unity_docs
rendering
What is `Mesh.SetIndices` in Unity? Explain its purpose and usage.
Mesh.SetIndices Declaration public void SetIndices (int[] indices , MeshTopology topology , int submesh , bool calculateBounds = true, int baseVertex = 0); Declaration public void SetIndices (List<int> indices , MeshTopology topology , int submesh , bool calculateBounds , int baseVertex ); De...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6ad4f1f6443a
unity_docs
rendering
Explain 'Light Probes and moving GameObjects' in Unity.
Lightmapping adds greatly to the realism of a scene by capturing realistic bounced light as textures which are “baked” onto the surface of static objects. However, due to the nature of lightmapping, it can only be applied to non-moving objects marked as Contribute GI . While realtime and mixed mode lights can cast dire...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e152e2e8dc85
unity_docs
rendering
In Unity's 'Branch based on shader pass or shader stage', what is 'Surface Shader pass' and how does it work?
When Surface Shaders are compiled, they generate a lot of code for various passes to do lighting. When compiling each pass, one of the following macros is defined: Macro: Use: UNITY_PASS_FORWARDBASE Forward rendering base pass (main directional light, lightmaps, SH). UNITY_PASS_FORWARDADD Forward rendering additive pas...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98fd6d168375
unity_docs
scripting
What is `GraphicsBuffer.IndirectDrawArgs` in Unity? Explain its purpose and usage.
IndirectDrawArgs struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Defines the data layout for non-indexed indirect render calls. To setup GraphicsBuffer for non-indexed indirect rendering, use this struct to define the data layout. The layout can change between platforms, so for impr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_73e643695c27
unity_docs
input
Give me an overview of the `Event` class in Unity.
Event class in UnityEngine / Implemented in: UnityEngine.IMGUIModule Description A UnityGUI event. Events correspond to user input (key presses, mouse actions), or are UnityGUI layout or rendering events. For each event OnGUI is called in the scripts; so OnGUI is potentially called multiple times per frame. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.