CORE Game Developers Toolkit v1.1.0
 
Loading...
Searching...
No Matches
CORE.EditorKit Namespace Reference

Classes

class  KitBadge
 A small rounded mark: a count, a state, a package. Toned from the theme, or colored by code for a module. More...
 
class  KitButton
 A button with an optional glyph. No text makes it a square icon button; give it a tooltip then. One primary button per view: the action the view is for. More...
 
class  KitCallout
 A note in the flow of a page — what to know, what is wrong — with an optional link to act or read more. More...
 
class  KitCard
 A raised block with a title: a feature of an item, a step of a wizard, a section of settings. Collapsible cards fold on a click on their header; Toggled lets the owner remember it. More...
 
class  KitChangelog
 The CHANGELOG.md of every installed package (<RootFolder>/CHANGELOG.md), newest version first: ## 1.3 — 2026-11-02 headings, then what changed. A Welcome window shows them and marks a package whose newest heading the user has not seen yet. More...
 
class  KitChangelogPostprocessor
 Reads the changelogs again when one is imported, changed or removed.
 
class  KitContribution
 Something a package adds to a kit window — a settings page, a setup check, a debugger page. Any concrete subclass with a parameterless constructor in any editor assembly is found by itself (KitContributions.All<T>) and belongs to the KitModule of its assembly; nothing is registered by hand. More...
 
class  KitContributions
 Finds every contribution of a kind, once, in the order of their modules then their own. More...
 
class  KitDebugContext
 What a debugger page may do besides reading: say what came of an action, ask to be built again. More...
 
class  KitDebuggerWindow
 The frame of a Debugger window: the pages of every included module in a sidebar, the picked one refreshed at most four times a second and only when its KitDebugPanel.Version moved. A package derives it and adds a menu item; the pages are KitDebugPanel subclasses found by themselves. More...
 
class  KitDebugPanel
 A page of a Debugger window. A package adds the pages its running state needs from its editor assembly. More...
 
class  KitDialog
 The editor's modal dialogs with the kit's translated buttons. For anything the user must read or decide; a confirmation of what just happened is a toast. More...
 
class  KitEmptyState
 What a view shows when there is nothing in it yet: why, and what to do about it. More...
 
class  KitGalleryWindow
 Every kit component on one screen, in the current skin and language: the reference for anyone building a window on the kit, and the place to judge the look after a change of the style sheet. The Colors page lists every KitModule found in the project. More...
 
class  KitGlyph
 A line icon drawn as vectors, so it is sharp at any size and takes the color of the text around it. More...
 
class  KitGlyphs
 The kit's icon set, by name. A package adds its own with Register, prefixed with its module id (crafting.anvil), from a static constructor or an [InitializeOnLoadMethod]; a name already taken is replaced, so a package may also restyle a kit glyph. More...
 
class  KitHeader
 The top of a window: the module's tile, the title and subtitle, actions on the right. More...
 
class  KitHelp
 Where a help button leads. A manual window sets Handler; until one does, help buttons do not show. Pages are paths within that manual: configs/items, configs/items#art. More...
 
class  KitIcon
 An icon: a KitGlyph in the element's text color, or a texture. Size it in the style sheet. More...
 
class  KitInput
 Helpers for text fields. Keeps a field to the characters a value may hold: an id (a-z 0-9 _, typed capitals become small, spaces and dashes become _) or a name (A-Z a-z 0-9 _) — other keys do nothing, pasted text is cleaned. Gives a field a placeholder that works on every editor version. More...
 
class  KitLanguageButton
 The language of the editor windows, as a header button: a menu of every language some table is written in, and the key display for translators. More...
 
class  KitLog
 The kit's own logging. The kit references no other assembly, so it cannot use CORE's DebugHelper; every line is prefixed so it is still found at a glance.
 
class  KitManualChapter
 One page of a manual: a Markdown file in a package's Editor/Manual/<language> folder, with its place written on top: More...
 
class  KitManualInline
 Inline Markdown as UI Toolkit rich text: code, bold, italic, [text](target). Literal angle brackets are kept literal; links become <link> tags the label reports clicks of. More...
 
class  KitManualLibrary
 Every chapter of every installed package, in the editor's language where a translation exists and in English otherwise. Chapters are Markdown files in any Editor/Manual/<language>/ folder under Assets (an editor folder, so they never reach a build); a package that is not installed has no chapters, so a manual always matches what is in the project. More...
 
class  KitManualLinks
 What a link in a chapter does:

  • https://… — opens the browser;
  • #anchor — scrolls to a heading of the chapter;
  • chapter-id, chapter-id#anchor — opens a chapter (a .md file name works too);
  • open:<action>[/argument] — opens a window: open:gallery, open:settings/core.editorWindows. A package adds its own with Register, prefixed with its module id where the name may clash.
More...
 
class  KitManualMarkdown
 A chapter's Markdown as UI Toolkit elements: headings (anchored), paragraphs, bullet and numbered lists, tables, fenced code, quotes as callouts (> [!NOTE], [!TIP], [!WARNING], [!CAUTION]), images, rules. Enough of GitHub Markdown for a manual, nothing more. More...
 
class  KitManualPostprocessor
 Reads the chapters again when one is added, changed or removed.
 
struct  KitManualSearchHit
 
class  KitManualWindow
 The frame of a Manual window: chapters by group on the left with a search over all of them, the chapter in the middle with links into the editor's windows, its headings on the right. A package derives it, adds a menu item and points KitHelp.Handler at OpenPage<T>, so every help button of every kit window opens it at the right chapter. More...
 
class  KitModule
 A package's identity in the editor windows: its name, color and glyph, and which assemblies are its. Every package built on the kit — CORE itself, a plugin, a plugin's DLC — declares exactly one, in its editor assembly; it is found by itself through TypeCache. More...
 
class  KitPage
 The building blocks of a page: the padded column on the right of a sidebar, its title and lead, section headings, plain texts and wrapping rows. Each is a plain element with a kit class, so a window composes a page without inline styles. More...
 
class  KitPalette
 Colors code needs where a style sheet cannot reach. A module's identity (a window's tile, a package chip) is given as a color by its KitModule, not as a class, so a package the kit has never heard of brings its own. Everything else is in the style sheet's variables. More...
 
class  KitPicker
 A drop-down list to pick one value from: a search field, at most PageSize choices a page with paging, the keyboard (arrows, Page Up/Down, Enter, Esc). Optionally a free value typed in the search. Opens under the element that asked for it and closes when it loses focus. More...
 
class  KitPickerField
 A field that shows the picked value and opens a KitPicker on a click. The request is built when it opens, so the choices are always fresh. More...
 
class  KitPickerOption
 One choice of a KitPicker: the value it writes, how it reads, a caption, a glyph or a picture. More...
 
class  KitPickerRequest
 What a KitPicker shows and allows. More...
 
class  KitProductInfo
 A package as a product: who makes it, where to write, where it is sold. Shown by the Welcome window's footer; an empty link hides its button. More...
 
class  KitProgress
 A thin bar filled to a share, in the color of a tone. More...
 
class  KitRow
 A labelled line of a form: the label in a fixed column, the field filling the rest, an optional extra at the end (a badge, a small button). Give the field no label of its own. More...
 
class  KitSearchField
 A search box: a glyph, a placeholder, a clear button that shows while there is text. Escape clears it. More...
 
class  KitSettingRow
 One setting: its name and what it does on the left, the control on the right. Rows in a card are divided by a thin line. More...
 
class  KitSettingsAsset< T >
 A settings asset of a package: a ScriptableSingleton<T> saved where its [FilePath] says — ProjectSettings/ for the team's, UserSettings/ for one person's — with a key/value store any package may write to under keys prefixed with its module id. A subclass adds typed fields and sets them through Apply, so every change is saved and announced. More...
 
class  KitSettingsFields
 Setting rows ready to add to a card: the control shows the current value and calls back on a change. Texts are passed translated. More...
 
class  KitSettingsPage
 A section as a page — its title, whose settings these are, Reset, then what the section builds — and the same pages inside Unity's Project Settings / Preferences, so they are found where Unity users look first. More...
 
class  KitSettingsSection
 A page of a Settings window — also shown in Unity's Preferences (user sections) or Project Settings (project sections). A package adds its own from its editor assembly and keeps the values in its settings assets (KitSettingsAsset<T>) under keys prefixed with its module id. More...
 
class  KitSettingsStore
 Values a package keeps without a field of its own in a settings asset: string by key, keys prefixed with the package's module id (crafting.warnOnSeveralStacks). Serialized as a list — Unity serializes no dictionary. More...
 
class  KitSettingsWindow
 The frame of a Settings window: the sections of every included module on the left, searchable, the picked one on the right. A package derives it, names its settings assets and adds a menu item; the sections come from KitSettingsSection subclasses found by themselves. More...
 
class  KitSetupCheck
 One thing a Setup Wizard checks about the project. A check reads the project, changes nothing, and is quick: it runs whenever the wizard is shown. A package adds its checks from its editor assembly. More...
 
class  KitSetupResult
 What a check found, and what can be done about it: a fix the wizard can apply, or a place to go. More...
 
class  KitSetupWizardWindow
 The frame of a Setup Wizard: what the project still needs for every included module — each check with a fix or a place to go, grouped by module under a summary with "Fix all". A package derives it, adds a menu item and, if it wants, a footer; the checks are KitSetupCheck subclasses found by themselves. More...
 
class  KitSidebar
 The navigation on the left of a window: foldable groups of items with a glyph and an optional count, one selected. Arrow keys move the selection when it has focus. Meant for tens of items — a long list of entries is a ListView. More...
 
class  KitStatusBar
 The bottom line of a window: what it shows and what is unsaved, short facts on the right. More...
 
class  KitStepper
 The steps of a wizard in a row: done ones checked, the current one marked. A click on a step already reached goes back to it. More...
 
class  KitTabs
 A row of tabs under the header: one is selected, the window shows its page. Pages are the window's own; the tabs only report the choice. Right holds controls at the right end of the row. More...
 
class  KitText
 The texts of the editor windows. Code holds keys only — Tr("configs.toolbar.save"); the words live in tables, one json per package and language, named <Scope>.EditorText.<lang>.json and kept in an Editor folder. Objects nest: {"configs": {"toolbar": {"save": "Save"}}} is the key above. More...
 
class  KitTextPostprocessor
 Reloads the editor texts when a table is added, changed, moved or removed, so open windows follow an edit at once.
 
class  KitTheme
 The look of every kit window: one style sheet, COREEditorKit.uss, found wherever the package is, with the dark or light palette picked by the editor skin. A window adds its own sheet on top with AddSheet; it uses only the kit's –kit-* variables. More...
 
class  KitToasts
 Short notices in the lower right corner of a window that fade on their own: "Saved 3 files". Not for anything the user must read — that is a KitCallout or a KitDialog. More...
 
class  KitToolbar
 A row of commands under the header. Items go left to right; AddSpacer pushes the rest right. More...
 
class  KitWelcomeWindow
 The frame of a Welcome window — the first thing a customer sees. Overview: what the package is and the windows to start from, built by the subclass with the helpers here. Changelog: what changed in every installed package of the family. At the bottom the product, the author, where to write and Show at start. More...
 
class  KitWindow
 The base of every window built on the kit: the theme, a header with the module's tile and a help button, the content, a status bar, toasts. The whole tree is built in code by BuildContent and built again when the editor language changes, so a window keeps no text of its own outside it. More...
 
class  KitWindowFrames
 The style sheet of the ready-made window frames — settings, setup wizard, debugger, manual, welcome — on top of the kit's own. Each frame adds it to its root; a window of a package may add it too to reuse its classes. More...
 

Enumerations

enum  KitButtonKind { Secondary , Primary , Ghost , Danger }
 
enum  KitSettingsScope { User , Project }
 Whose settings a section holds — where they are saved. More...
 
enum  KitTone {
  Neutral , Accent , Info , Success ,
  Warning , Error
}
 What a message or a mark means; picks its color from the theme. More...
 
enum  KitSetupStatus { Passed , Info , Warning , Failed }
 

Enumeration Type Documentation

◆ KitButtonKind

Enumerator
Secondary 
Primary 
Ghost 
Danger 

◆ KitSettingsScope

Whose settings a section holds — where they are saved.

Enumerator
User 

One person's, in UserSettings/: not committed.

Project 

The team's, in ProjectSettings/: committed with the project.

◆ KitSetupStatus

Enumerator
Passed 
Info 

Worth knowing; nothing is broken.

Warning 

Works, but something will be missing.

Failed 

Breaks: the package cannot work until it is done.

◆ KitTone

What a message or a mark means; picks its color from the theme.

Enumerator
Neutral 
Accent 
Info 
Success 
Warning 
Error