Make please a cheat sheet for Unity Components (only the most important)
- User
Make please a cheat sheet for Unity Components (only the most important)
- Assistant
Sure! Here's a Unity Components Cheat Sheet with the most important and commonly used components you’ll encounter when working in Unity:
Unity Components Cheat Sheet
1. Transform
- Purpose: Controls position, rotation, and scale of a GameObject.
- Key Properties:
position(Vector3)rotation(Quaternion)localScale(Vector3)
- Notes: Every GameObject has one by default.
2. Rigidbody
- Purpose: Adds physics properties (mass, gravity, collisions) to GameObjects.
- Key Properties:
massdraguseGravityisKinematic
- Notes: Needed for physics-based movement and interactions.
3. Collider (BoxCollider, SphereCollider, CapsuleCollider, MeshCollider)
- Purpose: Enables GameObjects to detect physical collisions.
- Key Properties:
isTrigger(enables trigger events vs collisions)center(offset)sizeorradius
- Notes: Used with Rigidbody for physics interactions or alone for trigger detection.
4. Animator
- Purpose: Controls animations, driven by Animator Controllers.
- Key Properties:
runtimeAnimatorControllerspeed
- Notes: Plays and manages animation states and transitions.
5. AudioSource
- Purpose: Plays sounds.
- Key Properties:
clipvolumeloopplayOnAwake
- Notes: Attach to GameObject to play audio clips.
6. Camera
- Purpose: Renders the scene from a point of view.
- Key Properties:
fieldOfViewnearClipPlanefarClipPlaneclearFlags
- Notes: Each scene usually needs at least one Camera.
7. Light (Directional, Point, Spot)
- Purpose: Illuminates the scene.
- Key Properties:
type(Directional, Point, Spot)colorintensityrange(for Point/Spot)
- Notes: Important for scene lighting and mood.
8. Canvas
- Purpose: Root component for UI.
- Key Properties:
renderMode(Screen Space Overlay, Camera, World Space)
- Notes: Required for displaying UI elements.
9. SpriteRenderer
- Purpose: Renders 2D sprites.
- Key Properties:
spritecolorflipX,flipYsortingLayer
- Notes: Used in 2D games for rendering images.
10. LineRenderer
- Purpose: Draws straight or curved lines.
- Key Properties:
positions(array of Vector3 points)widthmaterial
- Notes: Useful for effects like lasers, trails, or paths.
11. NavMeshAgent
- Purpose: Enables GameObjects to navigate (pathfinding) in a scene.
- Key Properties:
speeddestinationstoppingDistance
- Notes: Used with Unity’s Navigation system for AI movement.
12. ParticleSystem
- Purpose: Creates particle effects like smoke, fire, sparks.
- Key Properties:
- Emission rate
- Shape
- Lifetime
- Start Speed
- Notes: Highly customizable visual effects system.
13. Animator Override Controller
- Purpose: Overrides animation clips on an existing Animator Controller.
- Use Case: Used to swap animations at runtime.
14. Script (MonoBehaviour)
- Purpose: Custom user scripts for game logic.
- Key Methods:
Start()Update()FixedUpdate()OnTriggerEnter(),OnCollisionEnter()
- Notes: Most powerful component type; extends GameObject behavior.
Tips:
- Most GameObjects have Transform by default.
- Physics-based objects usually have both Rigidbody and Collider.
- UI elements require a Canvas.
- Use Animator to handle complex animations; for simple animations, Animation component might be used (legacy).
- Use Tags and Layers to organize objects (not components but important for scripting).
Let me know if you want this tailored for 2D, VR, or more advanced components!
- User
Write detailed cheat sheet for scripting using C# and MonoBehaviour (most important things)
- Assistant
Certainly! Here’s a detailed cheat sheet focusing on Unity scripting with C# and MonoBehaviour, covering the most important concepts, methods, and best practices you'll need for everyday Unity development.
Unity C# & MonoBehaviour Scripting Cheat Sheet
1. Basics: Script Structure
using UnityEngine; public class MyScript : MonoBehaviour { // Fields (variables) public int publicInt = 5; private float speed = 3.5f; // Called once when the script instance is loaded void Awake() { } // Called before the first frame update (after Awake) void Start() { } // Called once per frame (game loop) void Update() { } // Called at a fixed interval, use for physics updates void FixedUpdate() { } }- Class inherits from MonoBehaviour to attach to GameObjects.
- Script file name = class name.
- Public fields are exposed in Unity Inspector.
- Private fields are hidden by default.
2. Important MonoBehaviour Methods
Method Called When Use Case Awake()When script instance is initialized Initialization, setup references Start()Before first frame, if script enabled Initialization logic delayed after Awake Update()Every frame Frame-dependent logic, inputs FixedUpdate()At fixed time steps (default 0.02s) Physics calculations, Rigidbody manipulation LateUpdate()After all Update() calls Camera follow, smoothing logic OnEnable()When script/component enabled Setup listeners, events OnDisable()When script/component disabled Cleanup OnDestroy()When object/script is destroyed Cleanup resources
3. Variables and Properties
- Public variables: editable in Inspector and accessed by other scripts.
- [SerializeField] private: private but still visible/editable in Inspector.
- Static variables: shared across all instances of a class.
[SerializeField] private int speed = 5; public static int globalScore = 0;
4. Accessing Components
void Start() { Rigidbody rb = GetComponent<Rigidbody>(); // Get component on same GameObject Transform t = transform; // Shortcut to Transform AudioSource audioSource = GetComponentInChildren<AudioSource>(); // Get component in child Camera cam = Camera.main; // Get main camera in scene }
5. Common Functions
Movement example
void Update() { float h = Input.GetAxis("Horizontal"); // A/D or Left/Right float v = Input.GetAxis("Vertical"); // W/S or Up/Down Vector3 movement = new Vector3(h, 0, v); transform.Translate(movement * speed * Time.deltaTime); }Physics movement (with Rigidbody)
Rigidbody rb; void Awake() { rb = GetComponent<Rigidbody>(); } void FixedUpdate() { Vector3 force = new Vector3(1, 0, 0); rb.AddForce(force); }
6. Input
- Keyboard/Mouse input
if (Input.GetKeyDown(KeyCode.Space)) // pressed this frame { Jump(); } if (Input.GetMouseButton(0)) // left mouse held { Shoot(); }- Input axes (for controllers/analog)
float moveX = Input.GetAxis("Horizontal"); float moveY = Input.GetAxis("Vertical");
7. Coroutines
- Special functions for timed/paused behavior.
- Use
StartCoroutine()to run.
IEnumerator ExampleCoroutine() { Debug.Log("Start"); yield return new WaitForSeconds(2f); // wait 2 seconds Debug.Log("End"); } void Start() { StartCoroutine(ExampleCoroutine()); }
8. Collision and Trigger Methods
- Requires Collider (and Rigidbody for physics collision)
void OnCollisionEnter(Collision collision) { Debug.Log("Collided with: " + collision.gameObject.name); } void OnTriggerEnter(Collider other) { Debug.Log("Triggered by: " + other.gameObject.name); }
9. Instantiating & Destroying GameObjects
public GameObject prefab; void Spawn() { GameObject obj = Instantiate(prefab, transform.position, Quaternion.identity); } void Remove(GameObject obj) { Destroy(obj); // Destroy immediately after frame Destroy(obj, 2f); // Destroy after 2 seconds delay }
10. Public Events and Delegates
Simple custom event example:
public delegate void ScoreChanged(int newScore); public event ScoreChanged OnScoreChanged; void AddScore(int points) { score += points; if (OnScoreChanged != null) OnScoreChanged(score); }
11. Common Utility Functions
Debug.Log(): Print messages to console.
Debug.Log("Player position: " + transform.position);Mathf: Useful math utilities.
float angle = Mathf.Sin(Time.time); float clamped = Mathf.Clamp(value, 0, 10); float lerpValue = Mathf.Lerp(0, 100, 0.5f);
12. Inspector Attributes
Attribute Effect [SerializeField]Serialize private field to show in Inspector [HideInInspector]Hide public field in Inspector [Range(min,max)]Show slider for numeric value [Tooltip("text")]Show explanatory tooltip in Inspector [Header("Title")]Group variables visually Example:
[Header("Player Settings")] [Range(0, 10)] public float speed = 5f;
13. Accessing Other Scripts
public class Player : MonoBehaviour { void Start() { Enemy enemy = FindObjectOfType<Enemy>(); enemy.TakeDamage(10); } }Or via references:
public Enemy enemy; void Start() { enemy.TakeDamage(10); }
14. Best Practices
- Use
FixedUpdate()for Rigidbody and physics movement. - Use
Update()for input and general logic. - Cache component references in
Awake()orStart()to avoid repeated costlyGetComponentcalls. - Use
SerializeField+ private variables instead of public to encapsulate data. - Avoid heavy computations inside
Update()– use coroutines or optimize code.
Summary: Most Used MonoBehaviour Methods
Method Purpose Awake() Initialize references Start() Initialize logic after Awake Update() Per frame updates FixedUpdate() Physics updates LateUpdate() Follow up on Update logic OnCollisionEnter Detect collisions OnTriggerEnter Detect triggers OnEnable / OnDisable Subscribe/unsubscribe events
If you want me to include example snippets for specific mechanics (AI, UI, Animation), just ask!
- User
Make some simple examples to add to the cheat sheet on topic: GameObject: Instantiate, AddComponent<...>(), GetComponent<...>(), Find with tag, Destroy; and Rigidbody
- Assistant
Certainly! Here are some simple, practical examples demonstrating key operations on GameObjects and Rigidbody that you can add to your cheat sheet:
Unity GameObject & Rigidbody Examples
1. Instantiate GameObject
public GameObject prefab; void SpawnObject() { // Create a copy of 'prefab' at position (0,0,0) with no rotation GameObject obj = Instantiate(prefab, Vector3.zero, Quaternion.identity); // Optional: set parent obj.transform.parent = this.transform; }
2. AddComponent<T>()
void AddRigidbodyToObject(GameObject obj) { // Add Rigidbody component dynamically if not already present if (obj.GetComponent<Rigidbody>() == null) { Rigidbody rb = obj.AddComponent<Rigidbody>(); rb.mass = 2f; rb.useGravity = true; } }
3. GetComponent<T>()
void PrintObjectPosition(GameObject obj) { // Get Transform component (shortcut: obj.transform) Transform t = obj.GetComponent<Transform>(); // Print position to console Debug.Log("Position: " + t.position); } // With Rigidbody example void ApplyForce(GameObject obj) { Rigidbody rb = obj.GetComponent<Rigidbody>(); if (rb != null) { rb.AddForce(Vector3.up * 10f, ForceMode.Impulse); } }
4. Find GameObject by Tag
void FindEnemy() { GameObject enemy = GameObject.FindWithTag("Enemy"); if (enemy != null) { Debug.Log("Found enemy at position " + enemy.transform.position); } else { Debug.Log("No enemy found with tag"); } }- Note: Tags must be assigned in the Inspector.
5. Destroy GameObject
void DestroyObject(GameObject obj) { // Immediately destroy Destroy(obj); // Or delay destruction by 3 seconds // Destroy(obj, 3f); }
6. Basic Rigidbody Usage
Rigidbody rb; void Awake() { // Cache Rigidbody reference on this GameObject rb = GetComponent<Rigidbody>(); } void FixedUpdate() { // Add constant forward force rb.AddForce(transform.forward * 5f); } // Example: Instant jump impulse void Jump() { if (rb != null) { rb.AddForce(Vector3.up * 7f, ForceMode.Impulse); } }
Feel free to copy these snippets directly to your cheat sheet for quick reference! If you want, I can also add comments or expand on examples like parenting instantiated objects, removing components, or more Rigidbody options.
- User
Add some examples with usage of Quaternion and Vector3
- Assistant
Certainly! Here are some clear and simple examples demonstrating common Quaternion and Vector3 usages in Unity to enrich your cheat sheet:
Quaternion & Vector3 Examples
1. Quaternion: Rotations
a) Set a GameObject’s rotation
// Set rotation to 45 degrees around Y axis transform.rotation = Quaternion.Euler(0, 45f, 0);b) Smoothly rotate towards a target direction
void RotateTowardsTarget(Vector3 targetPosition) { Vector3 direction = targetPosition - transform.position; direction.y = 0; // ignore vertical rotation if 3D Quaternion targetRotation = Quaternion.LookRotation(direction); // Smoothly rotate over time transform.rotation = Quaternion.Slerp(transform.rotation, targetRotation, Time.deltaTime * 5f); }c) Combine rotations
Quaternion baseRotation = Quaternion.Euler(0, 30, 0); Quaternion extraRotation = Quaternion.Euler(0, 15, 0); // Result rotation = baseRotation rotated by extraRotation Quaternion combined = baseRotation * extraRotation; transform.rotation = combined;
2. Vector3: Positions, Directions, Movement
a) Move an object forward
float speed = 5f; void Update() { // Move forward along Z axis transform.position += transform.forward * speed * Time.deltaTime; }b) Calculate direction between two points
Vector3 start = transform.position; Vector3 target = new Vector3(10, 0, 5); Vector3 direction = (target - start).normalized; // Vector pointing from start to target Debug.Log("Direction: " + direction);c) Clamp position within boundaries
Vector3 pos = transform.position; pos.x = Mathf.Clamp(pos.x, -10f, 10f); pos.z = Mathf.Clamp(pos.z, -5f, 5f); transform.position = pos;d) Lerp (linear interpolate) between two positions
Vector3 pointA = new Vector3(0, 0, 0); Vector3 pointB = new Vector3(10, 0, 0); // t goes from 0 to 1 float t = Mathf.PingPong(Time.time, 1f); transform.position = Vector3.Lerp(pointA, pointB, t);
3. Quaternion and Vector3 Together: Rotate Towards Target Smoothly
void Update() { Vector3 direction = target.position - transform.position; if (direction.sqrMagnitude > 0.01f) { Quaternion targetRotation = Quaternion.LookRotation(direction); transform.rotation = Quaternion.RotateTowards(transform.rotation, targetRotation, 90f * Time.deltaTime); } }
Bonus: Vector3 Common Constants
Vector3.zero→ (0,0,0)Vector3.one→ (1,1,1)Vector3.up→ (0,1,0)Vector3.down→ (0,-1,0)Vector3.forward→ (0,0,1)Vector3.back→ (0,0,-1)Vector3.right→ (1,0,0)Vector3.left→ (-1,0,0)
These examples cover essential practical uses of both
QuaternionandVector3in typical Unity scripts. Let me know if you want me to add more advanced uses or explanations! - User
Add to the cheat sheet some common tips that are exist in almost of projects. Something that is very spread across the scripts. I don't maybe movement or something
- Assistant
Absolutely! Here are some common, widely-used scripting tips and patterns that appear in nearly all Unity projects — beyond just movement — to add to your cheat sheet. These are general best practices and frequently recurring code snippets and habits that make your scripts cleaner, more efficient, and easier to maintain.
Common Unity Scripting Tips
1. Cache Component References
Avoid calling
GetComponent<T>()repeatedly insideUpdate()or other frequently called methods. Cache references once:private Rigidbody rb; void Awake() { rb = GetComponent<Rigidbody>(); } void Update() { if(rb != null) rb.AddForce(Vector3.up); }
2. Use
SerializeFieldInstead of Public FieldsKeep fields private but editable in Inspector to enforce encapsulation:
[SerializeField] private float speed = 5f;
3. Use
Time.deltaTimefor Frame-Rate Independent BehaviorMultiply changes by
Time.deltaTimeto keep movement and animations smooth regardless of FPS.void Update() { transform.Translate(Vector3.forward * speed * Time.deltaTime); }
4. Avoid Heavy Work in
Update()- Do not instantiate, do expensive calculations, or access components repeatedly inside
Update(). - Use Coroutines or Events where possible.
5. Use Layer Masks for Efficient Raycasting and Collision Checks
[SerializeField] LayerMask enemyLayer; void CheckForEnemies() { RaycastHit hit; if (Physics.Raycast(transform.position, transform.forward, out hit, 10f, enemyLayer)) { Debug.Log("Enemy hit: " + hit.collider.name); } }
6. Use Early Exits for Cleaner Code
void Update() { if (!isActive) return; // Normal Update logic }
7. Leverage
TryGetComponent<T>for Safer Component Access (Unity 2019+)if (other.gameObject.TryGetComponent<Enemy>(out Enemy enemy)) { enemy.TakeDamage(10); }
8. Use Constants or Enums for Magic Numbers and Tags
public static class Tags { public const string Player = "Player"; public const string Enemy = "Enemy"; } void Start() { GameObject player = GameObject.FindWithTag(Tags.Player); }
9. Use Events and Delegates for Decoupling
Instead of hard-coded calls between scripts, use events to notify changes:
public static event Action OnPlayerDeath; void Die() { OnPlayerDeath?.Invoke(); }
10. Null Checks to Avoid Runtime Errors
if (myComponent != null) { myComponent.DoSomething(); }Or using null-conditional:
myComponent?.DoSomething();
11. Use Coroutines for Delayed or Timed Actions
IEnumerator WaitAndDisable(float delay) { yield return new WaitForSeconds(delay); gameObject.SetActive(false); } void Start() { StartCoroutine(WaitAndDisable(3f)); }
12. Organize Your Code with Regions
#region Movement // Movement related code #endregion #region Health // Health related code #endregion
13. Layered Input Handling
Separate input logic from gameplay logic for clarity and scalability:
void Update() { HandleInput(); HandleGameplay(); } void HandleInput() { // Read inputs } void HandleGameplay() { // Execute actions }
14. Use
Application.isPlayingfor Editor ScriptsWhen running code in Editor scripts and you want it to only run during play mode.
15. Don't Use Find in Performance-Critical Code
Avoid
Find,FindWithTag, orGetComponentin Update or physics loops — cache references or use events instead.
16. Use
Debug.LogWarningandDebug.LogErrorto Report Problemsif (health < 0) { Debug.LogWarning("Health is below zero!"); }
17. Consistent Naming Conventions
- Variables: camelCase (e.g.,
playerHealth) - Methods & Classes: PascalCase (e.g.,
TakeDamage(),PlayerController) - Constants: ALL_CAPS or PascalCase with readonly keyword
18. Use ScriptableObjects for Data
Instead of hardcoding values, ScriptableObjects can help manage shared data cleanly.
Summary Table of Common Tips
Tip Why Cache references Performance Serialize private fields Encapsulation + Inspector Use Time.deltaTime Frame rate independence Avoid heavy Update logic Performance Use LayerMask Efficient raycasts Early exits Cleaner code TryGetComponent Safe component retrieval Use constants/enums Avoid magic strings/numbers Use events Decoupling and flexibility Null checks Avoid exceptions Use coroutines Handle delays/timing Organize with regions Readability Layer input/gameplay logic Separation of concerns Avoid Find in Update loops Performance Use Debug warnings/errors Easier debugging
Would you like me to add some example snippets for customizable utilities or generic base classes too?
- Do not instantiate, do expensive calculations, or access components repeatedly inside