Skip to content
ConsoleMonster

API Reference

Class

Shortcodes

Edit on GitHub
Namespace ConsoleMonster.Glyphs
Assembly ConsoleMonster
Source SymbolFallback.cs:189
Modifiers static

:shortcode: names for emoji (:white_check_mark: is ✅, :warning: is ⚠️, :rocket: is 🚀). Used by markup when Markup.Shortcodes is on and by the emoji presenter; apps add names with Shortcodes.Register. Unknown names stay as written.

Inheritance

  • Object
  • Shortcodes

Methods

public static Void Register(String name, String text) #
SymbolFallback.cs:189
Returns: Void

Adds or replaces a shortcode.

Parameters

name System.String requiredposition: 0
The name without colons, for example deploy.
text System.String requiredposition: 1
The text it stands for.
public static String Replace(String text) #
SymbolFallback.cs:214
Returns: String

Replaces every known :name: in a text.

Parameters

text System.String requiredposition: 0
The text.

Returns

The text with shortcodes replaced.

public static Boolean TryGet(String name, out String text) #
SymbolFallback.cs:202
Returns: Boolean

The text of a shortcode.

Parameters

name System.String requiredposition: 0
The name without colons.
text System.String requiredposition: 1
The text.

Returns

Whether the name is known.