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
gh_ecac194c16fb_doc_5
github
scripting
What does `Destroy` do in this Unity script? Explain its purpose and signature.
Uninitializes the API instance. This frees up any resources allocated by the plugins including all streamed meshes in the scene. Preferably, this should be called from within the OnApplicationQuit() method. Signature: ```csharp public void Destroy() ```
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_sr_5c7e95fa2cae
unity_docs
animation
Show me a Unity C# example demonstrating `Animations.RotationConstraint.rotationAxis`.
RotationConstraint.rotationAxis public Animations.Axis rotationAxis ; Description The axes affected by the RotationConstraint. Use this property to restrict the effect of the constraint on a particular axis. ```csharp using UnityEngine.Animations;public class ConstraintAxis { public void ConstrainOnlyOnXY(R...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_2daea0e47945
unity_docs
physics
Show me a Unity C# example demonstrating `Rigidbody2D.MoveRotation`.
recommended that you use this for relatively small rotational movements only. It is important to understand that the actual rotation change will only occur during the next physics update therefore calling this method repeatedly without waiting for the next physics update will result in the last call being used. For thi...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_371a47dd6794
unity_docs
editor
What is `EditorWindow.FocusWindowIfItsOpen` in Unity? Explain its purpose and usage.
EditorWindow.FocusWindowIfItsOpen Declaration public static void FocusWindowIfItsOpen (Type t ); Parameters Parameter Description windowType The type of the window. Must derive from EditorWindow. Description Focuses the first found EditorWindow of specified type if it is open. If there is no open window o...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_960e6d0bb464
unity_docs
input
What is `DeviceSimulation.TouchPhase` in Unity? Explain its purpose and usage.
TouchPhase enumeration Description Indicates where in its lifecycle a given touch is. Properties Property Description Began A touch has begun. Only the first touch event in any given touch will have this phase. Moved A touch has changed position. Ended A touch has ended. Only the last touch event in a given t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f5879fc242e6
unity_docs
rendering
What is `TextureImporterSettings.CopyTo` in Unity? Explain its purpose and usage.
TextureImporterSettings.CopyTo Declaration public void CopyTo ( TextureImporterSettings target ); Parameters Parameter Description target TextureImporterSettings object to copy settings to. Description Copy parameters into another TextureImporterSettings object.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b5fb1afdd89b
unity_docs
scripting
What is `Rendering.BatchDrawCommand.meshID` in Unity? Explain its purpose and usage.
BatchDrawCommand.meshID public Rendering.BatchMeshID meshID ; Description Identifies which Mesh to use to render the instances in this draw command. If the Mesh contains sub-meshes, use BatchDrawCommand.submeshIndex to specify which sub-mesh to use.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_695a8bb069a9
unity_docs
rendering
Explain 'Enable GPU instancing for a prebuilt material' in Unity.
To enable GPU instancing for a prebuilt materials , follow these steps: Select the material in the Project window. In the Advanced Options section of the Inspector window, enable Enable GPU Instancing . Note: If you use the Universal Render Pipeline (URP) or High Definition Render Pipeline (HDRP), the recommended best ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dfdbaab69e3b
unity_docs
editor
What is `SceneManagement.EditorSceneManager.CloseScene` in Unity? Explain its purpose and usage.
EditorSceneManager.CloseScene Declaration public static bool CloseScene ( SceneManagement.Scene scene , bool removeScene ); Parameters Parameter Description scene The Scene to be closed/removed. removeScene Bool flag to indicate if the Scene should be removed after closing. Returns bool Returns true ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d49e64a4e7c6
unity_docs
rendering
Show me a Unity C# example demonstrating `ImageConversion.EncodeNativeArrayToJPG`.
store the encoded data as a file or send it over the network without further processing. This function does not work on any compressed format. The encoded JPG data will be either 8bit grayscale, RGB or RGBA (depending on the passed in format). The native array that this function returns is allocated with the persis...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_0b973bbbe09a_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
A 2D rectangular mask that allows for clipping / masking of areas outside the mask.The RectMask2D behaves in a similar way to a standard Mask component. It differs though in some of the restrictions that it has.A RectMask2D:*Only works in the 2D plane*Requires elements on the mask to be coplanar.*Does not require stenc...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_b918f56b53fc
unity_docs
rendering
What is `TextureImporter.swizzleB` in Unity? Explain its purpose and usage.
TextureImporter.swizzleB public TextureImporterSwizzle swizzleB ; Description Specifies the source for the texture's blue color channel data. By default, values for the imported texture's blue channel come from the source image's blue channel. To reorder or invert color channels at import time, change this t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fe3216df3944
unity_docs
rendering
What is `AssetPreview.SetPreviewTextureCacheSize` in Unity? Explain its purpose and usage.
AssetPreview.SetPreviewTextureCacheSize Declaration public static void SetPreviewTextureCacheSize (int size ); Parameters Parameter Description size The number of previews that can be loaded into the cache before the least used previews are being unloaded. Description Set the asset preview cache to a size ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_ce8d94eb73a5
github
scripting
Write a Unity Editor script for Grid Map Manager Editor
```csharp using System.Collections; using System.Collections.Generic; using UnityEngine; #if UNITY_EDITOR using UnityEditor; [CustomEditor(typeof(GridMapManager))] public class GridMapManagerEditor : SensorManagerEditor { public override void OnInspectorGUI() { base.OnInspectorGUI(); GridMapMan...
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_sr_e05555788bfa
unity_docs
rendering
What is `ModelImporterSecondaryUVMarginMethod` in Unity? Explain its purpose and usage.
ModelImporterSecondaryUVMarginMethod enumeration Description Methods for handling margins during lightmap UV generation in ModelImporter . Properties Property Description Manual Specify pack margin manually. Calculate Calculate suitable lightmap UV margins based on expected lightmap resolution and object scal...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ce1e8ea25859
unity_docs
rendering
In Unity's 'Control when a Custom Render Texture updates', what is 'Controlling Custom Render Texture from Script' and how does it work?
You can access most of the Custom Render Texture functionalities in the Scripting API. You can also change Material parameters, update frequency, update zones, request an update, and more using a script. When Unity updates or initializes a Custom Render Texture, it uses the current properties to render the next frame. ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_75f8532990f5
unity_docs
scripting
What is `AI.NavMeshBuildMarkup.overrideIgnore` in Unity? Explain its purpose and usage.
NavMeshBuildMarkup.overrideIgnore public bool overrideIgnore ; Description Set this to true in order to enable the ignoreFromBuild property. In the case when a NavMeshBuildMarkup is used to change only the area type of an object, overrideIgnore should be set to false so that the ignoreFromBuild prop...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_ef1b4fbdb3ee
unity_docs
physics
Explain 'Wheel colliders' in Unity.
The Wheel collider is a collider for grounded vehicles. It has built-in collision detection, wheel physics, and a slip-based tire friction model. It can be used for objects other than wheels, but it is specifically designed for vehicles with wheels. Unity’s PhysX integration uses the PhysX 4.1 Vehicles SDK to simulate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_702815aabe93
unity_docs
physics
Give me an overview of the `ParticleSystemCollisionMode` class in Unity.
ParticleSystemCollisionMode enumeration Description Whether to use 2D or 3D colliders for particle collisions. Properties Property Description Collision3D Use 3D colliders to collide particles against. Collision2D Use 2D colliders to collide particles against.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1fe1d259eca9
unity_docs
rendering
Show me a Unity C# example demonstrating `ParticleSystemRenderer.meshDistribution`.
ParticleSystemRenderer.meshDistribution public ParticleSystemMeshDistribution meshDistribution ; Description Specifies how the system randomly assigns meshes to particles. Additional resources: ParticleSystemRenderer.renderMode . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_15e343e6515a
unity_docs
rendering
What is `Rendering.ShadowSamplingMode.CompareDepths` in Unity? Explain its purpose and usage.
ShadowSamplingMode.CompareDepths Description Default shadow sampling mode: sampling with a comparison filter. The texture and sampler should be declared with: UNITY_DECLARE_SHADOWMAP(_Shadowmap); and sampled with: UNITY_SAMPLE_SHADOW(_Shadowmap, half3(uv, depth_for_comparison)); .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_39ae865dc71f
unity_docs
rendering
What is `ParticleSystem.ShapeModule.sphericalDirectionAmount` in Unity? Explain its purpose and usage.
ParticleSystem.ShapeModule.sphericalDirectionAmount public float sphericalDirectionAmount ; Description Makes particles move in a spherical direction from their starting point. This accepts values from 0 to 1, where 0 causes the particles to retain their default direction and 1 causes a completely spherical di...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e342e1e7c6b3
unity_docs
scripting
What are the parameters of `RectTransform.GetWorldCorners` in Unity?
Description Get the corners of the calculated rectangle in world space. Each corner provides its world space value. The returned array of 4 vertices is clockwise. It starts bottom left and rotates to top left, then top right, and finally bottom right. Note that bottom left, fo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0c3ec00463ca
unity_docs
animation
Explain 'Introduction to assets in Unity' in Unity.
An asset is any item that you use in your Unity project to create your application, such as textures, 3D models, or sound files. Assets can include: Visual elements : 3D models, textures, or sprites . Audio elements : Sound effects or music. Abstract items : Color gradients, animation masks, arbitrary text, or numeric ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_c174f7f1ed95
unity_docs
scripting
In Unity's 'Animation from external sources', what is 'View and copy data from imported animation files' and how does it work?
You can view the keyframes and curves of imported animation clips in the Animation window. If these imported clips have many bones with many keyframes, the amount of animation data can be overwhelming. For example, the following image shows bones and keyframes for a run animation: To limit the animation data being disp...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_915c966e4c9f
unity_docs
scripting
What is `Android.AndroidAssetPackInfo.transferProgress` in Unity? Explain its purpose and usage.
AndroidAssetPackInfo.transferProgress public float transferProgress ; Description The transfering progress of the downloaded Android asset pack. A floating point value. The range is 0 through 1. Read-only. Asset packs get compressed to reduce the download size. After they are downloaded, they have to be uncompr...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_338e6108fb90
unity_docs
audio
What is `AudioClip.length` in Unity? Explain its purpose and usage.
AudioClip.length public float length ; Description The length of the audio clip in seconds. (Read Only) ```csharp //Attach an AudioSource component to a GameObject along with this script. //Click and drag or choose an Audio clip to the AudioClip field in the AudioSource. //Click and drag or choose a different ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_67704c5ee67f
unity_docs
performance
What is `Profiling.Profiler.GetTempAllocatorSize` in Unity? Explain its purpose and usage.
Profiler.GetTempAllocatorSize Declaration public static uint GetTempAllocatorSize (); Returns uint Size in bytes. Description Returns the size of the temp allocator. Size of Unity's stack-based runtime allocator used for temporary allocations.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_02518e052ee3
unity_docs
ui
What is `GUIStyle.onFocused` in Unity? Explain its purpose and usage.
GUIStyle.onFocused public GUIStyleState onFocused ; Description Rendering settings for when the element has keyboard and is turned on. ```csharp using UnityEngine;public class Example : MonoBehaviour { void OnGUI() { GUI.skin.button.onFocused.textColor = Color.green; } } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_98dd4c89ecbc
unity_docs
math
What is `Transform.TransformDirections` in Unity? Explain its purpose and usage.
Transform.TransformDirections Declaration public void TransformDirections (Span<Vector3> directions ); Parameters Parameter Description directions The directions to be transformed, each is replaced by the transformed version. Description Transforms multiple directions from local space to world space overw...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_cd86a053e350
unity_docs
rendering
In Unity's 'Search assets with the Project search provider', what is 'Properties' and how does it work?
The syntax for properties in the Project search provider: Don’t use the # and p prefixes that you use in the Hierarchy search provider. If a property is unique to a component, you don’t have to specify the component in the query. For example, p: mass:5.15 is equivalent to p: articulationbody.mass:5.15 if the GameObject...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_246d14739c18
unity_docs
math
What is `Rendering.BatchCullingOutputDrawCommands.drawCommandCount` in Unity? Explain its purpose and usage.
BatchCullingOutputDrawCommands.drawCommandCount public int drawCommandCount ; Description The number of elements in the BatchCullingOutputDrawCommands.drawCommands array. You must set this in the OnPerformCulling callback.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d573df66a0fe
unity_docs
physics
What is `ConfigurableJoint.projectionAngle` in Unity? Explain its purpose and usage.
ConfigurableJoint.projectionAngle public float projectionAngle ; Description Set the angular tolerance threshold (in degrees) for projection. If the joint deviates by more than this angle around its locked angular degrees of freedom, the solver will move the bodies to close the angle. Setting a very small toler...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9bc6fe461881
unity_docs
rendering
What is `Experimental.GlobalIllumination.SpotLightPyramidShape.falloff` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. SpotLightPyramidShape.falloff public Experimental.GlobalIllumination.FalloffType falloff ; Description The falloff model to use for baking the pyramid light.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_1a04e84957f9
unity_docs
scripting
What is `PlayerSettings.iOS.targetOSVersionString` in Unity? Explain its purpose and usage.
PlayerSettings.iOS.targetOSVersionString public static string targetOSVersionString ; Description Deployment minimal version of iOS. Version follows "<Major>.<Minor>" format, for example "9.2". If set to empty, default supported minimal version will be used.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_22e17f79b2bc
unity_docs
editor
What are the parameters of `iOS.Xcode.PBXProject.AddFileToBuildSection` in Unity?
Description Configures file for building for the given native target on specific build section. The function is equivalent to AddFileToBuild except that a specific build section is defined. In projects containing multiple native targets, you can configure a single file or folder reference to build in all, some, or none...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_71f9bd7d456c
unity_docs
scripting
Explain 'Game view reference' in Unity.
The Game view is rendered from the Cameras in your application. The Game view displays how your final, built application looks. You need to use one or more Cameras to control what the player sees when they’re using your application. The Game view is included in the default Unity Editor layout . If the Game view is not ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_0e138bd72d08
unity_docs
rendering
What is `RenderTextureMemoryless` in Unity? Explain its purpose and usage.
RenderTextureMemoryless enumeration Description Flags enumeration of the render texture memoryless modes. Additional resources: RenderTexture.memorylessMode , RenderTexture . Properties Property Description None The render texture is not memoryless. Color Render texture color pixels are memoryless when Rend...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d27ecf4e2ab8
unity_docs
editor
What is `QualitySettings.IsPlatformIncluded` in Unity? Explain its purpose and usage.
QualitySettings.IsPlatformIncluded Declaration public static bool IsPlatformIncluded (string buildTargetGroupName , int index ); Parameters Parameter Description buildTargetGroupName The platform name. index The index of the Quality Level, must be positive and lower than the count of Quality Levels. Ret...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_bee372490d3f
unity_docs
input
What is `SystemInfo.GetCompatibleFormat` in Unity? Explain its purpose and usage.
SystemInfo.GetCompatibleFormat Declaration public static Experimental.Rendering.GraphicsFormat GetCompatibleFormat ( Experimental.Rendering.GraphicsFormat format , Experimental.Rendering.GraphicsFormatUsage usage ); Parameters Parameter Description format The GraphicsFormat format to look up. usage ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7a6e50337644
unity_docs
scripting
What is `AI.NavMeshAgent.speed` in Unity? Explain its purpose and usage.
NavMeshAgent.speed public float speed ; Description Maximum movement speed when following a path. An agent will typically need to speed up and slow down as it follows a path (eg, it will slow down to make a tight turn). The speed is often limited by the length of a path segment and the time taken to accelerate ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_8dd63cd50f4f
unity_docs
scripting
Show me a Unity C# example demonstrating `RenderingLayerMask.RenderingLayerToName`.
RenderingLayerMask.RenderingLayerToName Declaration public static string RenderingLayerToName (int layer ); Parameters Parameter Description layer Provide a layer index. Returns string Returns empty string if not found. Description Given a rendering layer index, returns the name of the layer as defin...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_fc04e0c8b118
unity_docs
editor
Show me a Unity C# example demonstrating `Search.SearchViewState`.
SearchViewState class in UnityEditor.Search Implements interfaces: ISerializationCallbackReceiver Description Search view state is used to create new Search windows. See SearchService.ShowWindow . ```csharp using UnityEditor; using UnityEditor.Search; using UnityEngine.Search;static class SearchWindows { [Menu...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_bf6ca125b2f4
unity_docs
ui
Explain 'Multiple selectors' in Unity.
A multiple selector is an combination of multiple simple selectors. It selects any elements that match all the simple selectors. ## Syntax A multiple selector consists of multiple simple selector without anything to separate them: ``` selector1selector2 {...} ``` The USS parser can’t parse a multiple selector if it c...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_68ef824df427
unity_docs
scripting
What is `CharacterController.height` in Unity? Explain its purpose and usage.
CharacterController.height public float height ; Description The height of the character's capsule. ```csharp using UnityEngine;public class Example : MonoBehaviour { // Set the controller height to 2.0 CharacterController controller; void Start() { controller = GetComponent<CharacterController>(); contro...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_f72b4253425f
unity_docs
xr
Explain 'Universal Windows Platform' in Unity.
Universal Windows Platform (UWP) provides a common app platform on every device that runs Windows, such as Windows 10+, HoloLens, and more. You can use UWP to build your Unity apps for any Windows device and publish them to the Microsoft Store, without needing to rewrite the app for each platform. Topic Description Int...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_d8880ddbee3b_doc_0
github
scripting
What does `this member` do in this Unity script? Explain its purpose and signature.
Removes all objects in a scene using a particular tag Signature: ```csharp public class RemoveObjectsWithTag : MonoBehaviour ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_3526b6e6f253
unity_docs
editor
Explain 'Customize error handling' in Unity.
Choose how to handle errors in your Web builds. Unity writes some JavaScript code to builds by default, which handles errors. This code displays warning messages when running on unsupported platforms and parses error and exception strings from the browser to check for known errors and display error dialogs with more co...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_dcd8651de0d6
unity_docs
ui
In Unity's 'Create a custom style for a custom control', what is 'Create the custom control and custom style' and how does it work?
Create a USS file named ExampleElementCustomStyle.uss and replace its contents with the following: ``` ExampleElementCustomStyle { --gradient-from: red; --gradient-to: yellow; } ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_8fdd07d542f9
unity_docs
math
Show me a Unity code example for 'USS transform'.
This is the default value) Center of left edge left left center center left Center of right edge right right center center right Center of top edge top top center center top Center of bottom edge bottom bottom center center bottom Top-left corner top left left top Top-right corner top right right top Bottom-left corner...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7eee348f107b
unity_docs
scripting
What is `Time.captureDeltaTimeRational` in Unity? Explain its purpose and usage.
Time.captureDeltaTimeRational public static Unity.IntegerTime.RationalTime captureDeltaTimeRational ; Description Slows your application’s playback time to allow Unity to save screenshots in between frames. Same as captureDeltaTime but using a RationalTime representation. The returned timeAsRational shares th...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_254c14b4b7a0
unity_docs
scripting
Show me a Unity C# example demonstrating `Space.World`.
World to transform a GameObject relative to its Transform.position and the scene axes, ignoring the GameObject's own orientation. For example, Transform.Translate(Vector3.forward, Space.World) adds one unit to the object's Transform.position on the z-axis of the scene. To transform a GameObject relative to its ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e3638f791235
github
scripting
Write a Unity C# ScriptableObject for Base Code Generator Settings
```csharp using System; using System.IO; using UnityEngine; namespace CodeGeneration.Base { /// <summary> /// Base settings object for <see cref="BaseCodeGenerator{T}"/> /// </summary> public abstract class BaseCodeGeneratorSettings<T> : ScriptableObject where T : BaseScriptTemplate { /// ...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_7bf26370db6f
unity_docs
scripting
Explain 'ObjectField' in Unity.
An ObjectField is an Editor-only element that lets users select a Unity object from a list of available objects. You can use it to select a Unity object to use as a reference, such as a material, a texture, a script, or a GameObject . Note : To align an element with other fields in an Inspector window, simply apply the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_b479513206c9
unity_docs
scripting
In Unity's 'PSO tracing and warming example', what is 'Trace and warm up with the URP sample project' and how does it work?
To trace and warm up PSOs with the sample project: Open the main terminal scene from Assets/Scenes/Terminal/TerminalScene.unity . Add an empty GameObject to the scene. Open your empty GameObject in the Inspector , select Add Component and add the Graphics State Collection Manager component. Set the Mode property of the...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_492576c77677
unity_docs
rendering
What is `TextureFormat.RGFloat` in Unity? Explain its purpose and usage.
TextureFormat.RGFloat Description Two color (RG) texture format, 32 bit floating point per channel. Note that not all graphics cards support all texture formats, use SystemInfo.SupportsTextureFormat to check.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_00fbff61e5a6
unity_docs
scripting
What is `Rendering.ScriptableRenderContext.SubmitForRenderPassValidation` in Unity? Explain its purpose and usage.
ScriptableRenderContext.SubmitForRenderPassValidation Declaration public bool SubmitForRenderPassValidation (); Description This method submits all the scheduled commands to the rendering loop for validation. The validation checks whether render passes that were started with the BeginRenderPass call can execut...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e26f44922f2
unity_docs
rendering
Show me a Unity C# example demonstrating `Texture2D.GetPixelData`.
oint to the correct memory location if the texture has been modified or updated. If you use a small type for T such as byte , GetPixelData may fail because the NativeArray would exceed the maximum length ( Int32.MaxValue ). To avoid this, use a larger type or struct. GetPixelData throws an exception when it fai...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_81c9243b5a7c
unity_docs
scripting
In Unity's 'Troubleshooting automatically generated lightmap UVs', what is 'Angle distortion' and how does it work?
The following screenshots demonstrate equal resolution, but with different UVs. The first image has a high Angle Error , and the result contains unintended artifacts. The second image has the default Angle Error (8%). In Meshes with more triangles, angle distortion can significantly distort the shape.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_dcaec6fe3bc5
unity_docs
editor
Show me a Unity C# example demonstrating `EditorWindow.EndWindows`.
EditorWindow.EndWindows Declaration public void EndWindows (); Description Close a window group started with EditorWindow.BeginWindows . Simple editor Window with a window and a button inside. ```csharp using UnityEditor; using UnityEngine; using System.Collections; public class IMGUIWindowDemo : EditorWindo...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_34f990bdd815
unity_docs
ui
What is `Connect.ProjectBindDrawer.GetVisualElement` in Unity? Explain its purpose and usage.
ProjectBindDrawer.GetVisualElement Declaration public UIElements.VisualElement GetVisualElement (); Returns VisualElement Returns the VisualElement containing the ProjectBind UI. Description Retrieves the ProjectBind UI.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e8512f4e23f9
unity_docs
scripting
What is `ScriptableWizard.DrawWizardGUI` in Unity? Explain its purpose and usage.
ScriptableWizard.DrawWizardGUI Declaration protected bool DrawWizardGUI (); Returns bool Returns true if any property has been modified. Description Will be called for drawing contents when the ScriptableWizard needs to update its GUI. Derived class may override this function to provide customized behavio...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7fc75cabe94d
unity_docs
rendering
Show me a Unity code example for 'Set the culling mode in a shader'.
draw. Culling improves rendering efficiency, by not wasting GPU time drawing things that would not be visible in the final image. By default, the GPU performs back-face culling; this means that it does not draw polygons that face away from the viewer. In general, the more you can reduce the rendering workload, the bett...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_af463af4e944
unity_docs
scripting
What is `Quaternion.w` in Unity? Explain its purpose and usage.
Quaternion.w public float w ; Description W component of the Quaternion. Do not directly modify quaternions. ```csharp using System.Collections; using System.Collections.Generic; using UnityEngine;// Quaternion-w script example // Create a Sphere and apply a texture to help the orientation be recognised. // At...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5ae0919a2ed5
unity_docs
rendering
What is `ParticleSystem.RotationBySpeedModule` in Unity? Explain its purpose and usage.
RotationBySpeedModule struct in UnityEngine / Implemented in: UnityEngine.ParticleSystemModule Description Script interface for the RotationBySpeedModule. Rotate particles based on their speed. Additional resources: ParticleSystem , ParticleSystem.rotationBySpeed . Properties Property Description enabled...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_72dfd65d560c
unity_docs
rendering
Give me an overview of the `RenderTargetSetup` class in Unity.
RenderTargetSetup struct in UnityEngine / Implemented in: UnityEngine.CoreModule Description Fully describes setup of RenderTarget. Properties Property Description color Color Buffers to set. colorLoad Load Actions for Color Buffers. It will override any actions set on RenderBuffers themselves. colorStore ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_362baedf3b54
unity_docs
editor
What is `Search.QueryToken` in Unity? Explain its purpose and usage.
QueryToken struct in UnityEditor.Search Description Represents a token of a query string. Properties Property Description length The length of the token. Can be different than the length of the text. position The position of the token in the query string. text The text representing the token. Constructors ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_737ee038860f
unity_docs
scripting
Show me a Unity C# example demonstrating `ParticleSystem.ColorBySpeedModule.enabled`.
ParticleSystem.ColorBySpeedModule.enabled public bool enabled ; Description Specifies whether the ColorBySpeedModule is enabled or disabled. Additional resources: ParticleSystem.colorBySpeed . ```csharp using UnityEngine; using System.Collections;[RequireComponent(typeof(ParticleSystem))] public class Exampl...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_e4cce36f7fcf_doc_1
github
scripting
What does `PermissionCallbacksPermissionGranted` do in this Unity script? Explain its purpose and signature.
Permission Granted callback Signature: ```csharp private static void PermissionCallbacksPermissionGranted(string permissionName) ```
You are a senior Unity engineer. Answer questions about Unity scripting, XR/VR development, and game systems with working code examples.
local_man_40794c7fe462
unity_docs
scripting
Show me a Unity code example for 'Define a data source for runtime binding'.
g object, you must define a data source. The data source is the object that contains the property you want to bind to. You can use any C# object as the runtime binding data source. To enable the binding system to access the data source, you must define the dataSource property of the binding object to the data source ob...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5e788d09fdf3
unity_docs
editor
Show me a Unity C# example demonstrating `iOS.Xcode.PBXProject.RemoveFrameworkFromProject`.
ers Parameter Description targetGuid The GUID of the target, such as the one returned by TargetGuidByName . framework The name of the framework. The extension of the filename must be .framework . Description Removes a system framework dependency for the specified target. The function assumes system frameworks...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_72547d1ca0f8
unity_docs
rendering
In Unity's 'Set up a scene for occlusion culling', what is 'Setting up your Scene' and how does it work?
Before you begin, identify all of the GameObjects in your Scene that you would like to be Static Occluders (GameObjects that do not move, and that block the view of GameObjects that are behind them) and Static Occludees (GameObjects that do not move, and are occluded by Static Occluders). A GameObject can be both a Sta...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_c3844ae4de40
unity_docs
scripting
What is `IntegratedSubsystem.Start` in Unity? Explain its purpose and usage.
IntegratedSubsystem.Start Declaration public void Start (); Description Starts an instance of a subsystem. Once the instance is started, the subsystem representing this instance is active and can be interacted with.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d4485f9a4e3f
unity_docs
scripting
Show me a Unity C# example demonstrating `SceneManagement.SceneManager.sceneLoaded`.
nSceneLoaded to SceneManager.sceneLoaded in the OnEnable callback and unassigns it in the OnDisable callback. The code example and comment annotations demonstrate the execution order of the callbacks. Unity raises the SceneManager.sceneLoaded event and invokes the associated callback after OnEnable but befor...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1724f442d80c_doc_5
github
scripting
What does `AllowedBrushGuids` do in this Unity script? Explain its purpose and signature.
Filters and returns geometry in a convenient format for export.Returns geometry for the main canvas Signature: ```csharp private static HashSet<Guid> AllowedBrushGuids => new( BrushCatalog.m_Instance.AllBrushes .Where(b => b.m_AllowExport) .Select(b => (Guid)b.m_Guid)); ```
You are a knowledgeable Unity developer. Explain Unity concepts clearly and provide practical, tested code examples.
local_man_825d9ef760a6
unity_docs
editor
In Unity's 'Build your application for Dedicated Server', what is 'Command line' and how does it work?
To create a Dedicated Server build through the command line, use the -standaloneBuildSubtarget Server argument . ``` -buildTarget Linux64 -standaloneBuildSubtarget Server ```
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f8f61757cda8
unity_docs
editor
What are the parameters of `EditorGUI.DrawRect` in Unity?
Description Draws a filled rectangle of color at the specified position and size within the current editor window. Use this to give blocks of Color to areas you want to highlight in the Inspector window of a GameObject in the Editor. You can also use them to simulate statistics in the Editor, for example, an in-Editor ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_6219d44c833a
unity_docs
scripting
In Unity's 'Adding profiler markers to your code', what is 'Marking up your code' and how does it work?
To use the ProfilerMarker API , place the code you want to profile between calls to ProfilerMarker.Begin and ProfilerMarker.End . For example: ```csharp using UnityEngine; using Unity.Profiling; public class ProfilerMarkerExample { static readonly ProfilerMarker k_MyCodeMarker = new ProfilerMarker("My Code"); void ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d182319c5315
unity_docs
scripting
What is `ObjectChangeEventStream.Builder.PushDestroyGameObjectHierarchyEvent` in Unity? Explain its purpose and usage.
ObjectChangeEventStream.Builder.PushDestroyGameObjectHierarchyEvent Declaration public void PushDestroyGameObjectHierarchyEvent (ref DestroyGameObjectHierarchyEventArgs data ); Parameters Parameter Description data The event data to add to the stream. Description Adds an DestroyGameObjectHierarchyEventA...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_7b8becda2ea4
unity_docs
rendering
Explain 'Custom Render Texture Inspector window reference' in Unity.
The Custom Render Textures Inspector window displays many of the same properties as the Render Texture Inspector, and some properties specific to Custom Render Textures . ## Render Texture: Property: Function: Dimension Dimension of the Render Texture. 2D Makes the Render Texture two-dimensional. Cube Makes the Rende...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5d85961f1289
unity_docs
scripting
What is `Experimental.GraphView.Port.edgeConnector` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. Port.edgeConnector public Experimental.GraphView.EdgeConnector edgeConnector ; Description Reference to the edge connector.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_5a05c7ca876a
unity_docs
input
What is `UIElements.ScrollView.scrollDecelerationRate` in Unity? Explain its purpose and usage.
ScrollView.scrollDecelerationRate public float scrollDecelerationRate ; Description Controls the rate at which the scrolling movement slows after a user scrolls using a touch interaction. The deceleration rate is the speed reduction per second. A value of 0.5 halves the speed each second. A value of 0 stops...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_de5bb3a6e1b8
unity_docs
scripting
What is `Experimental.Rendering.GraphicsFormat.RGBA_ASTC4X4_SRGB` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. GraphicsFormat.RGBA_ASTC4X4_SRGB Description A four-component, ASTC compressed format where each 128-bit compressed texel block encodes a 4×4 rectangle of unsigned normalized RGBA texel data with sRGB nonlinear encoding applied t...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_ee2548534edb
unity_docs
editor
What is `EditorGUI.hyperLinkClicked` in Unity? Explain its purpose and usage.
EditorGUI.hyperLinkClicked Parameters Parameter Description value The first parameter of type EditorWindow corresponds to the window that contains the text that was clicked. The second parameter of type HyperLinkClickedEventArgs contains the hyperlink data. Description Event used to react on clicks on a tex...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_035af61bf960
unity_docs
physics
What is `PhysicsMaterialCombine2D.Maximum` in Unity? Explain its purpose and usage.
PhysicsMaterialCombine2D.Maximum Description Uses a Maximum algorithm when combining friction or bounciness i.e. the maximum of the two values is used. Given two friction or bounciness values, the Maximum algorithm used is: valueA > valueB ? valueA : valueB .
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_7e9d3bb8fcac
unity_docs
ui
What is `Experimental.GraphView.NodeCreationContext.target` in Unity? Explain its purpose and usage.
Experimental : this API is experimental and might be changed or removed in the future. NodeCreationContext.target public UIElements.VisualElement target ; Description The VisualElement where the created node will be added.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a9b6701cff39
unity_docs
performance
What is `LightTransport.IDeviceContext` in Unity? Explain its purpose and usage.
IDeviceContext interface in UnityEngine.LightTransport Description Provides an abstraction layer for memory management, synchronization, and compute operations across different devices. The IDeviceContext interface abstracts memory, synchronization, and compute operations for different compute devices such as CPU...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_f1780859cca9
unity_docs
math
What is `AndroidJNI.CallStaticLongMethod` in Unity? Explain its purpose and usage.
AndroidJNI.CallStaticLongMethod Declaration public static long CallStaticLongMethod (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 Interfac...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_a8d0b8e24754
unity_docs
xr
What is `AudioSpeakerMode` in Unity? Explain its purpose and usage.
AudioSpeakerMode enumeration Description The speaker configurations that Unity supports. Unity supports multiple speaker types. Each speaker type has a different number of channels and is suitable for different device types and situations. The operating system (OS) and hardware determine the final output. Unity re...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
gh_1d32abf04edf
github
scripting
Write a Unity C# script called Rifle Weapon Asset
```csharp using System; using UnityEngine; [CreateAssetMenu(menuName = MENU_PATH + MENU_NAME, fileName = FILE_NAME)] class RifleWeaponAsset : WeaponAsset { public const string MENU_NAME = "Rifle Weapon Source"; public const string FILE_NAME = "Rifle Weapon Source"; [Label("Bullet Source"), SerializeField]...
You are an experienced Unity developer specializing in C# scripting, XR/VR development, and performance optimization.
local_man_3a7acc9acd79
unity_docs
rendering
Explain 'Declare DOTS Instancing properties in a custom shader in URP' in Unity.
To load instance data, such as transform matrices, the shader needs to define DOTS Instanced properties. Below is an example of a simple DOTS Instanced property block: ``` UNITY_DOTS_INSTANCING_START(MaterialPropertyMetadata) UNITY_DOTS_INSTANCED_PROP(float4, Color) UNITY_DOTS_INSTANCING_END(MaterialPropertyMetadata) ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_9dee88581b00
unity_docs
math
What is `Pose.operator_ne` in Unity? Explain its purpose and usage.
Pose.operator != public static bool operator != ( Pose a , Pose b ); Description Returns true if two poses are not equal. The Not Equals operator returns true if two Poses are not equivalent. Equivalent in this sense is determined by calling into the Equal operators of the internal Quaternion and Vector me...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_16846a4cbb2a
unity_docs
rendering
What is `LODFadeMode` in Unity? Explain its purpose and usage.
LODFadeMode enumeration Description The LOD (level of detail) fade modes. Modes other than LODFadeMode.None will result in Unity calculating a blend factor for blending/interpolating between two neighbouring LODs and pass it to your shader. Properties Property Description None Indicates the LOD fading is turn...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_59bc0587618c
unity_docs
physics
Give me an overview of the `TargetJoint2D` class in Unity.
TargetJoint2D class in UnityEngine / Inherits from: Joint2D / Implemented in: UnityEngine.Physics2DModule Description The joint attempts to move a Rigidbody2D to a specific target position. This joint is the only joint that doesn't connect two Rigidbody2D together. Instead, it only operates on the single ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_5d9ef0cce5d0
unity_docs
xr
In Unity's 'Game state hinting', what is 'Automated game state hinting' and how does it work?
Unity Player automatically sets the following parameters to indicate the game state to the operating system: Application loading state as isLoading parameter. This parameter is set to true during initial loading, when loading a scene , loading asset packs, or when sending a web request. Current scene index or the type ...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_47e5fdd7e340
unity_docs
scripting
Show me a Unity C# example demonstrating `Vector2.operator_subtract`.
Vector2.operator - public static Vector2 operator - ( Vector2 a , Vector2 b ); Returns Vector2 The difference between the two vectors, returned as a Vector2 struct. Description Subtracts one vector from another. Subtracts each component of b from a . ```csharp using UnityEngine;public class Exa...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_446bdfaf8949
unity_docs
rendering
What is `AssetImporters.LightDescription.GetFloatPropertyNames` in Unity? Explain its purpose and usage.
LightDescription.GetFloatPropertyNames Declaration public void GetFloatPropertyNames (List<string> names ); Parameters Parameter Description names The list of retrieved property names. Description Retrieves the property names of type float for this light.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_d0e9686b988e
unity_docs
editor
What is `Build.Profile.BuildProfile.GetScenesForBuild` in Unity? Explain its purpose and usage.
BuildProfile.GetScenesForBuild Declaration public EditorBuildSettingsScene[] GetScenesForBuild (); Returns EditorBuildSettingsScene[] The list of scenes used when building with the build profile. If the build profile is overriding the global scenes, returns the scenes specified in the build profile. Otherwise,...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_man_0b68a0fb0874
unity_docs
editor
In Unity's 'UITK Text Settings assets', what is 'Default Font Asset' and how does it work?
After you create a font asset from a font file, you must place it in the path set to store all the font assets. Property Description Default Font Asset Default font to use when you create a new text object. Path Path to store all the font assets.
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.
local_sr_e991ba037e0c
unity_docs
math
Show me a Unity C# example demonstrating `Mathf.SmoothStep`.
to . Description Interpolates between from and to with smoothing at the limits. This function interpolates between from and to in a similar way to Lerp . However, the interpolation will gradually speed up from the start and slow down toward the end. This is useful for creating natural-looking animation, f...
You are a Unity game development assistant. Help developers understand Unity APIs, best practices, and solve implementation challenges.