Skip to main content

FontPalette

Holds fonts for reuse by giving fonts a semantic name. This makes theming easier in general.

Functions​

new​

</>
FontPalette.new() → FontPallete

Constructs a new font palette.

GetFontNames​

</>
FontPalette.GetFontNames(self: FontPalette) → {string}

Gets all available font names

ObserveFontNames​

</>
FontPalette.ObserveFontNames(self: FontPalette) → Observable<string>

Observes all available font names as they are added starting with existing fonts.

ObserveFontNamesBrio​

</>
FontPalette.ObserveFontNamesBrio(self: FontPalette) → Observable<Brio<string>>

Observes all available font names as they are added starting with existing fonts.

GetFont​

</>
FontPalette.GetFont(
self: FontPalette,
fontName: string
) → Enum.Font

Gets a font from name

ObserveFont​

</>
FontPalette.ObserveFont(
self: FontPalette,
fontName: string
) → Observe<Enum.Font>

Observes a font from name

ObserveFontFace​

</>
FontPalette.ObserveFontFace(
self: FontPalette,
fontName: string,
) → Observable<Font>

Observes the curent font face defined for the font name

GetFontFaceValue​

</>
FontPalette.GetFontFaceValue(
self: FontPalette,
fontName: string
) → ValueObject<Font>

Gets a font value object for a given font.

GetFontValue​

</>
FontPalette.GetFontValue(
self: FontPalette,
fontName: string
) → ValueObject<Font>

Gets a font value object for a given font.

GetDefaultFontMap​

</>
FontPalette.GetDefaultFontMap(self: FontPalette) → {string: Font | Enum.Font}

Gets the default font map

DefineFont​

</>
FontPalette.DefineFont(
self: FontPalette,
fontName: string,
defaultFont: Enum.Font | Font
) → ValueObject<Enum.Font>

Defines a new font into the palette which can be changed over time.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new font palette.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "FontPallete"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "GetFontNames",
            "desc": "Gets all available font names",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "ObserveFontNames",
            "desc": "Observes all available font names as they are added starting with\nexisting fonts.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 67,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "ObserveFontNamesBrio",
            "desc": "Observes all available font names as they are added starting with\nexisting fonts.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Brio<string>>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 86,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "GetFont",
            "desc": "Gets a font from name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                },
                {
                    "name": "fontName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Enum.Font"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 96,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "ObserveFont",
            "desc": "Observes a font from name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                },
                {
                    "name": "fontName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observe<Enum.Font>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 108,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "ObserveFontFace",
            "desc": "Observes the curent font face defined for the font name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                },
                {
                    "name": "fontName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "weight",
                    "desc": "",
                    "lua_type": "(FontWeight | Observable<FontWeight>)?"
                },
                {
                    "name": "style",
                    "desc": "",
                    "lua_type": "(FontStyle | Observable<FontStyle>)?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<Font>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 122,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "GetFontFaceValue",
            "desc": "Gets a font value object for a given font.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                },
                {
                    "name": "fontName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ValueObject<Font>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 151,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "GetFontValue",
            "desc": "Gets a font value object for a given font.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                },
                {
                    "name": "fontName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ValueObject<Font>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 168,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "GetDefaultFontMap",
            "desc": "Gets the default font map",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ string: Font | Enum.Font }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 183,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        },
        {
            "name": "DefineFont",
            "desc": "Defines a new font into the palette which can be changed over time.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "FontPalette"
                },
                {
                    "name": "fontName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "defaultFont",
                    "desc": "",
                    "lua_type": "Enum.Font | Font"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ValueObject<Enum.Font>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 194,
                "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "FontPalette",
    "desc": "Holds fonts for reuse by giving fonts a semantic name. This makes theming easier in general.",
    "source": {
        "line": 7,
        "path": "src/colorpalette/src/Shared/Font/FontPalette.lua"
    }
}