Tilemaps.editor

Base class for user-specified settings.

Defines whether and how a paint operation will use AutoTile logic that is defined in the used .

Potentially defined AutoTiles will be ignored entirely. All painted tiles are exactly like provided by the source.

Only the painted tiles themselves will use AutoTile logic, but no neighbour tiles will be updated in the painting process.

Both the painted tiles themselves, as well as neighbouring tiles will be updated according to AutoTile logic.

Allows to select the source pattern for drawing tiles from an existing .

Base class for implementing editing operations.

Updates the preview of this operation.

Updates the active action area of this operation.

Begins a continuous operation with this tool. Usually invoked via left-click.

Updates the currently performed continuous operation of this tool.

Ends a previously started continuous operation of this tool.

Initializes the tool's internal toolbar button.

Disposes the tool's internal toolbar button.

[GET] The editor environment in which this operation is performed.

[GET] The toolbar button that represents this operation.

[GET] The name of the editing operation as displayed to the user.

[GET] The icon of the editing operation as displayed to the user.

[GET] An optional hint that is displayed in the user interface when using this tool.

[GET] The cursor image to be used when this tool is active.

[GET] An optional shortcut key that can be used to invoke this tool.

[GET] An optional override key that, as long as pressed, will override the selected tool with this one.

[GET] If true, this tool always prefers the currently selected for editing and picking operations, rather than the one the is nearest to the camera.

[GET] If true, previews of this operation will be partially faded in to avoid visual noise.

[GET] A relative indicator where to put this tool when displaying it to the user. Negative values offset towards the beginning, positive values offset towards the end.

[GET] The type of that is used by this .

[GET] Retrieves the object that stores this tool's settings.

A that is able to provide matching existing Resources to a given , as well as create them on demand where requested.

Opens a Camera View in Tilemap Editor mode and selects the Tilemap for editing.

Opens a setup dialog that allows to configure the selected tilemaps.

Context menu action that will create a new based on the selected resource.

A user dialog that allows to quickly generate a set of layers based on some settings.

Required designer variable.

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Required method for Designer support - do not modify the contents of this method with the code editor.

The width and height of each layer.

The number of layers that will be generated.

The that will be used for the generated layers. If you want each layer to use a different , you can assign them manually after generating the objects.

Whether or not the generated will produce depth values. Top-down and side-scrolling maps are usually flat and every tile shares the same depth value. However, if you're setting up a tilemap that uses fake perspective, e.g. a character can walk both in front of and behind a tree, you need a deep , where every tile has its own depth values.

Whether or not the generated layers will be used as a source for generating collision shapes in a static .

A user dialog for resizing a set of instances relative to a specified origin.

Required designer variable.

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Required method for Designer support - do not modify the contents of this method with the code editor.

[GET / SET] The tilemaps that are to be adjusted by the dialog.

Invalidates the assigned and forces re-generating its visual representation inside this . This is only necessary if the has changed outside the .

Determines the tile index at the specified pixel / view coordinate.

Determines the pixel / view coordinate of the specified tile index.

Converts a 2D tile (not pixel) coordinate from displayed to original tileset space.

Converts a 2D tile (not pixel) coordinate from original tileset to displayed space.

Converts a 2D tile (not pixel) coordinate (in tileset space) into the associated tile index.

Converts a tile index into a 2D tile (not pixel) coordinate, in tileset space.

Draws the tile layer of the .

[GET / SET] Whether or not each tile's index inside the tileset is displayed on top of the tile.

[GET] The pixel size of a single tile, as displayed in this . Note that this does not necessarily need to reflect the original tile size.

[GET] The original tileset layout's number of tiles in X and Y direction.

[GET] The number of displayed tiles in X and Y direction.

The selected area of tiles, in displayed tile space.

Describes a single painted tile in the paint event of a .

The index that identifies the painted tile within the .

The rectangle that holds the tile within its source image.

The rectangle within the to which the tile is painted.

Event arguments that provide data about a set of painted tiles within a .

[GET] The that is currently being painted.

[GET] A that has been generated from the , which should be used as a(n atlas) source image for drawing individual tiles.

[GET] Data about the tiles that should be painted within the .

The data model if a layer view item.

[GET] The item's short title / headline that is displayed to the user.

[GET] The item's description that is displayed to the user.

Allows editing the properties of a that can't be accessed easily in a regular .

Required designer variable.

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Required method for Designer support - do not modify the contents of this method with the code editor.

[GET] The currently selected in this editor. This property is dependent on and automatically set by editor-wide selection events.

Event arguments that provide data about a switch from one tile index to another.

[GET] The tile index that is affected by this event.

[GET] The last tile index that was affected by this event.

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized resource of type System.Drawing.Bitmap.

When drawing tiles onto a , this represents the source from which the drawn data is retrieved.

Signals the beginning of a continuous editing operation that will access this source.

Signals the end of a continuous editing operation that will access this source.

Fills the specified target grid with tiles from this source.

[GET] If the tiles are or were originally retrieved from a , this property returns a reference to it. Otherwise, it returns null.

[GET] An origin offset within the .

[GET] The shape of the tiles to draw.

Allows to edit a Tileset's AutoTile layers, which define how similar adjacent tiles join together.

Describes an editing mode of the . This is a base class that can be derived from in order to implement a new editing mode.

Adds a new layer to the that is defined by this .

Removes the currently selected layer from the that is defined by this .

Selects the layer with the associated model node. This is the same value that will be provided as part of the event when reacting to selection changes.

Called when the editing mode becomes active.

Called when the editing mode is deactivated.

Called when the selection changed.

Called when the currently edited was modified.

Called when the user item selection of the provided has changed.

Called when the previously done changes are applied or reverted.

[GET] The that is currently selected in the editor.

[GET] The that hosts this .

[GET] The of the , which can be customized on a per- basis.

[GET] The editing mode's unique and persistent id. As far as possible, this should be a constant across versions.

[GET] The editing mode's name that is displayed to the user.

[GET] An icon that is used to visually identify this editing mode.

[GET] An that describes the contents of the layer view.

[GET] A user-targeted description of the purpose of this editing mode.

[GET] When displaying various editing modes in a list, this defines the sorting order in which they are listed. Lower values are listed first, higher values last. The default is zero.

[GET] Whether this allows users to edit its layers.

[GET] Whether this allows displaying tile indices on top of the tiles, should the user request it.

Describes how the current user drawing operation will affect existing AutoTile data.

Required designer variable.

Clean up any resources being used.

true if managed resources should be disposed; otherwise, false.

Required method for Designer support - do not modify the contents of this method with the code editor.

Selects the topmost tilemap that is hovered by the mouse cursor for editing.

Flood-fills the selected tile patch with the source pattern.

Runs the flood fill algorithm on the specified position and writes the result into the specified variables.

If true, the algorithm will cancel when taking too long for an interactive preview. True, if the algorithm completed. False, if it was canceled.

Performs a flood fill operation originating from the specified position. equality is checked in the method.

A buffer that will be filled with the result of the flood fill operation. The maximum number of tiles to fill. If the filled tile count exceeds this number, the algorithm is canceled. True when successful. False when aborted.

Fills all tiles in the selected oval area with the source pattern.

Fills all tiles in the selected rectangular area with the source pattern.

Draws the source pattern directly onto the tilemap.

A dummy tool that represents not performing any operation on the edited .

Provides an interface for instances to access internals and perform editing operations.

Submits a set of previous changes to or to be used in the editor.

Specifies whether the currently set editing area represents the actual area the action will be performed in. False is for incomplete or invalid previews.

Performs an editing operation to the specified .

[GET / SET] When drawing tiles, this is the source from which the drawn pattern is retrieved. This property is never null. Assigning null will reset it to its default non-null value.

[GET / SET] The currently selected .

[GET] The coordinate of the that is currently hovered by the mouse cursor.

[GET] The currently active .

[GET / SET] The coordinates of the actions proposed editing area.

[GET] A grid mask that represents the actions proposed editing area.

[GET] A list of outlines that enclose the actions proposed editing area. Will be determined automatically when cleared.

[GET] The coordinate of the where the current action was started.

Provides tools for editing tilemaps, which are embedded directly into the current using an .

Initializes the list of available instances.

Initializes the list of available -related editor actions.

Creates the tilemap editor's tool buttons based on the available tools and actions.

Destroys all previously added tool buttons of the tilemap editor.

Adds the currently selected to the editor-wide selection, so it becomes editable in the object inspector and can be configured by the user.

Removes the currently selected from the editor-wide selection.

Informs the system that a is required and creates one, if none is present yet.

Informs the system that a is no longer required and closes it, if no other claims are pending.

Given the specified reference, this method enumerates all loaded instances that are candidates for a runtime recompile to account for potential changes.

An event that is fired when the is assigned a new value.

[GET / SET] The data source that is used for retrieving tile patterns while using a tile drawing tool. Can be thought of as the "tile brush" that is currently used in user editing operations.

Since directly accessing code generated from .resx files will result in a deserialization on each Resource access, this class allows cached Resource access.

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to Creates a new Tileset Resource based on the Pixmap..

Looks up a localized string similar to Opens a Camera View in Tilemap Editor mode and selects the Tilemap for editing..

Looks up a localized string similar to Opens the Tileset for editing..

Looks up a localized string similar to Opens a user dialog that allows to resize the selected Tilemaps. If no tilemaps are selected, it will resize all currently active, non-hidden tilemaps in the current scene..

Looks up a localized string similar to Opens a user dialog that helps you quickly create a set of layered Tilemaps..

Looks up a localized string similar to Create Tileset.

Looks up a localized string similar to Open Tilemap Editor.

Looks up a localized string similar to Edit Tileset.

Looks up a localized string similar to Resize Tilemap.

Looks up a localized string similar to Setup Tilemaps.

Looks up a localized string similar to Use the arrow keys to quickly change tilemap selection..

Looks up a localized string similar to Tilemap Editor Actions.

Looks up a localized string similar to Tilemap Editor.

Looks up a localized resource of type System.Drawing.Bitmap.

Looks up a localized string similar to Tile Picker.

Looks up a localized string similar to Tile Brush.

Looks up a localized string similar to Flood Fill.

Looks up a localized string similar to Draw Oval.

Looks up a localized string similar to Draw Rect.

Looks up a localized string similar to Selection Tool.

Looks up a localized string similar to Tile Palette.

Looks up a localized string similar to Tileset Editor.

Looks up a localized string similar to Tileset modified.

Looks up a localized string similar to You've made changes to Tileset '{0}'. Do you want to Apply them?.

Looks up a localized string similar to Resize {0} Tilemaps.

Looks up a localized string similar to Resize '{0}'.

Looks up a localized string similar to No Tileset available.

Looks up a localized string similar to Tileset: {0}.

Looks up a localized resource of type System.Drawing.Bitmap.

Looks up a localized string similar to No Tileset selected.

Looks up a localized string similar to Tileset: {0}.

Looks up a localized string similar to Aux. Collision.

Looks up a localized string similar to Layer Index {0}.

Looks up a localized string similar to Main Collision.

Looks up a localized string similar to Tile Rendering Order.

Looks up a localized string similar to Depth Offset.

Looks up a localized string similar to Vertical / Flat Tiles.

Looks up a localized string similar to Orientation.

Looks up a localized string similar to AutoTiles.

Looks up a localized string similar to Select or create a new AutoTile layer on the left side of the Tileset Editor. After doing so, you will be able to specify each tile's role when connecting an AutoTile to its surroundings. The first tile you click on will determine the fully connected base tile (orange). With left and right click, you can then add or remove the connecting parts of the remaining tiles. Hold the shift key to specify external tiles that are not part of the AutoTile itself, but will be connected to..

Looks up a localized string similar to Collision Info.

Looks up a localized string similar to Depth Info.

Looks up a localized string similar to Visual Layers.

Looks up a localized string similar to Apply Tileset Changes.

Looks up a localized string similar to Draw Tiles.

Looks up a localized string similar to Fill Tile Oval.

Looks up a localized string similar to Fill Tile Rect.

Looks up a localized string similar to Flood Fill Tiles.

Looks up a localized string similar to Resize Tilemap.

Looks up a localized string similar to Revert Tileset Changes.

Looks up a localized string similar to Add Config Layer.

Looks up a localized string similar to Edit Tile Input.

Looks up a localized string similar to Remove Config Layer.

Provides commonly used utility methods for setting up layers to be edited by the user. This usually involves and initial resize and default tile assignments.

Determines the default tile index of the specified depending on the role of the in which it is used.

Prepares the specified for user editing using the default size.

Prepares the specified for user editing using the specified size.

Allows to edit the depth information of each tile, which can be used for Z-Offset generation and Z sorting during rendering.

Allows to edit the physical shape of each tile which can be used for collision detection and physics.

Represents a certain area within a tile in the , which can be hovered or clicked by the user.

Describes the way in which the current user drawing operation will interact with existing collision bits.

used for selection changes.

[GET] The previously selected .

[GET] The that will be selected next / is being selected.

[GET] The reason for the selection change to occur.

used for selection changes occurring in the layer view of a .

[GET] The tag value of the selected view node. Usually, this is a reference to the model node that corresponds to it.

Specifies ways in which layers can be edited.

Allow users to modify existing layers.

Allow users to add or remove layers.

Allows to edit a Tileset's visual layers, which define the Texture- and Material properties that will affect how it is rendered.