# Unity Cheat Sheet ## Table of Contents - [Basics](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#basics) - [MonoBehaviour](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#monobehaviour) - [Transform](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transform) - [Vector3](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#vector3) - [Quaternion](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#quaternion) - [Euler Angles](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#euler-angles) - [Movement & Rotation](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#movement--rotation) - [Move Object](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#move-object) - [Transform.Translate()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transformtranslate) - [Vector3.MoveTowards()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#vector3movetowards) - [Vector3.Lerp()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#vector3lerp) - [Vector3.SmoothDamp()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#vector3smoothdamp) - [Rotate Object](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#rotate-object) - [Transform.rotation](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transformrotation) - [Transform.eulerAngles](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transformeulerangles) - [Transform.Rotate()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transformrotate) - [Transform.RotateAround()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transformrotatearound) - [Transform.LookAt()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#transformlookat) - [Quaternion.LookRotation()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#quaternionlookrotation) - [Quaternion.FromToRotation()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#quaternionfromtorotation) - [Quaternion.ToAngleAxis()](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#quaterniontoangleaxis) - [Physics](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#physics) - [Raycast](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#raycast) - [Ignore Collision](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#ignorecollision) - [Input](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#input) - [Keyboard](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#keyboard) - [Mouse](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#mouse) - [Touch](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#touch) - [UI](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#ui) - [Button](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#button) - [Slider](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#slider) - [Audio](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#audio) - [Basic Audio Play](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#basic-audio-play) - [Scripting](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#scripting) - [Coroutines](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#coroutines) - [Async/Await](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#asyncawait) - [Basic Structure](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#basic-structure) - [Loading Resources](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#loading-resources) - [Web Requests](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#web-requests) - [Scene Loading](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#scene-loading) - [Parallel Operations](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#parallel-operations) - [Timeout Handling](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#timeout-handling) - [Best Practices](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#best-practices) - [Event Systems](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#event-systems) - [Scriptable Objects](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#scriptable-objects) - [Custom Editor Scripts](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#custom-editor-scripts) - [Design Patterns](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#design-patterns) - [Singleton](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#singleton) - [Factory Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#factory-pattern) - [Observer Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#observer-pattern) - [Command Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#command-pattern) - [State Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#state-pattern) - [Basic Example](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#basic-example) - [Detailed Example - Game Onboarding System](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#detailed-example---game-onboarding-system) - [Strategy Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#strategy-pattern) - [Basic Example](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#basic-example-1) - [Detailed Example - Combat System](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#detailed-example---combat-system) - [Object Pooling Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#object-pooling-pattern) - [Chain of Responsibility Pattern](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#chain-of-responsibility-pattern) - [Basic Example](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#basic-example-2) - [Detailed Example - Input Handling System](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#detailed-example---input-handling-system) - [Shortcuts](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#shortcuts) - [Scene View Editing](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#scene-view-editing) - [Scene View Navigation](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#scene-view-navigation) - [Hierarchy Management](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#hierarchy-management) - [Layout](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#layout) - [Practical Use Cases](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#practical-use-cases) - [Check if object is on the ground](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#check-if-object-is-on-the-ground) - [Get the transform of a Body Bone](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#get-the-transform-of-a-body-bone) - [Make object look at the camera](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#make-object-look-at-the-camera) - [Load next scene](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#load-next-scene) - [TBD (To Be Documented)](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#tbd-to-be-documented) - [Input](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#input-1) - [Scripting](https://github.com/ozankasikci/unity-cheat-sheet/raw/master/#scripting-1) ## Basics ### [MonoBehaviour](https://docs.unity3d.com/ScriptReference/MonoBehaviour.html) [MonoBehaviour Life Cycle Flow Chart](https://docs.unity3d.com/uploads/Main/monobehaviour_flowchart.svg) ```csharp // MonoBehaviour is the base class from which every Unity script derives. // Offers some life cycle functions that are easier for you to develop your game. // Some of the most frequently used ones are as follows; Awake() Start() Update() FixedUpdate() LateUpdate() OnGUI() OnEnable() OnDisable() ``` ### [Transform](https://docs.unity3d.com/ScriptReference/Transform.html) ```csharp // Transform is a fundamental component in Unity that every GameObject has. // It defines the object's Position, Rotation, and Scale in the game world. // Access the transform component Transform transform = gameObject.transform; // Position: Vector3 representing world space coordinates (x, y, z) transform.position = new Vector3(0, 2, 0); // Set absolute position transform.localPosition = Vector3.zero; // Position relative to parent // Rotation: Can be set using Euler angles (degrees) or Quaternions transform.rotation = Quaternion.identity; // No rotation transform.eulerAngles = new Vector3(0, 90, 0); // Rotate 90 degrees around Y axis transform.localRotation = Quaternion.identity; // Rotation relative to parent // Scale: Vector3 representing scale on each axis transform.localScale = Vector3.one; // Normal scale (1, 1, 1) transform.localScale = new Vector3(2, 2, 2); // Double size on all axes // Parent-Child Relationships transform.parent = anotherObject.transform; // Set parent transform.SetParent(null); // Remove parent (make root) ``` ### [Vector3](https://docs.unity3d.com/ScriptReference/Vector3.html) ```csharp // Vector3 is representation of 3D vectors and points // It's used to represent 3D positions,considering x,y & z axis. Vector3 v = new Vector3(0f, 0f, 0f); ``` ### [Quaternion](https://docs.unity3d.com/ScriptReference/Quaternion.html) ```csharp // A Quaternion stores the rotation of the Transform in world space. // Quaternions are based on complex numbers and don't suffer from gimbal lock. // Unity internally uses Quaternions to represent all rotations. // You almost never access or modify individual Quaternion components (x,y,z,w); // A rotation 30 degrees around the y-axis Quaternion rotation = Quaternion.Euler(0, 30, 0); ``` ### Euler Angles ```csharp // Euler angles are "degree angles" like 90, 180, 45, 30 degrees. // Quaternions differ from Euler angles in that they represent a point on a Unit Sphere (the radius is 1 unit). // Create a quaternion that represents 30 degrees about X, 10 degrees about Y Quaternion rotation = Quaternion.Euler(30, 10, 0); // Using a Vector Vector3 EulerRotation = new Vector3(30, 10, 0); Quaternion rotation = Quaternion.Euler(EulerRotation); // Convert a transform's Quaternion angles to Euler angles Quaternion quaternionAngles = transform.rotation; Vector3 eulerAngles = quaternionAngles.eulerAngles; ``` ## Movement & Rotation ### Move Object #### Transform.Translate() ```csharp // Moves the transform in the direction and distance of translation. public void Translate(Vector3 translation); public void Translate(Vector3 translation, Space relativeTo = Space.Self); transform.Translate(Vector3.right * movementSpeed); ``` #### Vector3.MoveTowards() ```csharp // Calculate a position between the points specified by current and target // Moving no farther than the distance specified by maxDistanceDelta public static Vector3 MoveTowards(Vector3 current, Vector3 target, float maxDistanceDelta); Vector3 targetPosition; transform.position = Vector3.MoveTowards(transform.position, targetPosition, Time.deltaTime); ``` #### Vector3.Lerp() ```csharp // Linearly interpolates between two points. Results in a smooth transition. public static Vector3 Lerp(Vector3 startValue, Vector3 endValue, float interpolationRatio); Vector3 targetPosition; float t = 0; t += Time.deltaTime * speed; transform.position = Vector3.Lerp(transform.position, targetPosition, t); ``` #### Vector3.SmoothDamp() ```csharp // Gradually changes a vector towards a desired goal over time. // The vector is smoothed by some spring-damper like function, which will never overshoot. // The most common use is for smoothing a follow camera. public static Vector3 SmoothDamp(Vector3 current, Vector3 target, ref Vector3 currentVelocity, float smoothTime, float maxSpeed = Mathf.Infinity, float deltaTime = Time.deltaTime); float smoothTime = 1f; Vector3 velocity; Vector3 targetPosition = target.TransformPoint(new Vector3(0, 5, -10)); // Smoothly move the camera towards that target position transform.position = Vector3.SmoothDamp(transform.position, targetPosition, ref velocity, smoothTime); ``` ### Rotate Object #### Transform.rotation ```csharp // A Quaternion stores the rotation of the Transform in world space. // Quaternions are based on complex numbers and don't suffer from gimbal lock. // Unity internally uses Quaternions to represent all rotations. transform.rotation = new Quaternion(rotx, roty, rotz, rotw); ``` #### Transform.eulerAngles ```csharp // Transform.eulerAngles represents rotation in world space. // It is important to understand that although you are providing X, Y, and Z rotation values to describe your rotation // those values are not stored in the rotation. Instead, the X, Y & Z values are converted to the Quaternion's internal format. transform.eulerAngles = Vector3(rotx, roty, rotz); ``` #### Transform.Rotate() ```csharp // Applies rotation around all the given axes. public void Rotate(Vector3 eulers, Space relativeTo = Space.Self); public void Rotate(float xAngle, float yAngle, float zAngle, Space relativeTo = Space.Self); transform.Rotate(rotx, roty, rotz); ``` #### Transform.RotateAround() ```csharp // Rotates the transform about axis passing through point in world coordinates by angle degrees. public void RotateAround(Vector3 point, Vector3 axis, float angle); // Spin the object around the target at 20 degrees/second. Transform target; transform.RotateAround(target.position, Vector3.up, 20 * Time.deltaTime); ``` #### Transform.LookAt() ```csharp // Points the positive 'Z' (forward) side of an object at a position in world space. public void LookAt(Transform target); public void LookAt(Transform target, Vector3 worldUp = Vector3.up); // Rotate the object's forward vector to point at the target Transform. Transform target; transform.LookAt(target); // Same as above, but setting the worldUp parameter to Vector3.left in this example turns the object on its side. transform.LookAt(target, Vector3.left); ``` #### Quaternion.LookRotation() ```csharp // Creates a rotation with the specified forward and upwards directions. public static Quaternion LookRotation(Vector3 forward, Vector3 upwards = Vector3.up); // The following code rotates the object towards a target object. Vector3 direction = target.position - transform.position; Quaternion rotation = Quaternion.LookRotation(direction); transform.rotation = rotation; ``` #### Quaternion.FromToRotation() ```csharp // Creates a rotation (a Quaternion) which rotates from fromDirection to toDirection. public static Quaternion FromToRotation(Vector3 fromDirection, Vector3 toDirection); // Sets the rotation so that the transform's y-axis goes along the z-axis. transform.rotation = Quaternion.FromToRotation(Vector3.up, transform.forward); ``` #### Quaternion.ToAngleAxis() ```csharp // Converts a rotation to angle-axis representation (angles in degrees). // In other words, extracts the angle as well as the axis that this quaternion represents. public void ToAngleAxis(out float angle, out Vector3 axis); // Extracts the angle - axis rotation from the transform rotation float angle = 0.0f; Vector3 axis = Vector3.zero; transform.rotation.ToAngleAxis(out angle, out axis); ``` ## Physics ### Raycast ```csharp void FixedUpdate() { // Bit shift the index of the layer (8) to get a bit mask int layerMask = 1 << 8; // This would cast rays only against colliders in layer 8. // But instead we want to collide against everything except layer 8. The ~ operator does this, it inverts a bitmask. layerMask = ~layerMask; RaycastHit hit; // Does the ray intersect any objects excluding the player layer if (Physics.Raycast(transform.position, transform.TransformDirection(Vector3.forward), out hit, Mathf.Infinity, layerMask)) { Debug.DrawRay(transform.position, transform.TransformDirection(Vector3.forward) * hit.distance, Color.yellow); Debug.Log("Did Hit"); } } ``` ### Ignore Collision ```csharp // Makes the collision detection system ignore all collisions between collider1 and collider2. public static void IgnoreCollision(Collider collider1, Collider collider2, bool ignore = true); // Here we're disabling the collision detection between the colliders of ally and bullet objects. Transform bullet; Transform ally; Physics.IgnoreCollision(bullet.GetComponent(), ally.GetComponent()); ``` ## Input ### Keyboard ```csharp // Returns true during the frame the user starts pressing down the key if (Input.GetKeyDown(KeyCode.Space)) { Debug.Log("Space key was pressed"); } // Jump is also set to space in Input Manager if (Input.GetButtonDown("Jump")) { Debug.Log("Do something"); } ``` ### Mouse ```csharp if (Input.GetAxis("Mouse X") < 0) { Debug.Log("Mouse moved left"); } if (Input.GetAxis("Mouse Y") > 0) { Debug.Log("Mouse moved up"); } if (Input.GetMouseButtonDown(0)) { Debug.Log("Pressed primary button."); } if (Input.GetMouseButtonDown(1)) { Debug.Log("Pressed secondary button."); } if (Input.GetMouseButtonDown(2)) { Debug.Log("Pressed middle click."); } ``` ### Touch ```csharp if (Input.touchCount > 0) { touch = Input.GetTouch(0); if (touch.phase == TouchPhase.Began) { Debug.Log("Touch began"); } if (touch.phase == TouchPhase.Moved) { Debug.Log("Touch moves"); } if (touch.phase == TouchPhase.Ended) { Debug.Log("Touch ended"); } } ``` ## UI ### Button ```csharp // Button is used to handle user clicks and interactions. // Attach this script to a Button component to respond to button clicks. using UnityEngine.UI; Button myButton = GetComponent