Heroic Engine
  • Welcome
  • Getting Started
    • Quickstart
    • Example Games
      • Tic Tac Toe
      • Turn based duel
  • Basics
    • Injection Manager
    • Engine Systems
      • Core Systems
        • Events Manager
        • Input Manager
        • Localization Manager
          • LangText component
        • Music Player
        • Sounds Manager
        • Time Manager
        • Scenes Loader
        • Day Time Controller
        • Weather Controller
      • Gameplay Systems
        • Currencies Manager
        • Player Progression Manager
        • Quest Manager
        • Random Events Manager
        • Hittables Manager
        • Dungeon Generator
      • UI Systems
        • UI Controller
        • Countdown Controller
    • Editor Tools
      • Clear Saves
      • Mobile Build Optimizer
      • Create System
      • Icon from Prefab Generator
    • Engine Utilities
      • PoolSystem
      • DataSaver
      • ComponentExtensions
      • MaterialExtensions
      • SpriteUtils
      • SlowUpdate
      • StringUtils
      • TypeUtility
      • MathHelper
      • VectorUtils
      • TransformUtils
      • MeshUtils
    • Useful Components
      • Floating Item
      • Fly Up Text
      • Label Scaler
      • Ragdoll
      • Rotate To Camera
      • Orbital Camera
      • Rotator
      • Texture Mover
      • Hittable
      • Projectile
      • Projectile2D
      • LifetimeObject
      • Spawner
      • Colorized Particles
      • Draggable2D
      • SaveableTransform
    • Useful Attributes
Powered by GitBook
On this page
  1. Basics
  2. Engine Utilities

MathHelper

This static class provides pretty wide range of additional math functionality.

Available methods

public static string ToRoundedString(this float _value, int _digits = 1)

This extension method creates string from given float number, rounded to certain count of digits after dot symbol.

Example:

Debug.Log($"First 3 digits of PI: {Mathf.PI.ToRoundedString(2)});

// Output: 3.14

public static string ToShortenedNumber(this int number)

This extension method returns shortened representation of given integer number. For example, 10.000 will be converted to "10k" and 1.500.000 will be converted to "1,5M".

Example:

Debug.Log(1000.ToShortenedNumber());
Debug.Log(1500000.ToShortenedNumber());

// Output:
// 1k
// 1,5M

public static void AddUnique<T>(this IList<T> self, IEnumerable<T> items)

This extension method adds unique elements from given items collection to given list. It adds all elements which are not yet presented in this list.

Example:

List<int> list1 = new List<int> { 1, 3, 5 };
List<int> list2 = new List<int> { 1, 3, 8, 0 };

list1.AddUnique(list2);

string results = "";
foreach (int i in list1)
{
    results += i.ToString() + ", ";
}
Debug.Log(results);

// Output:
// 1, 3, 5, 8, 0,

public static void Shuffle<T>(this IList<T> list)

This extension method randomly shuffles given list.

Example:

List<int> list = new List<int> { 1, 2, 3, 4 };

list.Shuffle();

public static void Shuffle<T>(this List<T> list)

It does the same as previous one.


public static void SortByDistance<T>(this List<T> list, Vector3 from) where T : Transform

This extension method sorts given list of Transforms by distance from given point, from closest one to farthest one.

This method could be useful if you need to find closest enemy or closest pickup to a certain game character.


public static T GetRandomElement<T>(this List<T> list)

This extension method returns random item from given list. If list is empty, it returns default value of given type.

Example:

// Code of imaginary turn based card game :)
// Getting random card from deck
Card nextCard = cardsDeck.GetRandomElement();

UseCard(nextCard);

public static T GetRandomElementExceptOne<T>(this List<T> list, T exceptedOne)

This extension method returns random item from given list, except certain item. If it cannot find such item, it returns exceptedOne item instead.

Example:

List<int> testList = new List<int>{0, 5, 13, 42, 50};

int randNumExcept42 = testList.GetRandomElementExceptOne(42);
// This will return 0, 5, 13 or 50
PreviousTypeUtilityNextVectorUtils

Last updated 3 months ago