reckfellENGINE

LabelSettings

Общее оформление Label: шрифт, интервалы, обводки и тени.

На этой странице
class LabelSettingsReckfellSharpНаследует Resource

Назначьте LabelSettings свойству Label.LabelSettings для общего оформления нескольких надписей. Соответствующие параметры ресурса имеют приоритет над theme-значениями Label. Font = null позволяет использовать шрифт темы, но остальные настройки ресурса, включая FontSize, продолжают действовать.

Начальные значения: FontSize = 16, FontColor белый, LineSpacing = 3, ParagraphSpacing = 0, OutlineSize = 0. ShadowColor прозрачен, поэтому основная тень не видна, хотя ShadowSize = 1 и ShadowOffset = (1, 1). ShadowSize расширяет контур тени, не задаёт Gaussian blur.

Ресурс общий: изменение FontSize или цвета затронет все использующие его Label. Setters изменённых значений испускают Changed; повторное присваивание того же значения обычно ничего не испускает. Changed вложенного Font передаётся через LabelSettings. Для индивидуального оформления создайте копию LabelSettings и назначьте её нужной надписи. Обычная Duplicate отделяет значения стиля и списки слоёв, но Font остаётся общей ссылкой — изменение самого шрифта может затронуть обе копии.

LineSpacing — дополнительный интервал между строками, ParagraphSpacing — между абзацами. Это пиксельные значения, допускающие дробную часть; они не определяют ширину текста и не включают перенос. Для размера шрифта используйте положительное число, для толщины обводки — неотрицательное; setters размеров не заменяют проверку внешних данных.

Дополнительные эффекты задаются по индексам. Сначала AddStackedOutline/Shadow либо установите Count, затем настройте размер, цвет и смещение существующих слоёв. Новая обводка имеет Size = 0 и чёрный цвет; новая тень — Offset = (1, 1), чёрный непрозрачный цвет и OutlineSize = 0. Задавайте её цвет явно, если не нужна чёрная тень. Рост Count добавляет значения по умолчанию, уменьшение уничтожает хвост.

Add с index = -1 добавляет в конец; неотрицательный index от 0 до Count вставляет перед указанной позицией. Move принимает позицию вставки до удаления исходного элемента, тоже 0…Count. Например, для трёх слоёв MoveStackedOutline(0, 3) переносит первый в конец, а (0, 1) сохраняет порядок. Даже такое перемещение без видимого изменения испускает Changed. После вставки/удаления индексы следующих слоёв меняются.

Толщины дополнительных обводок суммируются с основной OutlineSize: это добавочная толщина каждого слоя, не независимый абсолютный радиус. Внешние слои рисуются раньше внутренних. Дополнительные тени рисуются от последнего индекса к первому, перед обводками и основным текстом. Большие суммарные обводки требуют подходящей настройки диапазона MSDF шрифта; иначе края могут обрезаться.

Эффекты не резервируют место в родительской раскладке. Большая обводка или ShadowOffset могут выходить за границы Label и обрезаться родителем. Выделите отступы контейнером и учитывайте clipping отдельно; изменение цвета не решает недостаток места.

Label.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

LabelSettingsКонструктор
# LabelSettings
C#
public LabelSettings();

Создаёт ресурс: Font = null, FontSize = 16, белый FontColor, LineSpacing = 3, ParagraphSpacing = 0, OutlineSize = 0, прозрачная основная тень; оба дополнительных списка пусты.

Свойства12

FontСвойство
# Font
C#
public Font Font { get; set; }

Общая ссылка Font либо null для шрифта темы Label. Изменения назначенного Font передаются через Changed; замена отключает подписку от старого ресурса. Duplicate LabelSettings по умолчанию не делает Font независимым.

FontColorСвойство
# FontColor
C#
public Color FontColor { get; set; }

Цвет и альфа основного текста, белый по умолчанию. Изменение общего ресурса затрагивает все использующие его Label. Не задаёт тень/обводку.

FontSizeСвойство
# FontSize
C#
public int FontSize { get; set; }

Размер шрифта в пикселях, 16 по умолчанию. Имеет приоритет над theme font_size при назначенном LabelSettings. Используйте положительное число; setter не ограничивает его автоматически.

LineSpacingСвойство
# LineSpacing
C#
public float LineSpacing { get; set; }

Дополнительный промежуток строк в пикселях, 3 по умолчанию; допускает дробь. Не задаёт абзацный интервал, размер шрифта или ширину переноса.

OutlineColorСвойство
# OutlineColor
C#
public Color OutlineColor { get; set; }

Цвет основной обводки, белый по умолчанию. Для видимости нужна положительная OutlineSize и непрозрачный цвет. Не меняет цвета дополнительных слоёв.

OutlineSizeСвойство
# OutlineSize
C#
public int OutlineSize { get; set; }

Толщина основной обводки в пикселях, 0 по умолчанию. Неотрицательные дополнительные stacked-толщины прибавляются к ней. Не резервирует место в раскладке.

ParagraphSpacingСвойство
# ParagraphSpacing
C#
public float ParagraphSpacing { get; set; }

Дополнительный промежуток абзацев в пикселях, 0 по умолчанию; допускает дробь. Разделитель абзацев задаётся на Label отдельно.

ShadowColorСвойство
# ShadowColor
C#
public Color ShadowColor { get; set; }

Цвет основной тени, прозрачный чёрный по умолчанию. Альфа 0 скрывает эту тень, но не отключает отдельные stacked-тени.

ShadowOffsetСвойство
# ShadowOffset
C#
public Vector2 ShadowOffset { get; set; }

Смещение основной тени в локальных пикселях, (1, 1) по умолчанию. Не добавляет отступы в минимум Label; родительский clipping может обрезать эффект.

ShadowSizeСвойство
# ShadowSize
C#
public int ShadowSize { get; set; }

Толщина расширенного контура основной тени в пикселях, 1 по умолчанию. Это не радиус размытия. При прозрачном ShadowColor основная тень не видна.

StackedOutlineCountСвойство
# StackedOutlineCount
C#
public int StackedOutlineCount { get; set; }

Неотрицательное число дополнительных обводок. Рост добавляет Size = 0/чёрный цвет, уменьшение удаляет хвост. Это не число основных OutlineSize-обводок.

StackedShadowCountСвойство
# StackedShadowCount
C#
public int StackedShadowCount { get; set; }

Неотрицательное число дополнительных теней. Новые слои имеют Offset = (1, 1), непрозрачный чёрный цвет и OutlineSize = 0. Уменьшение уничтожает хвостовые слои.

Методы40

AddStackedOutlinevoid
# AddStackedOutline
C#
public void AddStackedOutline(int index = -1);

Вставляет обводку по позиции 0…Count; -1 по умолчанию добавляет в конец. Новая толщина 0, цвет чёрный. Увеличивает Count, сдвигает индексы и испускает Changed.

Параметры
ИмяТипПо умолчанию
indexint-1
index

Позиция вставки 0…Count; -1 добавляет в конец.

AddStackedShadowvoid
# AddStackedShadow
C#
public void AddStackedShadow(int index = -1);

Вставляет тень по позиции 0…Count; -1 по умолчанию добавляет в конец. Новый слой непрозрачно-чёрный со смещением (1, 1) и контуром 0; настройте его явно.

Параметры
ИмяТипПо умолчанию
indexint-1
index

Позиция вставки 0…Count; -1 добавляет в конец.

GetFontFont
# GetFont
C#
public Font GetFont();

Общая ссылка Font либо null для шрифта темы Label. Изменения назначенного Font передаются через Changed; замена отключает подписку от старого ресурса. Duplicate LabelSettings по умолчанию не делает Font независимым.

Возвращает Font

Сохранённое значение: общая ссылка Font либо null.

GetFontColorColor
# GetFontColor
C#
public Color GetFontColor();

Цвет и альфа основного текста, белый по умолчанию. Изменение общего ресурса затрагивает все использующие его Label. Не задаёт тень/обводку.

Возвращает Color

Сохранённое значение: цвет основного текста.

GetFontSizeint
# GetFontSize
C#
public int GetFontSize();

Размер шрифта в пикселях, 16 по умолчанию. Имеет приоритет над theme font_size при назначенном LabelSettings. Используйте положительное число; setter не ограничивает его автоматически.

Возвращает int

Сохранённое значение: размер шрифта в пикселях.

GetLineSpacingfloat
# GetLineSpacing
C#
public float GetLineSpacing();

Дополнительный промежуток строк в пикселях, 3 по умолчанию; допускает дробь. Не задаёт абзацный интервал, размер шрифта или ширину переноса.

Возвращает float

Сохранённое значение: добавочный межстрочный интервал в пикселях.

GetOutlineColorColor
# GetOutlineColor
C#
public Color GetOutlineColor();

Цвет основной обводки, белый по умолчанию. Для видимости нужна положительная OutlineSize и непрозрачный цвет. Не меняет цвета дополнительных слоёв.

Возвращает Color

Сохранённое значение: цвет основной обводки.

GetOutlineSizeint
# GetOutlineSize
C#
public int GetOutlineSize();

Толщина основной обводки в пикселях, 0 по умолчанию. Неотрицательные дополнительные stacked-толщины прибавляются к ней. Не резервирует место в раскладке.

Возвращает int

Сохранённое значение: толщина основной обводки в пикселях.

GetParagraphSpacingfloat
# GetParagraphSpacing
C#
public float GetParagraphSpacing();

Дополнительный промежуток абзацев в пикселях, 0 по умолчанию; допускает дробь. Разделитель абзацев задаётся на Label отдельно.

Возвращает float

Сохранённое значение: добавочный межабзацный интервал в пикселях.

GetShadowColorColor
# GetShadowColor
C#
public Color GetShadowColor();

Цвет основной тени, прозрачный чёрный по умолчанию. Альфа 0 скрывает эту тень, но не отключает отдельные stacked-тени.

Возвращает Color

Сохранённое значение: цвет основной тени.

GetShadowOffsetVector2
# GetShadowOffset
C#
public Vector2 GetShadowOffset();

Смещение основной тени в локальных пикселях, (1, 1) по умолчанию. Не добавляет отступы в минимум Label; родительский clipping может обрезать эффект.

Возвращает Vector2

Сохранённое значение: смещение основной тени в пикселях.

GetShadowSizeint
# GetShadowSize
C#
public int GetShadowSize();

Толщина расширенного контура основной тени в пикселях, 1 по умолчанию. Это не радиус размытия. При прозрачном ShadowColor основная тень не видна.

Возвращает int

Сохранённое значение: толщина контура основной тени в пикселях.

GetStackedOutlineColorColor
# GetStackedOutlineColor
C#
public Color GetStackedOutlineColor(int index);

Возвращает цвет выбранной дополнительной обводки, чёрный для нового слоя.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

Возвращает Color

Возвращает цвет выбранной дополнительной обводки, чёрный для нового слоя.

GetStackedOutlineCountint
# GetStackedOutlineCount
C#
public int GetStackedOutlineCount();

Неотрицательное число дополнительных обводок. Рост добавляет Size = 0/чёрный цвет, уменьшение удаляет хвост. Это не число основных OutlineSize-обводок.

Возвращает int

Сохранённое значение: число дополнительных обводок.

GetStackedOutlineSizeint
# GetStackedOutlineSize
C#
public int GetStackedOutlineSize(int index);

Возвращает сохранённую добавочную толщину слоя, не суммарный радиус всей обводки. Индекс должен существовать.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

Возвращает int

Возвращает сохранённую добавочную толщину слоя, не суммарный радиус всей обводки. Индекс должен существовать.

GetStackedShadowColorColor
# GetStackedShadowColor
C#
public Color GetStackedShadowColor(int index);

Возвращает сохранённый цвет дополнительной тени; новый слой непрозрачно-чёрный.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

Возвращает Color

Возвращает сохранённый цвет дополнительной тени; новый слой непрозрачно-чёрный.

GetStackedShadowCountint
# GetStackedShadowCount
C#
public int GetStackedShadowCount();

Неотрицательное число дополнительных теней. Новые слои имеют Offset = (1, 1), непрозрачный чёрный цвет и OutlineSize = 0. Уменьшение уничтожает хвостовые слои.

Возвращает int

Сохранённое значение: число дополнительных теней.

GetStackedShadowOffsetVector2
# GetStackedShadowOffset
C#
public Vector2 GetStackedShadowOffset(int index);

Возвращает сохранённое смещение слоя тени, (1, 1) для нового слоя.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

Возвращает Vector2

Возвращает сохранённое смещение слоя тени, (1, 1) для нового слоя.

GetStackedShadowOutlineSizeint
# GetStackedShadowOutlineSize
C#
public int GetStackedShadowOutlineSize(int index);

Возвращает сохранённую толщину контура слоя тени, 0 для нового слоя.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

Возвращает int

Возвращает сохранённую толщину контура слоя тени, 0 для нового слоя.

MoveStackedOutlinevoid
# MoveStackedOutline
C#
public void MoveStackedOutline(int fromIndex, int toPosition);

Перемещает существующий слой в позицию вставки до удаления исходного, 0…Count. Это не конечный индекс: (0, 1) сохраняет порядок, (0, Count) переносит первый в конец. Даже неизменный порядок испускает Changed.

Параметры
ИмяТипПо умолчанию
fromIndexint—
toPositionint—
fromIndex

Существующий индекс источника, 0…Count − 1.

toPosition

Позиция вставки до удаления источника, 0…Count включительно; не конечный индекс.

MoveStackedShadowvoid
# MoveStackedShadow
C#
public void MoveStackedShadow(int fromIndex, int toPosition);

Перемещает полный слой тени в позицию вставки 0…Count до удаления исходного. Индексы могут сдвинуться; даже перемещение без изменения порядка испускает Changed.

Параметры
ИмяТипПо умолчанию
fromIndexint—
toPositionint—
fromIndex

Существующий индекс источника, 0…Count − 1.

toPosition

Позиция вставки до удаления источника, 0…Count включительно; не конечный индекс.

RemoveStackedOutlinevoid
# RemoveStackedOutline
C#
public void RemoveStackedOutline(int index);

Удаляет существующую обводку по индексу 0…Count − 1. Последующие индексы уменьшаются; Count и список свойств обновляются, Changed испускается.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

RemoveStackedShadowvoid
# RemoveStackedShadow
C#
public void RemoveStackedShadow(int index);

Удаляет существующий слой тени и сдвигает следующие индексы. Индекс должен существовать; удаление не сохраняет данные для последующего роста Count.

Параметры
ИмяТипПо умолчанию
indexint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

SetFontvoid
# SetFont
C#
public void SetFont(Font font);

Общая ссылка Font либо null для шрифта темы Label. Изменения назначенного Font передаются через Changed; замена отключает подписку от старого ресурса. Duplicate LabelSettings по умолчанию не делает Font независимым.

Параметры
ИмяТипПо умолчанию
fontFont—
font

Общая ссылка Font либо null для шрифта темы Label. Изменения назначенного Font передаются через Changed; замена отключает подписку от старого ресурса. Duplicate LabelSettings по умолчанию не делает Font независимым.

SetFontColorvoid
# SetFontColor
C#
public void SetFontColor(Color color);

Цвет и альфа основного текста, белый по умолчанию. Изменение общего ресурса затрагивает все использующие его Label. Не задаёт тень/обводку.

Параметры
ИмяТипПо умолчанию
colorColor—
color

Цвет и альфа основного текста, белый по умолчанию. Изменение общего ресурса затрагивает все использующие его Label. Не задаёт тень/обводку.

SetFontSizevoid
# SetFontSize
C#
public void SetFontSize(int size);

Размер шрифта в пикселях, 16 по умолчанию. Имеет приоритет над theme font_size при назначенном LabelSettings. Используйте положительное число; setter не ограничивает его автоматически.

Параметры
ИмяТипПо умолчанию
sizeint—
size

Размер шрифта в пикселях, 16 по умолчанию. Имеет приоритет над theme font_size при назначенном LabelSettings. Используйте положительное число; setter не ограничивает его автоматически.

SetLineSpacingvoid
# SetLineSpacing
C#
public void SetLineSpacing(float spacing);

Дополнительный промежуток строк в пикселях, 3 по умолчанию; допускает дробь. Не задаёт абзацный интервал, размер шрифта или ширину переноса.

Параметры
ИмяТипПо умолчанию
spacingfloat—
spacing

Дополнительный промежуток строк в пикселях, 3 по умолчанию; допускает дробь. Не задаёт абзацный интервал, размер шрифта или ширину переноса.

SetOutlineColorvoid
# SetOutlineColor
C#
public void SetOutlineColor(Color color);

Цвет основной обводки, белый по умолчанию. Для видимости нужна положительная OutlineSize и непрозрачный цвет. Не меняет цвета дополнительных слоёв.

Параметры
ИмяТипПо умолчанию
colorColor—
color

Цвет основной обводки, белый по умолчанию. Для видимости нужна положительная OutlineSize и непрозрачный цвет. Не меняет цвета дополнительных слоёв.

SetOutlineSizevoid
# SetOutlineSize
C#
public void SetOutlineSize(int size);

Толщина основной обводки в пикселях, 0 по умолчанию. Неотрицательные дополнительные stacked-толщины прибавляются к ней. Не резервирует место в раскладке.

Параметры
ИмяТипПо умолчанию
sizeint—
size

Толщина основной обводки в пикселях, 0 по умолчанию. Неотрицательные дополнительные stacked-толщины прибавляются к ней. Не резервирует место в раскладке.

SetParagraphSpacingvoid
# SetParagraphSpacing
C#
public void SetParagraphSpacing(float spacing);

Дополнительный промежуток абзацев в пикселях, 0 по умолчанию; допускает дробь. Разделитель абзацев задаётся на Label отдельно.

Параметры
ИмяТипПо умолчанию
spacingfloat—
spacing

Дополнительный промежуток абзацев в пикселях, 0 по умолчанию; допускает дробь. Разделитель абзацев задаётся на Label отдельно.

SetShadowColorvoid
# SetShadowColor
C#
public void SetShadowColor(Color color);

Цвет основной тени, прозрачный чёрный по умолчанию. Альфа 0 скрывает эту тень, но не отключает отдельные stacked-тени.

Параметры
ИмяТипПо умолчанию
colorColor—
color

Цвет основной тени, прозрачный чёрный по умолчанию. Альфа 0 скрывает эту тень, но не отключает отдельные stacked-тени.

SetShadowOffsetvoid
# SetShadowOffset
C#
public void SetShadowOffset(Vector2 offset);

Смещение основной тени в локальных пикселях, (1, 1) по умолчанию. Не добавляет отступы в минимум Label; родительский clipping может обрезать эффект.

Параметры
ИмяТипПо умолчанию
offsetVector2—
offset

Смещение основной тени в локальных пикселях, (1, 1) по умолчанию. Не добавляет отступы в минимум Label; родительский clipping может обрезать эффект.

SetShadowSizevoid
# SetShadowSize
C#
public void SetShadowSize(int size);

Толщина расширенного контура основной тени в пикселях, 1 по умолчанию. Это не радиус размытия. При прозрачном ShadowColor основная тень не видна.

Параметры
ИмяТипПо умолчанию
sizeint—
size

Толщина расширенного контура основной тени в пикселях, 1 по умолчанию. Это не радиус размытия. При прозрачном ShadowColor основная тень не видна.

SetStackedOutlineColorvoid
# SetStackedOutlineColor
C#
public void SetStackedOutlineColor(int index, Color color);

Задаёт цвет существующей дополнительной обводки. Не меняет её толщину и основной OutlineColor.

Параметры
ИмяТипПо умолчанию
indexint—
colorColor—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

color

Задаёт цвет существующей дополнительной обводки. Не меняет её толщину и основной OutlineColor.

SetStackedOutlineCountvoid
# SetStackedOutlineCount
C#
public void SetStackedOutlineCount(int count);

Неотрицательное число дополнительных обводок. Рост добавляет Size = 0/чёрный цвет, уменьшение удаляет хвост. Это не число основных OutlineSize-обводок.

Параметры
ИмяТипПо умолчанию
countint—
count

Неотрицательное число дополнительных обводок. Рост добавляет Size = 0/чёрный цвет, уменьшение удаляет хвост. Это не число основных OutlineSize-обводок.

SetStackedOutlineSizevoid
# SetStackedOutlineSize
C#
public void SetStackedOutlineSize(int index, int size);

Задаёт добавочную толщину существующего слоя в пикселях. Положительные значения суммируются с основной и предыдущими обводками; ≤0 не рисуется. Используйте неотрицательную толщину.

Параметры
ИмяТипПо умолчанию
indexint—
sizeint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

size

Задаёт добавочную толщину существующего слоя в пикселях. Положительные значения суммируются с основной и предыдущими обводками; ≤0 не рисуется. Используйте неотрицательную толщину.

SetStackedShadowColorvoid
# SetStackedShadowColor
C#
public void SetStackedShadowColor(int index, Color color);

Задаёт цвет существующего слоя тени. Альфа 0 скрывает этот слой, не удаляя его и не меняя Count.

Параметры
ИмяТипПо умолчанию
indexint—
colorColor—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

color

Задаёт цвет существующего слоя тени. Альфа 0 скрывает этот слой, не удаляя его и не меняя Count.

SetStackedShadowCountvoid
# SetStackedShadowCount
C#
public void SetStackedShadowCount(int count);

Неотрицательное число дополнительных теней. Новые слои имеют Offset = (1, 1), непрозрачный чёрный цвет и OutlineSize = 0. Уменьшение уничтожает хвостовые слои.

Параметры
ИмяТипПо умолчанию
countint—
count

Неотрицательное число дополнительных теней. Новые слои имеют Offset = (1, 1), непрозрачный чёрный цвет и OutlineSize = 0. Уменьшение уничтожает хвостовые слои.

SetStackedShadowOffsetvoid
# SetStackedShadowOffset
C#
public void SetStackedShadowOffset(int index, Vector2 offset);

Задаёт локальное пиксельное смещение существующей тени. Это не движение Label или добавление layout-отступа.

Параметры
ИмяТипПо умолчанию
indexint—
offsetVector2—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

offset

Задаёт локальное пиксельное смещение существующей тени. Это не движение Label или добавление layout-отступа.

SetStackedShadowOutlineSizevoid
# SetStackedShadowOutlineSize
C#
public void SetStackedShadowOutlineSize(int index, int size);

Задаёт неотрицательную толщину контура существующей тени в пикселях. Это расширение её формы, не Gaussian blur. Setter не ограничивает само число.

Параметры
ИмяТипПо умолчанию
indexint—
sizeint—
index

Существующий индекс слоя с нуля, меньше соответствующего Count.

size

Задаёт неотрицательную толщину контура существующей тени в пикселях. Это расширение её формы, не Gaussian blur. Setter не ограничивает само число.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.