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_e586f87f825b
unity_docs
rendering
Give me an overview of the `LineAlignment` class in Unity.
LineAlignment enumeration Description Control the direction lines face, when using the LineRenderer or TrailRenderer . Properties Property Description View Lines face the camera. TransformZ Lines face the Z axis of the Transform Component.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4ef5433bde1d
unity_docs
scripting
Show me a Unity C# example demonstrating `GL.QUADS`.
If you pass 4 vertices, one quad is drawn, where each vertex becomes one corner of the quad. If you pass 8 vertices, 2 quads will be drawn. To set up the screen for drawing in 2D, use GL.LoadOrtho or GL.LoadPixelMatrix . To set up the screen for drawing in 3D, use GL.LoadIdentity followed by GL.MultMatrix with t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b83a34083256
unity_docs
scripting
What is `JsonUtility.ToJson` in Unity? Explain its purpose and usage.
JsonUtility.ToJson Declaration public static string ToJson (object obj ); Declaration public static string ToJson (object obj , bool prettyPrint ); Parameters Parameter Description obj The object to convert to JSON form. prettyPrint If true, format the output for readability. If false, format the out...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_eeb78d9ee604
unity_docs
editor
Give me an overview of the `RuntimePlatform` class in Unity.
RuntimePlatform enumeration Description The platform application is running. Returned by Application.platform. Note: The difference between using RuntimePlatform and Platform dependent compilation is that using RuntimePlatform is evaluated at runtime while Platform dependent compilation is evaluated at compile ti...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0dfd2759a28c
github
scripting
Write a Unity C# physics script for Snow Ball
```csharp using UnityEngine; public class SnowBall : MonoBehaviour { public float ballSpeed; public GameObject snowballEffect; private Rigidbody2D _theRb; // Start is called before the first frame update private void Start() { _theRb = GetComponent<Rigidbody2D>(); } // Updat...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_cd55ccfb48f2
unity_docs
networking
Explain 'Monitor Unity Accelerator' in Unity.
Unity Accelerator has a built-in dashboard to monitor and configure changes. The URL to access your dashboard is http://hostname[:port]/dashboard where hostname:port is the hostname/IP and port number of the Unity Accelerator you have installed. Note that the default port is 80 for http and 443 for https but you can ch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_10fedf0d9ce0
unity_docs
scripting
What is `Build.Reporting.CommonRoles.manifestAssetBundle` in Unity? Explain its purpose and usage.
CommonRoles.manifestAssetBundle public static string manifestAssetBundle ; Description The BuildFile.role value of a manifest AssetBundle, which is an AssetBundle that contains information about other AssetBundles and their dependencies.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_90d648084dfb
unity_docs
rendering
What is `ShaderGUI.OnMaterialPreviewSettingsGUI` in Unity? Explain its purpose and usage.
ShaderGUI.OnMaterialPreviewSettingsGUI Declaration public void OnMaterialPreviewSettingsGUI ( MaterialEditor materialEditor ); Parameters Parameter Description materialEditor The MaterialEditor that are calling this method (the 'owner'). Description Override for extending the functionality of the toolbar ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_02f74b3880f1
unity_docs
scripting
In Unity's 'Bind to nested properties', what is 'Create the destructible tank object' and how does it work?
Create a C# script to define a class for a tank that has health values to make it destructible. Create a project in Unity with any template. In your Project window , create a folder named bind-nested-properties to store all the files. Create a C# script named DestructibleTankScript.cs and replace its content with the f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6666cb11e96f
unity_docs
rendering
Give me an overview of the `SkinWeights` class in Unity.
SkinWeights enumeration Description Skin weights. How many bones affect each vertex. This can be used when accessing the Bone Weight Buffer with Mesh.GetBoneWeightBuffer to determine what way the data will be ordered. Additional resources: QualitySettings.skinWeights , SkinnedMeshRenderer.quality , Mesh.GetBo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2430da44cf58
unity_docs
physics
In Unity's 'Manage results tables', what is 'View Search tables' and how does it work?
To view your search in table format, enter a search query and click the table icon in the bottom right of the Unity Search window. By default, the table will show the Label and Description columns unless you have added new columns or you are using a select{} statement that creates new columns from selectors. Click the ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_416cb7355054
unity_docs
math
What is `Build.Reporting.BuildStep.messages` in Unity? Explain its purpose and usage.
BuildStep.messages public BuildStepMessage[] messages ; Returns BuildStepMessage[] An array of BuildStepMessage structs. Description All log messages recorded during this build step, in the order of which they occurred.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_85a2349cc1df
unity_docs
rendering
What is `RenderTexture.SupportsStencil` in Unity? Explain its purpose and usage.
RenderTexture.SupportsStencil Declaration public static bool SupportsStencil ( RenderTexture rt ); Parameters Parameter Description rt Render texture, or null for main screen. Description Does a RenderTexture have stencil buffer? If rt is null, will report the status for the main screen.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6863a3d2226b
unity_docs
ui
Show me a Unity C# example demonstrating `GUI.VerticalScrollbar`.
use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used. Returns float The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end. Description Make a vertical scrollbar. Scrollbars are what you use to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b18f80b8171b
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture2D.GetPixels`.
single call to GetPixels is usually faster than multiple calls to GetPixel , especially for large textures. If GetPixels fails, Unity throws an exception. GetPixels might fail if the array contains too much data. Use GetPixelData or GetRawTextureData instead for very large textures. You can't use GetPixel ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_30d270a4a421
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.sceneCullingMask`.
sk defined for the GameObject. (Read Only) Unity uses SceneCullingMasks to determine which scene to render the GameObject in. The sceneCullingMask is a bitfield stored as an unsigned 64-bit integer ulong . Cameras only render an object in a scene if the bits set on the Scene's mask (retrievable with EditorSceneM...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8d0e5529c31c
unity_docs
rendering
Explain 'Example of a DOTS Instancing shader that accesses constant data in URP' in Unity.
In this example: The metadata value for Color is 0x00001000 . The instance index is 5 . Data for instance 0 starts at address 0x1000. The most significant bit is not set so data for instance 5 is at the same address as instance 0. Because the most significant bit is not set, the accessor macros that fall back to defaul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_696970983f28
unity_docs
physics
Explain 'Profiler counters reference' in Unity.
Unity has built-in profiler counters which you can use to collect and display metrics in custom Profiler modules. The following tables outline the available built-in profiler counters. This information is also available via the ProfilerRecorder API and in the Profiler module editor so you can add them to a custom Profi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4f09a5e7344d
unity_docs
editor
Explain 'Test UI' in Unity.
The UI Toolkit provides tools to help you test and debug your UI elements. You can test your UI elements in the UI Builder, use the UI Toolkit Debugger to inspect and debug your UI elements in real-time, and use the UI Toolkit profiler markers to profile your UI elements. Topic Description Test UI in UI Builder Debug y...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_6cddca452bbb
unity_docs
rendering
What is `UIElements.RuntimePanelUtils` in Unity? Explain its purpose and usage.
RuntimePanelUtils class in UnityEngine.UIElements / Implemented in: UnityEngine.UIElementsModule Description A collection of static methods that provide simple World, Screen, and Panel coordinate transformations. Static Methods Method Description CameraTransformWorldToPanel Transforms a world absolute p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_9fe99d6bd270
unity_docs
audio
Explain 'Audio Source' in Unity.
The Audio Source is a component that plays an Audio Clip in your scene and provides options to customize its playback behavior. This information covers how to set up an audio source and what each of the component settings do. Page Description Introduction to the Audio Source component Information about the audio source...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_590f06751d6a
unity_docs
scripting
Show me a Unity C# example demonstrating `RigidbodyConstraints.FreezeRotationY`.
RigidbodyConstraints.FreezeRotationY Description Freeze rotation along the Y-axis. ```csharp //This example shows how RigidbodyConstraints is used to freeze the position and rotation of a Rigidbody in the y axis at start-up. //It also shows what happens when these constraints are removed, when you press the space k...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0fbb1c8f0577
unity_docs
performance
Explain 'Visual Studio project generation for Windows' in Unity.
The Create Visual Studio Solution Build Setting makes Unity generate a Visual Studio Solution instead of build a Player. Generating a Visual Studio Solution enables you to change your build process. For example, you can: Modify your application’s manifest. Add C++ code. Modify embedded resources. Launch your applicatio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_7c243f4d2e31
github
scripting
Write a Unity C# script called Cone Utils
```csharp /* * Copyright (c) Meta Platforms, Inc. and affiliates. * All rights reserved. * * Licensed under the Oculus SDK License Agreement (the "License"); * you may not use the Oculus SDK except in compliance with the License, * which is provided at the time of installation or download, or which * otherwise ...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_59a57823606d
unity_docs
rendering
What is `Rendering.BatchFilterSettings.renderingLayerMask` in Unity? Explain its purpose and usage.
BatchFilterSettings.renderingLayerMask public uint renderingLayerMask ; Description The rendering layer mask to use for draw commands in this draw range. This corresponds to Renderer.renderingLayerMask and allows you to control which draw commands Unity renders in this draw range.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_4b44dada72f0
unity_docs
editor
What is `Search.SearchMonitor.GetView` in Unity? Explain its purpose and usage.
SearchMonitor.GetView Declaration public static Search.SearchMonitorView GetView (bool delayedSync ); Parameters Parameter Description delayedSync Boolean indicating if the sync between views should only happen when the view is disposed, or for every operation. Default is false. Returns SearchMonitorView...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1723dbe7a004
unity_docs
scripting
Show me a Unity C# example demonstrating `PenStatus.Contact`.
PenStatus.Contact Description The pen is in contact with the screen or tablet. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { Event m_Event = Event.current; if (m_Event.type == EventType.MouseDown) { if (m_Event.pointerType == PointerType.Pen) //Check if it's a pen event. { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e34ba87ada92
unity_docs
scripting
What is `ParticleSystem.ForceOverLifetimeModule.xMultiplier` in Unity? Explain its purpose and usage.
ParticleSystem.ForceOverLifetimeModule.xMultiplier public float xMultiplier ; Description Defines the x-axis multiplier. Changing this property is more efficient than accessing the entire curve, if you only want to change the overall x-axis multiplier. ```csharp using UnityEngine; using System.Collections;[Re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_feca5c92d7d1
unity_docs
scripting
What is `Experimental.GraphView.Scope.OnElementsAdded` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Scope.OnElementsAdded Declaration protected void OnElementsAdded (IEnumerable<GraphElement> elements ); Parameters Parameter Description elements The added elements. Description Called when GraphElements are added to th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dd1431361f57
unity_docs
math
What is `Unity.Collections.NativeArray_1.Reinterpret` in Unity? Explain its purpose and usage.
NativeArray<T0>.Reinterpret Declaration public NativeArray<U> Reinterpret (); Declaration public NativeArray<U> Reinterpret (int expectedTypeSize ); Parameters Parameter Description expectedTypeSize The expected size (in bytes, as given by sizeof) of the current element type of the array. Returns Nativ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_cdff77d00c42
unity_docs
physics
What is `CharacterController.skinWidth` in Unity? Explain its purpose and usage.
CharacterController.skinWidth public float skinWidth ; Description The character's collision skin width. Specifies a skin around the character within which contacts will be generated by the physics engine. Use it to avoid numerical precision issues. This is dependant on the scale of the world, but should be a ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3a0e59e0628a
unity_docs
rendering
What is `Cubemap.SetPixel` in Unity? Explain its purpose and usage.
Cubemap.SetPixel Declaration public void SetPixel ( CubemapFace face , int x , int y , Color color , int mip = 0); Parameters Parameter Description x The x coordinate of the pixel to set. The range is 0 through (texture width - 1). y The y coordinate of the pixel to set. The range is 0 through ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3f9f1d3cfc9f
unity_docs
rendering
What is `LightingSettings.minBounces` in Unity? Explain its purpose and usage.
LightingSettings.minBounces public int minBounces ; Description Stores the minimum number of bounces the Progressive Lightmapper computes for indirect lighting. (Editor only) To reduce the computational load and improve performance during bakes, the Progressive Lightmapper terminates light paths that contribut...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8460e5c247c4
unity_docs
rendering
Show me a Unity C# example demonstrating `Material.EnableKeyword`.
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_man_c0493ac9ab3f
unity_docs
rendering
Show me a Unity code example for 'Customize the Light Explorer'.
find out how you can extend the Light Explorer this way, see the example below. ## Example code The examples in this section show you how to extend the default Light Explorer class to only show the Name column for Lights, and change the number of tabs. In your own implementation, you can override as many or as few me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8f4318cdf8c0
unity_docs
editor
What is `iOS.Xcode.PBXProject.AddCapability` in Unity? Explain its purpose and usage.
PBXProject.AddCapability Declaration public bool AddCapability (string targetGuid , iOS.Xcode.PBXCapabilityType capability , string entitlementsFilePath , bool addOptionalFramework ); Parameters Parameter Description targetGuid The GUID of the target, such as the one returned by GetUnityFrameworkTarget...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_17962e44a3e9
unity_docs
scripting
Show me a Unity code example for 'ToolbarSpacer'.
A ToolbarSpacer is an Editor-only control that creates empty spaces within a Toolbar for layout control and visual separation of elements. It’s a VisualElement with a predefined style that matches the Toolbar style. ## Create a ToolbarSpacer You can create a ToolbarSpacer with UI Builder, UXML, or C#. The following C...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9876c30304cb
unity_docs
scripting
What is `SceneManagement.EditorSceneManager` in Unity? Explain its purpose and usage.
EditorSceneManager class in UnityEditor.SceneManagement / Inherits from: SceneManagement.SceneManager Description Scene management in the Editor. Static Properties Property Description DefaultSceneCullingMask Use SceneCullingMasks.DefaultSceneCullingMask instead. playModeStartScene Loads this SceneAsset whe...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58a2f1b64fb8
unity_docs
xr
Show me a Unity C# example demonstrating `AudioSpeakerMode`.
es the audio channel count (downmixes) to one your device supports. On other platforms, Unity runs the device's native channel count. To set your project's default speaker mode, go to the Audio Manager : go to Edit > Project Settings > Audio and set Default Speaker Mode to your preferred speaker mode. The fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_68448d20218f
unity_docs
animation
In Unity's 'Deterministic builds introduction', what is 'Understanding non-deterministic builds' and how does it work?
Non-deterministic builds can happen in the following situations: During asset import and conversion: Non-deterministic builds can happen when Unity imports source assets and converts them to an internal format , or when Unity converts imported assets into packaged assets such as AssetBundles . Editor scripts that colle...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ac6d8a659a06
unity_docs
editor
What is `PlayerSettings.WSA.tileForegroundText` in Unity? Explain its purpose and usage.
PlayerSettings.WSA.tileForegroundText public static PlayerSettings.WSAApplicationForegroundText tileForegroundText ; Description The color style to use for the title text within the application's tile. In the Editor, Unity displays this under Tile section in UWP Player Settings .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_57c9b012137c
unity_docs
scripting
What is `Rendering.VirtualTexturing.Streaming.GetCPUCacheSize` in Unity? Explain its purpose and usage.
Virtual Texturing is experimental and not ready for production use. The feature and documentation might be changed or removed in the future. Streaming.GetCPUCacheSize Declaration public static int GetCPUCacheSize (); Description Gets the CPU cache size (in MegaBytes) used by Streaming Virtual Texturing.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8bce125c0ce8
unity_docs
scripting
What is `TextureImporter` in Unity? Explain its purpose and usage.
TextureImporter class in UnityEditor / Inherits from: AssetImporter Description Texture importer lets you modify Texture2D import settings from editor scripts. Settings of this class cover most of the settings exposed in Texture Import Settings . Some settings require you to use TextureImporterSettings . R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15d676f44166
unity_docs
ui
What is `EditorWindow.position` in Unity? Explain its purpose and usage.
EditorWindow.position public Rect position ; Description The desired position of the window in screen space. Setting this value will undock the window if it is docked. Create an undocked editor window with position. ```csharp // The position of the window is displayed when it is // external from Unity. usi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a552aa5494a1
unity_docs
scripting
Show me a Unity C# example demonstrating `Animator.SetIKRotation`.
on. In addition, you can set a weight value to set the amount of influence that the IK goal rotation has over the starting rotation. Use the SetIKRotationWeight method to set a weight value between 0..1 where a weight of 0 means no influence and a weight of 1 means full influence. The following code example demonstr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_2c7c5c12a311
unity_docs
rendering
In Unity's 'Choose a method for optimizing draw calls', what is 'Check the number of draw calls' and how does it work?
To check if your scene sends too many draw calls, do any of the following: Open the Rendering Statistics window and check the SetPass calls value. Open the Profiler and select the Rendering section to display the number of draw calls. Check the number of draw calls in the Frame Debugger .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_55108eea9ed0
unity_docs
math
What is `AssetImporters.SpriteImportData.outline` in Unity? Explain its purpose and usage.
SpriteImportData.outline public List<Vector2[]> outline ; Description Sprite Asset creation uses this outline when it generates the Mesh for the Sprite . If this is not given, SpriteImportData.tesselationDetail will be used to determine the mesh detail.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dda8a23de2c6
unity_docs
rendering
What is `MaterialEditor.EnableInstancingField` in Unity? Explain its purpose and usage.
MaterialEditor.EnableInstancingField Declaration public bool EnableInstancingField (); Description Display UI for editing material's render queue setting. Returns true if the UI is indeed displayed i.e. if the material's shader supports instancing. Additional resources: Material.enableInstancing . Declaration...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b8b2595d2d34
unity_docs
rendering
What is `DrawCameraMode` in Unity? Explain its purpose and usage.
DrawCameraMode enumeration Description Drawing modes for Handles.DrawCamera . Properties Property Description UserDefined A custom mode defined by the user. Normal Draw the camera like it would be drawn in-game. This uses the clear flags of the camera. Textured Draw the camera textured with selection wirefra...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_2dfae9ec2322_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A base class for MonoBehaviours that can beinstantiatedor addedto a with twelve arguments passed to the function of the created instance.Instances of classes inheriting from receive the arguments via the method where they can be assigned to member fields or properties. Type of the first argument received in the fun...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_2a7de551293c
unity_docs
editor
What is `ExpressionEvaluator.Evaluate` in Unity? Explain its purpose and usage.
ExpressionEvaluator.Evaluate Declaration public static bool Evaluate (string expression , out T value ); Parameters Parameter Description expression A string containing a mathematical expression (e.g. "4+3"). value The result of the expression evaluation. Supported types are: int , float , long , doub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b0be00774944
unity_docs
rendering
What is `FrameDebugger.enabled` in Unity? Explain its purpose and usage.
FrameDebugger.enabled public static bool enabled ; Description Queries whether the Frame Debugger is enabled. Most common use case is to pause or disable some rendering techniques or effects that alter their behavior every frame. For example, various graphics techniques that jitter the camera projection every...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2ddcc1d7d12e
unity_docs
physics
What is `LowLevelPhysics.ConvexMeshGeometry` in Unity? Explain its purpose and usage.
ConvexMeshGeometry struct in UnityEngine.LowLevelPhysics / Implemented in: UnityEngine.PhysicsModule Implements interfaces: IGeometry Description Contains the basic geometric shape of a convex mesh. The only way to retrieve this shape is to use the MeshCollider.Geometry property to get it from a convex MeshCo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2fdf465e45f8
unity_docs
scripting
Show me a Unity C# example demonstrating `Transform.IsChildOf`.
Transform.IsChildOf Declaration public bool IsChildOf ( Transform parent ); Description Is this transform a child of parent ? Returns a boolean value that indicates whether the transform is a child of a given transform. true if this transform is a child, deep child (child of a child) or identical to this tr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_455090e72320
unity_docs
scripting
What is `Unity.Properties.IProperty.HasAttribute` in Unity? Explain its purpose and usage.
IProperty.HasAttribute Declaration public bool HasAttribute (); Returns bool true if the property has the given attribute type; otherwise, false . Description Returns true if the property has any attributes of the given type.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f328e9152503
unity_docs
rendering
Show me a Unity C# example demonstrating `LightTransport.IProbeIntegrator.Prepare`.
ssary, and sets up the integration parameters. The preparation phase can be time-intensive for large scenes as it may involve: Building acceleration structures. Compiling compute shaders for the target device. Preprocessing scene geometry and materials. Setting up light data structures. The pushoff parameter helps...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_379e980181c3
unity_docs
scripting
What is `UIElements.MouseDownEvent` in Unity? Explain its purpose and usage.
MouseDownEvent class in UnityEngine.UIElements / Inherits from: UIElements.MouseEventBase_1 / Implemented in: UnityEngine.UIElementsModule Description This event is sent when a mouse button is pressed. The mouse down event is sent to a visual element when a mouse button is pressed inside the element. A M...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2559aec1434e
unity_docs
rendering
What is `QualitySettings.streamingMipmapsMaxLevelReduction` in Unity? Explain its purpose and usage.
QualitySettings.streamingMipmapsMaxLevelReduction public static int streamingMipmapsMaxLevelReduction ; Description The maximum number of mipmap levels to discard for each texture. This is also used as the number of mipmaps to discard the first time the texture is loaded, before texture streaming begins to bri...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_4283abc60b47
unity_docs
scripting
In Unity's 'Particle collisions', what is 'World Collision Quality' and how does it work?
The World Collision module has a Collision Quality property, which you can set to High , Medium or Low . When Collision Quality is set to Medium (Static Colliders) or Low (Static Colliders) , collisions use a grid of voxels (values on a 3D grid) to cache previous collisions, for fast re-use in later frames. This cache ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ca0a6952db65
unity_docs
ui
What is `Editor.DrawDefaultInspector` in Unity? Explain its purpose and usage.
Editor.DrawDefaultInspector Declaration public bool DrawDefaultInspector (); Returns bool Returns true if any GUI controls in the default Inspector changed the value of the input data, otherwise returns false. Description Draws the built-in Inspector. Call this method, within the OnInspectorGUI method, to...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9cbd7836617c
unity_docs
math
What is `AndroidJNI.CallFloatMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallFloatMethod Declaration public static float CallFloatMethod (IntPtr obj , IntPtr methodID , jvalue[] args ); Description Calls a Java instance method defined by methodID , optionally passing an array of arguments ( args ) to the method. Additional resources: Java Native Interface Specificati...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f4daefad3d23
unity_docs
scripting
Explain 'Assembly Definition Reference Inspector window reference' in Unity.
An Assembly Definition Reference is an asset that defines a reference to an Assembly Definition. Create an Assembly Definition Reference asset in a folder to include the scripts in that folder in the referenced Assembly Definition (rather than creating a new assembly). Scripts in child folders are also included, unless...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e9c2bf2ffa6b
unity_docs
physics
Explain 'Delivering to Google Play' in Unity.
This page contains information about Google Play-specific delivery requirements and considerations. For information on how to publish your application on Google Play, see Google Play . ## Delivery requirements Google Play has requirements an application must fulfil before you publish it. This section describes Google...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7b10bce34188
unity_docs
scripting
What is `Android.AndroidGame` in Unity? Explain its purpose and usage.
AndroidGame class in UnityEngine.Android / Implemented in: UnityEngine.AndroidJNIModule Description Provides methods and properties for accessing different Android game APIs. Static Properties Property Description GameMode Calls getGameMode() in the Android application to retrieve the user selected game mode...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9271f643a7d1
unity_docs
scripting
What are the parameters of `VersionControl.Provider.Lock` in Unity?
Description Attempt to lock an asset for exclusive editing. Depending on version control system and server setup this might be an exclusive lock preventing other people from even modifing the asset (for example: Plastic SCM or Git) or it might simply prevent other people from submitting the asset to the version control...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f6fb77de2c9c
unity_docs
rendering
Explain 'Reflection Probe Inspector window reference' in Unity.
Property Description Type Choose whether the probe is for a Baked , Custom , or Realtime setup. If you select Baked , the Reflection Probe does not capture GameObjects at runtime that have their Reflection Probe Static flag disabled. If you want to capture dynamic GameObjects in a baked Reflection Probe, select Custom ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9856d81d4b28
unity_docs
rendering
What is `LineRenderer.loop` in Unity? Explain its purpose and usage.
LineRenderer.loop public bool loop ; Description Connect the start and end positions of the line together to form a continuous loop. ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(LineRenderer))] public class ExampleClass : MonoBehaviour { private LineRenderer lr; void Start() ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b4f6d7b874dd
unity_docs
ui
Show me a Unity C# example demonstrating `GUIStyle.border`.
GUIStyle.border public RectOffset border ; Description The borders of all background images. This corresponds to the border settings for IMGUI elements. It only affects the rendering of the background image and has no effect on positioning. ```csharp using UnityEngine;public class Example : MonoBehaviour { ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_be2a2aef793f
unity_docs
editor
What are the parameters of `EditorGUI.BeginProperty` in Unity?
Returns GUIContent The actual label to use for the control. Description Create a Property wrapper, useful for making regular GUI controls work with SerializedProperty . Most EditorGUI and EditorGUILayout GUI controls already have overloads that work with SerializedProperty. However, for GUI controls that don't handle S...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_60a100dc05aa
unity_docs
rendering
In Unity's 'Debug Draw Modes for lighting reference', what is 'Contributors / Receivers' and how does it work?
The Contributors / Receivers mode displays the following colors depending on whether objects contribute to and receive global illumination : Orange means the object doesn’t contribute to global illumination. To change this, use the Contribute GI flag in the object’s Static Editor Flags property . Green means the object...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aa1fa226eca1
unity_docs
editor
What is `ProfilerWindow.gpuModuleIdentifier` in Unity? Explain its purpose and usage.
ProfilerWindow.gpuModuleIdentifier public static string gpuModuleIdentifier ; Description The identifier of the GPU Usage Profiler module . Compare this constant to ProfilerWindow.selectedModuleIdentifier to check if the currently selected Profiler module is the CPU Usage Profiler module . ```csharp usin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d1c3f006d587
unity_docs
rendering
Show me a Unity C# example demonstrating `Debug.LogException`.
ant of Debug.Log that logs an exception message to the console. When you select the message in the Editor's console, the context object to which the message applies 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...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3381c77d107b
unity_docs
rendering
Give me an overview of the `EditorGUI` class in Unity.
EditorGUI class in UnityEditor Description These work pretty much like the normal GUI functions - and also have matching implementations in EditorGUILayout . Static Properties Property Description actionKey Is the platform-dependent "action" modifier key held down? (Read Only) indentLevel The indent level of...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e2ce6332a73
unity_docs
rendering
What is `TileEditor.RenderStaticPreview` in Unity? Explain its purpose and usage.
TileEditor.RenderStaticPreview Declaration public Texture2D RenderStaticPreview (string assetPath , Object[] subAssets , int width , int height ); Parameters Parameter Description assetPath The asset to operate on. subAssets An array of all Assets at assetPath. width Width of the created texture. h...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a03c5708c2dc
unity_docs
scripting
What is `WSA.Launcher.LaunchFile` in Unity? Explain its purpose and usage.
Launcher.LaunchFile Declaration public static void LaunchFile ( WSA.Folder folder , string relativeFilePath , bool showWarning ); Parameters Parameter Description folder Folder type where the file is located. relativeFilePath Relative file path inside the specified folder. showWarning Shows user a war...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_383225aec735_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Manages input fallback for when eye tracking is not available. Signature: ```csharp public class GazeInputManager : MonoBehaviour ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3ffa012546bd
unity_docs
scripting
Give me an overview of the `PenStatus` class in Unity.
PenStatus enumeration Description Options for specifying the state of the pen. For example, whether the pen is in contact with the screen or tablet, whether the pen is inverted, and whether buttons are pressed. You can combine states using bitwise OR operators. Before you process an event as a pen event, you shoul...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3b539b83820f
unity_docs
scripting
Show me a Unity C# example demonstrating `GameObject.SendMessageUpwards`.
very ancestor of the behaviour. A value parameter specified for a method that doesn't accept parameters is ignored. If options is set to SendMessageOptions.RequireReceiver an error is printed when the message is not picked up by any component. Note : Messages are not sent to MonoBehaviours attached to objects fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b12c72f11e8f
unity_docs
scripting
In Unity's 'Scene view navigation', what is 'Orientation overlay' and how does it work?
The Orientation overlay appears in the Scene view. This displays the Scene Camera’s current orientation, and allows you to change the viewing angle and projection mode. The Orientation overlay has a conical arm on each side of the cube. The arms at the forefront are labelled X , Y , and Z . Click on any of the conical ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3783474c2d3c
unity_docs
math
What is `GridLayout.GetBoundsLocal` in Unity? Explain its purpose and usage.
GridLayout.GetBoundsLocal Declaration public Bounds GetBoundsLocal ( Vector3Int cellPosition ); Parameters Parameter Description cellPosition Location of the cell. Returns Bounds Local bounds of cell at the location. Description Returns the local bounds for a cell at the location. Declaration pub...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7115b3829834
unity_docs
editor
Show me a Unity C# example demonstrating `AssetDatabase.DeleteAsset`.
leted. Returns bool Returns true if the asset has been successfully removed, false if it doesn't exist or couldn't be removed. Description Deletes the specified asset or folder. Paths should be relative to the project folder, for example: "Assets/MyTextures/hello.png" Additional resources: AssetDatabase.Delet...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_aea968c2b0fa
unity_docs
scripting
What is `Rendering.ResourcePathsBaseAttribute.location` in Unity? Explain its purpose and usage.
ResourcePathsBaseAttribute.location public Rendering.SearchType location ; Description The lookup method. As we don't store it at runtime, you cannot rely on this property for runtime operation.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_397538868178
unity_docs
scripting
What is `TerrainData.GetHeight` in Unity? Explain its purpose and usage.
TerrainData.GetHeight Declaration public float GetHeight (int x , int y ); Description Calculates the height in world space units of a point on the heightmap. x and y are pixel coordinates in the heightmap, and the returned value does not take into account the heightmap's position.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bd79a15a061a
unity_docs
scripting
Show me a Unity C# example demonstrating `Events.UnityEvent_3`.
UnityEvent<T0,T1,T2> class in UnityEngine.Events / Inherits from: Events.UnityEventBase / Implemented in: UnityEngine.CoreModule Description Three argument version of UnityEvent . Generics are supported, specify type parameters on initialization as shown in the example. Refer to Configure callbacks in the I...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0dd8a56e5d45
unity_docs
physics
Show me a Unity C# example demonstrating `EditorApplication.updateMainWindowTitle`.
EditorApplication.updateMainWindowTitle Parameters Parameter Description value Title description. Description Register a custom callback to specify how the Unity Editor title can be generated. Unity will trigger this callback when a new scene is loaded , when Unity starts or when EditorApplication.UpdateMainWi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a7923db0ac9
unity_docs
rendering
What is `Experimental.Lightmapping.SetLightDirty` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Lightmapping.SetLightDirty Declaration public static void SetLightDirty ( Light light ); Parameters Parameter Description light The light to set as dirty. Description Manually sets a light as dirty. Use this method t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7a13d51f70bb
unity_docs
rendering
Explain 'Set a shader to require GPU features' in Unity.
You can use #pragma directives to indicate that a shader pass requires certain GPU features. At runtime, Unity compiles the shader only if the platform supports the features. Use one of the following in the HLSLPROGRAM block of a shader: #pragma require to specify individual GPU features that a shader requires, for exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_e052c8054251
unity_docs
rendering
Explain 'Shader Import Settings window reference' in Unity.
View and edit properties and settings for a shader . ## ShaderLab shader properties The following properties are available only for ShaderLab shaders . Property Description Default Maps Displays the textures that appear as material properties. NonModifiable Maps Displays the textures that have the [NonModifiableTextu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ce4b83eb86c5
unity_docs
rendering
In Unity's 'Set the blending mode in a shader', what is 'Examples' and how does it work?
``` Shader "Examples/CommandExample" { SubShader { // The rest of the code that defines the SubShader goes here. Pass { // Enable regular alpha blending for this Pass Blend SrcAlpha OneMinusSrcAlpha // The rest of the code that defines the Pass goes here. } } } ``` This example code demonstrates the synta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e1e41d9c38d2
unity_docs
scripting
What is `UIElements.FontDefinition.FromSDFFont` in Unity? Explain its purpose and usage.
FontDefinition.FromSDFFont Declaration public static UIElements.FontDefinition FromSDFFont ( TextCore.Text.FontAsset f ); Parameters Parameter Description f The SDF font to use to display text. Returns FontDefinition A new FontDefinition object. Description Create a FontDefinition from FontAsset...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8c9689d7f3a9
unity_docs
rendering
What is `Rendering.BatchDrawCommandIndirect.splitVisibilityMask` in Unity? Explain its purpose and usage.
BatchDrawCommandIndirect.splitVisibilityMask public ushort splitVisibilityMask ; Description Indicates which splits that the draw command is visible in. Unity uses this when it culls shadow map splits simultaneously. A split refers to a shadow cascade in a directional light shadow map or a cube map face in a p...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7ae9639a229c
unity_docs
rendering
What is `Cubemap.SetPixels` in Unity? Explain its purpose and usage.
Cubemap.SetPixels Declaration public void SetPixels (Color[] colors , CubemapFace face , int miplevel ); Declaration public void SetPixels (Color[] colors , CubemapFace face ); Parameters Parameter Description colors The array of pixel colours to use. This is a 2D image flattened to a 1D array. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_33bbdda78243_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A base class for MonoBehaviours that can beinstantiatedor addedto a with eleven arguments passed to the function of the created instance.Instances of classes inheriting from receive the arguments via the method where they can be assigned to member fields or properties. Type of the first argument received in the fun...
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_sr_82adeb4c43f8
unity_docs
physics
What is `Joint.currentTorque` in Unity? Explain its purpose and usage.
Joint.currentTorque public Vector3 currentTorque ; Description The torque applied by the solver to satisfy all constraints. The returned value is relative to Joint.connectedBody if it's set. Otherwise, in world space. Additional resources: Joint.currentForce .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_04f768182247
unity_docs
editor
What is `MPE.ProcessLevel` in Unity? Explain its purpose and usage.
ProcessLevel enumeration Description The type of the current process. It can be a Unity master instance, or a secondary instance connected to the master. Properties Property Description Main The current process is a main instance of UnityEditor. Secondary The current process is a secondary instance of UnityEdi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_acf1202c42d8
unity_docs
editor
What are the parameters of `EditorGUILayout.PropertyField` in Unity?
Returns bool True if the property has children, is expanded, and includeChildren is set to false; otherwise false. You can use it to determine the isExpanded state of the property and customize the rendering of children if necessary. Description Make a field for SerializedProperty . Use this when you want to customise ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_3183fead4295
unity_docs
physics
What is `SearchService.ISearchEngineBase.EndSession` in Unity? Explain its purpose and usage.
ISearchEngineBase.EndSession Declaration public void EndSession ( SearchService.ISearchContext context ); Parameters Parameter Description context The search context. Description A function called at the end of a search session. Depending on the type of engine ( ISceneSearchEngine , IProjectSearchEngine...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a5e6f1d04408
unity_docs
input
What is `DeviceSimulation.TouchEvent` in Unity? Explain its purpose and usage.
TouchEvent struct in UnityEditor.DeviceSimulation Description Representation of a single touch event coming from a Device Simulator. Subscribe to DeviceSimulator.touchScreenInput to receive these events. Properties Property Description phase Phase of the touch event. position On-screen position of the touch...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d15504820c3e
unity_docs
scripting
What is `Unity.Loading.ContentFile.GlobalTableDependency` in Unity? Explain its purpose and usage.
ContentFile.GlobalTableDependency public static Unity.Loading.ContentFile GlobalTableDependency ; Description This ContentFile can be passed as a dependency to ContentLoadInterface.LoadContentFileAsync or ContentLoadInterface.LoadSceneAsync to indicate that the external file dependencies should be resolv...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_58632c31c6d9
unity_docs
math
What is `BoundsInt.PositionEnumerator` in Unity? Explain its purpose and usage.
PositionEnumerator struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description An iterator that allows you to iterate over all positions within the BoundsInt . Properties Property Description Current Current position of the enumerator. Public Methods Method Description GetEnumerator Retur...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.