Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 2.17 KB

README.md

File metadata and controls

117 lines (79 loc) · 2.17 KB

core-utils

A collection of common Unity scripts and extensions I've found myself continually rewriting.

TODO: write more details about how each of these works.

How To Install

The core-utils package uses the scoped registry feature to import dependent packages. Please add the following sections to the package manifest file (Packages/manifest.json).

To the scopedRegistries section:

{
  "name": "DSS",
  "url": "https://registry.npmjs.com",
  "scopes": [ "com.dss" ]
}

To the dependencies section:

"com.dss.core-utils": "1.6.12"

After changes, the manifest file should look like below:

{
  "scopedRegistries": [
    {
      "name": "DSS",
      "url": "https://registry.npmjs.com",
      "scopes": [ "com.dss" ]
    }
  ],
  "dependencies": {
    "com.dss.core-utils": "1.6.12",
    ...

Application Utilities

Exposes a setter for common UnityEngine.Application properties, so they can be set by the event system (Buttons, Toggles, etc).

  • OpenURL
  • PlatformConditional
  • Quiter
  • SetTargetFrameRate

EditorUtilities

Various editor utilities for helping write custom editors, etc.

  • GUIUtilities
  • MaterialPropertyContainer
  • SerializedPropertyContainer

Events

Exposes common events to the event system.

  • OnKeyCodeCombination
  • OnStart

Extensions

Extends several built in and Unity-specific classes.

  • GraphicExtensions
  • ListExtensions
  • RectTransformExtensions
  • StringExtensions
  • TextAssetExtensions
  • TransformExtensions
  • XmlNodeExtensions

Inspector Notes

Adds customizable notes to gameObject inspectors in the scene.

  • InspectorNote

Layout Utilities

Helps with common layout paradigms.

  • BidirectionalLayoutGroup
  • CropToSafeArea
  • RectTransformSnapper
  • ResponsiveBidirectionalLayoutGroup
  • ResponsiveGridLayout

Screen Utilities

Exposes various events for the Screen class.

  • ScreenWatcher
  • StaticScreenWatcher

Singleton

A derivable class for singleton objects.

  • AutomaticSingleton
  • Singleton

Tweening

Exposes an extensible "Tween" class that tweens between two values.

  • ScaleOnClick
  • TweenedFloat