kyd-editor/uk.co.nickthecoder.kyd.editor

Package-level declarations

Types

class Editor : Application

The main entry point for the Editor application. This is a JVM-only application (i.e. cannot be run in a browser).

object EditorCommands : Commands

object EditorSettings

object KydTheme : ThemeBuilder

Designed to be combined with the default Tantalum theme.

class MainView(val stage: Stage)

open class State

A collection of properties, based on the current Game, and the selected Resource. The properties are used (by MainView and ResourcesDock etc.) to carry out actions, and also to hide/show/disable some actions. e.g. you cannot open a resource in an external application when selectedFile is null (i.e. when the resource is not a FileResource).

Properties

val editorIcons: Icons.ResizableIcons

editorResources

val editorResources: Resources

fullSizeEditorIcons

val fullSizeEditorIcons: Icons

smallEditorIcons

val smallEditorIcons: Icons.SizedIcons

tinyEditorIcons

val tinyEditorIcons: Icons.SizedIcons

Functions

alignChildFormGrids

fun Node.alignChildFormGrids()

fun attribute(label: String, control: () -> Node): VBox

fun attribute(label: String, control: Node): VBox

fun File.browse()

fun clamp(value: Int, min: Int, max: Int): Int

fun Tab.close()

countDescendants

fun Resource.countDescendants(): Int

fun File.countFiles(): Int

createAttributeNode

fun createAttributeNode(map: MutableMap<String, AttributeValue>, name: String, av: AttributeValue, game: Game): Node

Creates an editor (such as a TextField, IntSpinner etc. for an AttributeValue). Used by Role.

createCustomPropertiesBox

fun createCustomPropertiesBox(customisable: Customisable, relativeToResource: Resource): Node

createCustomPropertiesForm

fun createCustomPropertiesForm(customisable: Customisable, relativeToResource: Resource): FormGrid

fun File.deleteFolder()

fun edges(top: Node, right: Node, bottom: Node, left: Node): HBox

fun fileButton(file: File, externalApplication: String): SplitMenuButton

filterIsInstance

inline fun <T : Resource> ParentResource.filterIsInstance(): List<T>

fun ParentResource.folder(): File

Returns the directory where any child FileResources will be stored.

fun Node.grow()

fun mainMenu(actions: Actions): MenuBar

fun mainToolBar(actions: Actions, state: State): ToolBar

fun nameField(): TextField

Creates a TextField, suitable for Resource.name

nameFilenameField

fun nameFilenameField(folder: File): TextField

Creates a TextField, suitable for FileResource.filename

fun File.open()

fun openFile(file: File, externalApplication: String)

Opens the file in an external program.

fun File.openTerminal()

popupResourcesChildren

fun popupResourcesChildren(res: ParentResource, fromNode: Node, side: Side = Side.BOTTOM)

fun FileResource.resourceFile(): File

fun saveTexture(texture: Texture, file: File)

fun twoFields(separator: String, a: Node, b: Node): ThreeRow

fun ColorButton.withHexText(): HBox

withInformation

fun Node.withInformation(text: String, block: VBox.() -> Unit? = null): VBox

fun xByY(x: Node, y: Node): ThreeRow

fun xCommaY(x: Node, y: Node): ThreeRow