Scripting API

Scripting API

SystemClipboard

Class in Abyss.Core, from Abyss.Core.

The platform's clipboard, as text: what the editor or a game copies goes there, where any other program can paste it, and what another program copied comes from there.

public static class SystemClipboard

Remarks

The engine's, through Bevy's clipboard crate, because .NET has none but the ones Windows Forms and WPF keep for Windows; see abyss_core::clipboard for how it reaches each platform's.

Let go of as the program ends, without being asked: on X11 what a program copied stays with it, and is handed to the desktop's clipboard manager only when the program lets go, so otherwise what was copied last would go with it.

Properties

Text

public static string? Text { get; set; }

The text on the clipboard, or null when it holds none: nothing, or something that is not text, as an image is. Set, it takes the place of whatever was there.

Exceptions

  • IOException: The platform would not let the clipboard be read or written — another program has it open, or there is no clipboard to reach, as with no X server — and the message says what it said. A text that was not written leaves what was there.
  • ArgumentNullException: Set to null, which is not a text.