Class PaperVisualsComponent

Inheritance
System.Object
PaperVisualsComponent
Namespace: Content.Client.Paper
Assembly: Content.Client.dll
Syntax
public sealed class PaperVisualsComponent : Component

Fields

| Improve this Doc View Source

BackgroundImagePath

The path to the image which will be used as a background for the paper itself

Declaration
public string? BackgroundImagePath
Field Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

BackgroundImageTile

Should the background image tile, or be streched? Sets 

StyleBoxTexture.StrechMode

Declaration
public bool BackgroundImageTile
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

BackgroundModulate

Modulate the background image by this color. Can be used to add colorful variants of images, without having to create new textures.

Declaration
public Color BackgroundModulate
Field Value
Type Description
Color
| Improve this Doc View Source

BackgroundPatchMargin

An optional patch to configure tiling stretching of the background. Used to set the PatchMargin in a 

StyleBoxTexture

Declaration
public Box2 BackgroundPatchMargin
Field Value
Type Description
Box2
| Improve this Doc View Source

BackgroundScale

An additional scale to apply to the background image

Declaration
public Vector2 BackgroundScale
Field Value
Type Description
Vector2
| Improve this Doc View Source

ContentImageModulate

Modulate the content image by this color

Declaration
public Color ContentImageModulate
Field Value
Type Description
Color
| Improve this Doc View Source

ContentImageNumLines

The number of lines that the content image represents. The content image will be vertically tiled after this many lines of text.

Declaration
public int ContentImageNumLines
Field Value
Type Description
System.Int32
| Improve this Doc View Source

ContentImagePath

Path to an image to use as the background to the "content" of the paper The header and actual written text will use this as a background. The image will be tiled vertically with the property that the bottom of the written text will line up with the bottom of this image.

Declaration
public string? ContentImagePath
Field Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

ContentMargin

An additional margin around the content (including header)

Declaration
public Box2 ContentMargin
Field Value
Type Description
Box2
| Improve this Doc View Source

FontAccentColor

Modulate the style's font by this color

Declaration
public Color FontAccentColor
Field Value
Type Description
Color
| Improve this Doc View Source

HeaderImageModulate

Modulate the header image by this color

Declaration
public Color HeaderImageModulate
Field Value
Type Description
Color
| Improve this Doc View Source

HeaderImagePath

A path to an image which will be used as a header on the paper

Declaration
public string? HeaderImagePath
Field Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

HeaderMargin

Any additional margin to add around the header

Declaration
public Box2 HeaderMargin
Field Value
Type Description
Box2
| Improve this Doc View Source

MaxWritableArea

This can enforce that your paper has a limited area to write in. If you wish to constrain only one direction, the other direction can be unlimited by specifying a value of zero. This will be scaled according to UI scale.

Declaration
public Vector2? MaxWritableArea
Field Value
Type Description
System.Nullable<Vector2>