Code References

MonKey includes a whole range of utilities for writing Editor Commands and for Editor operations. In this section, we will go over all the utilities available.

Hotkeys Manager

The HotKeyManager is a class that can help you override hotkeys. If you want to specify MonKey that a key combination is used and that it should be detected in case of hotkey conflict, you can add it here. The HotKeyManager handles all the hotkeys of MonKey, and will be extended in the future.

Monkey Editor Utils

This class provides few Utilities to make writing commands simpler.

Selection

OrderedSelectedGameObjects: While Unity does not keep track of the order with which you selected objects, MonKey does. This Enumerator can help you retrieve the first object, the last, or anything in between, which can be very useful for custom commands.

OrderedSelectedObjects: Same thing, but also contains assets that are not game objects.

OrderedSelectedTransform: Same thing for the transforms, however keep in mind that this follows the same logic as Unity's: the transforms contained are only the uppermost selected: if you select a transform and some of its children, on the parent will appear in that list.

OrderSelectionByHierarchy: Reorders the order of the selection according to the hierarchy order as displayed in the window, with an option to sort ascending or descending.

Mouse

MousePosition: MonKey keeps a reference to the mouse position so that it may be accessed outside of a GUI call: this can be useful when creating scene commands.

MouseSceneRay: Returns a ray that goes from the mouse position onto the scene.

GetMouseRayCastedPosition: Returns the raycasted position of the mouse on the scene, with the possibility to ignore some objects and to apply an offset. This method outputs the normal of the collision point as well.

GUI

LastGlobalEvent: Keeps a reference to the last Event that was called on GUI, so that you may use it outside of GUI logics.

IsKeyDown: A Utility to know if a key is pressed by the user, to be used within a GUI block.

CurrentSceneView: Returns the currently focused scene view.

GetProjectWindowFocusedFolder: Returns the folder that is currently focused in the project window. Keep in mind that this is not the same as the selected folder.

Undo

CreateUndoGroup: Makes it easier to collapse few undo operations at once. Returns an undoID that you must use together with Undo.CollapseOperation.

Commands

AddCustomReservedHotKeys: If you want to associate reserved hotkeys that are used for something external to MonKey, you can specify it here, and it will appear visible in the console when a conflict happens.

AddSceneCommand: Adds a scene command to the active ones on the scene.

CallCommand: Calls a command by its name as if it would be selected in the MonKey console.

GetCommandInfo: Returns the data structure of the command of the specified name. CommandInfo contains all the information used by MonKey to display and execute the command.

OnCommandLoadingDone: An event you can register to, it will be called once all the MonKey commands are loaded.

UnRegisterQuickName: Removes the quick name specified from MonKey. Can Be useful when you want to override an already existing Quick Name

UnRegisterCommand: Removes the specified command from MonKey. Can be useful when you want to write your own custom replacement for a specific command.

Utilities Classes

Most of the commands available in MonKey are also accessible through code via the Utilities class. If you want to create a command that combines few behaviors, you may do it thanks to this! The commands are ordered by type in the following utilities:

• ConstrainUtilities contains all the scene commands that lock objects in place
• CreationUtilities contains all the commands that are used to create, duplicate or replace objects
• DevUtilities contains commands useful to programmers.
• EditorUtilities contains commands that can be only run when the game is not playing
• MeasurmentUtilities contains all the commands used to measure things.
• MoveUtilities contains all the commands used to move or rotate objects or move assets in the project.
• NamingUtilities contains all the commands related to renaming asset and objects
• ParentingUtilities contains helper methods on parenting game objects
• PhysicsUtilities contains all the commands related to 3D Physics (2D physics coming in the future)
• PlayUtilities contains all the commands to the Play Mode
• PrefabUtilities contains all the utilities concerning the creation and modification of prefabs
• SceneUtilities contains all the commands concerning the creation, opening and modification of scenes
• SelectionUtilities contains all the command concerning the selection of gameobjects and assets, and the modification of the selection
• UIUtilities contains all the commands related to UI components (including RectTransform)
• VisibilityUtilities contains all the commands relative to the visibility of objects on the scene, or of the editor's UI

Monkey Style

MonkeyStyle contains all the references to MonKey's look. If you want to create your own GUI for an Auto Complete, for scene commands or for anything else, you can find here references to textures, GUI styles and Colors:

• Instance returns the current instance of Style used by the console, modify it if you want to change the way MonKey looks like, or access the current colors and textures.
• Stylized Texts return default messages with a style applied to them to fit MonKey's appearance
• ColorTexture allows you to create a texture of a given size with the given color to be used in GUIs this texture will take into account the color space settings.
• ColorHorizontalGradientTexture creates a texture with a horizontal gradient from the start until the specified pixel
• GetIconForFile gets the default Unity texture for the given file name. This is an equivalent to calling UnityEditorInternal.InternalEditorUtility.GetIconForFile(fileName) but in an easier way.
• All the colors present in the class represent the ones used in the interface, from the background window color to the lines colors. The names of the color should be self explanatory.
• Same goes for the textures: you may find them from MonKey's folder, but they will be cached here.
• All the GUIStyles are also accessible, however their usage may be more tricky as they fit specific situations.

Default Values Utilities

DefaultValuesUtilities contains few helper methods that are meant to return values to be used in default value methods for commands. Their names should be self explanatory enough :)

Type Manager

TypeManager contains references to the types in use for a fast autocomplete: you can get a type by name, and types are ordered in dictionaries by categories.

Undo Utilities

UndoUtilities contains two classes meant to help you set up Undos that store the state of objects at a given time and creates an Undo relative to that state when you call it.

AbstractUndo is a generic abstract class you can inherit to follow this Undo logic.

TransformUndo is so far the only implementation of this Undo logic: you can store the transform of objects at a given moment with Register(params Transform[] valuesToRegister), and create an Undo relative to that transform state at any time by calling RecordUndo().

This will compare the current transform values and create an undo from the registered values.

Validation Utilities

ValidationUtilities contains all the default command validation methods accessible by DefaultValidation when creating a command.

Extension Classes

MonKey contains few extension classes for some common types that can be useful when creating commands:

• ColorExt contains methods to convert from and to an HTML color, and to offset color to make it darker, lighter, or offset a channel.
• DictionaryExt contains methods relative to the usage of c# dictionaries
• EnumExt contains methods to use enums as flags
• GameObjectExt contains methods relative to the instantiation of objects, and prefab detection
• ListExt contains methods relative to the usage of c# lists
• MathExt contains methods useful for mathematical and geometrical operations
• ObjectExt contains methods useful for assets and renaming
• SceneExt contains scene management methods
• StringExt contains methods related to the formatting and sorting of string, it contains the methods used to sort objects used by MonKey.
• TransformExt contains methods used for moving and getting axes of a transform, and methods relative to transform hierarchies.