For the complete documentation index, see llms.txt. This page is also available as Markdown.

KS.Unity.Editor

Classes

ksAnalytics.Events.BuildConfigs

Analytics build configs event.

ksAnalytics.Events.BuildServer

Analytics build server event.

ksAnalytics.Categories

Event categories

ksAnalytics.Events

Analytics events

ksAnalytics.Events.Publish

Analytics publish event.

ksAnalytics

Class for sending analytics events. This is intended for internal use only.

ksAnalyticsDurationEvent

Analytics event that uses MixPanel's built-in duration property.

ksAnalyticsEvent

Contains data for an analytics event.

ksAssetStorePackageUpdater<T>

Base class for checking for updates and prompting users to apply the update to an asset store package.

ksAuthenticatedMenu

Base class for menus that require users to be logged in.

ksBaseLoginMenu<T>

Kinematicsoup Service Login GUI

ksBasePackageUpdater<T>

Base class for checking for updates and prompting users to apply the update to a package. Inherits from ksSingleton%601 so there will only be one instance of each derived class that will survive Unity serialization from play mode and recompiles.

ksDictionaryDrawer

Custom property drawer for ksSerializableDictionary%602

ksEditorEvents

Useful editor events that Unity doesn't provide.

ksEditorUtils

Editor utilities

ksEditorWebService

This class is used to manage KinematicSoup web service requests and login state

ksFileWatcher

Convenience wrapper of FileSystemWatcher.

ksGitPackageUpdater<T>

Base class for checking for updates and prompting users to apply the update to a git package.

ksIconUtility

Utility for setting icons for Unity objects. Uses reflection to call a Unity private method because Unity does not expose icons to the API. Icons set with this utility are not saved and will be cleared when Unity is closed or when the script's code changes, so the icons need to be set each time Unity loads.

ksInspectorStateMap<State, Self>

This can be used by property drawers and custom inspectors to store per-property custom state that persists through Unity serializations. The state is not saved to disk so it only persists as long as Unity is open. A property is indentified by its name and the name of the script is belongs to.

This class inherits from ksSingleton%601, so it should be accessed using the singleton accessor Get.

ksOverrideEditor

Base class that enables Reactor to define new editors which extend or override the rendering of Unity inspector editors.

ksPathUtils

Path utility functions

ksProcessUtils

Provides a utility function for starting a minimized process window that does not steal focus on Windows using p-invoke. On other platforms, starts the process normally. https://docs.microsoft.com/en-us/windows/win32/procthread/creating-processes

ksProjectInfo

Contains information about a project.

ksReflectionObject

Convencience class for accessing reflection data for an object, property, field, or type. When a reflection error occurs, an error is logged and a void reflection object is returned. All calls on void reflection objects return void reflection objects.

ksScriptUpdater

Utility for searching and replacing regex patterns in files.

ksScrollArea

A scroll area that can detect if the vertical and horizontal scroll bars are showing. For it to work properly, the last rect drawn in the scroll area must be the lowest and right-most rect in the scroll area.

ksSingleton<T>

Base class for scriptable object singletons that survive Unity serialization. These do not persist when Unity closes. It's not safe to access these until Unity deserialization is finished. T should be the class that inherits this.

ksStyle

Common styles used in our Unity GUIs.

ksVersionDrawer

Custom property drawer for ksSerializableVersion.

ksWindow

Editor window the uses an interface to create the GUI. Swapping the interface allows for switching GUIs without having to create a new window for the new GUI.

Interfaces

ksIMenu

Menu interface for creating GUIs for the ksWindow class.

Enums

ksFileWatcher.Flags

Flags for configuaring the file system watcher

ksIconUtility.Icon

Unity icons

ksPathUtils.LoggingFlags

Types of log messages to log.

ksWindow.WindowStyle

Window display styles

Delegates

ksEditorEvents.CompileStartHandler

Compile start event handler.

ksWindow.CreateCallback

Callback to call when a window is created.

ksEditorEvents.FocusChangeHandler

Focus change handler.

ksEditorEvents.ImportAssetsHandler

Import assets event handler.

ksEditorWebService.RequestCallback

ksBasePackageUpdater<T>.UpdateCallback

Callback to invoke after an update check completes.

Last updated