SusBrandLockup

Brand lockup for a title or lobby screen — optional image mark, a ruled word line, and kicker, tagline and sub lines; stacked or row layout, compact mode.

Package

SusGame · Screens (commercial)

Open in Playground

SusGame · Screens

Props

Name	Type	Default
`Mark`	`Prop<Texture2D>`	`null`
`MarkImage`	`Prop<Background>`	`default(Background)`
`Word`	`Prop<string>`	`""`
`Kicker`	`Prop<string>`	`""`
`Tagline`	`Prop<string>`	`""`
`Sub`	`Prop<string>`	`""`
`Layout`	`Prop<string>`	`"stacked"`
`Compact`	`Prop<bool>`	`false`

Slots

No slots.

Events

No public events.

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

sus-brand
sus-brand__kicker
sus-brand__mark
sus-brand__mark--empty
sus-brand__rule
sus-brand__rule--end
sus-brand__rule--start
sus-brand__rule-row
sus-brand__sub
sus-brand__tagline
sus-brand__word
sus-brand--compact
sus-brand--row
sus-brand--stacked
sus-hidden

Usage

xml

<sus:SusBrandLockup />

Mark

The optional image next to the wordmark (above it, or beside it in the row variant) comes from one of three sources, in this order:

MarkImage — any UI Toolkit background kind, built with Background.FromTexture2D, FromSprite, FromVectorImage or FromRenderTexture.
Mark — a plain Texture2D, kept for compatibility. MarkImage wins when both are set.
The skin's style. When both props are empty, the mark element carries the state class sus-brand__mark--empty, which the component's own sheet hides. A skin shows its mark with a rule under its skin class — no code.

Mark from code:

csharp

lockup.MarkImage.Value = Background.FromSprite(logoSprite);

Mark from the skin's style:

css

.myskin-skin .sus-brand__mark--empty {
    display: flex;
    background-image: resource("MySkin/mark");
}

The skin-class prefix is what lets this rule win from the skin root — see SusSkin: How brand rules win. A skin that uses the component layer can drop the prefix. With no such rule, an empty mark stays hidden: no placeholder box.

SusBrandLockup ​