100 lines
3.4 KiB
C#
100 lines
3.4 KiB
C#
namespace Content.Client.Paper;
|
|
|
|
[RegisterComponent]
|
|
public sealed class PaperVisualsComponent : Component
|
|
{
|
|
/// <summary>
|
|
/// The path to the image which will be used as a background for the paper itself
|
|
/// </summary>
|
|
[DataField("backgroundImagePath")]
|
|
public string? BackgroundImagePath;
|
|
|
|
/// <summary>
|
|
/// An optional patch to configure tiling stretching of the background. Used to set
|
|
/// the PatchMargin in a <code>StyleBoxTexture</code>
|
|
/// </summary>
|
|
[DataField("backgroundPatchMargin")]
|
|
public Box2 BackgroundPatchMargin = default;
|
|
|
|
/// <summary>
|
|
/// Modulate the background image by this color. Can be used to add colorful
|
|
/// variants of images, without having to create new textures.
|
|
/// </summary>
|
|
[DataField("backgroundModulate")]
|
|
public Color BackgroundModulate = Color.White;
|
|
|
|
/// <summary>
|
|
/// Should the background image tile, or be streched? Sets <code>StyleBoxTexture.StrechMode</code>
|
|
/// </summary>
|
|
[DataField("backgroundImageTile")]
|
|
public bool BackgroundImageTile = false;
|
|
|
|
/// <summary>
|
|
/// An additional scale to apply to the background image
|
|
/// </summary>
|
|
[DataField("backgroundScale")]
|
|
public Vector2 BackgroundScale = Vector2.One;
|
|
|
|
/// <summary>
|
|
/// A path to an image which will be used as a header on the paper
|
|
/// </summary>
|
|
[DataField("headerImagePath")]
|
|
public string? HeaderImagePath;
|
|
|
|
/// <summary>
|
|
/// Modulate the header image by this color
|
|
/// </summary>
|
|
[DataField("headerImageModulate")]
|
|
public Color HeaderImageModulate = Color.White;
|
|
|
|
/// <summary>
|
|
/// Any additional margin to add around the header
|
|
/// </summary>
|
|
[DataField("headerMargin")]
|
|
public Box2 HeaderMargin = default;
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
[DataField("contentImagePath")]
|
|
public string? ContentImagePath;
|
|
|
|
/// <summary>
|
|
/// Modulate the content image by this color
|
|
/// </summary>
|
|
[DataField("contentImageModulate")]
|
|
public Color ContentImageModulate = Color.White;
|
|
|
|
/// <summary>
|
|
/// An additional margin around the content (including header)
|
|
/// </summary>
|
|
[DataField("contentMargin")]
|
|
public Box2 ContentMargin = default;
|
|
|
|
/// <summary>
|
|
/// The number of lines that the content image represents. The
|
|
/// content image will be vertically tiled after this many lines
|
|
/// of text.
|
|
/// </summary>
|
|
[DataField("contentImageNumLines")]
|
|
public int ContentImageNumLines = 1;
|
|
|
|
/// <summary>
|
|
/// Modulate the style's font by this color
|
|
/// </summary>
|
|
[DataField("fontAccentColor")]
|
|
public Color FontAccentColor = new Color(0x25, 0x25, 0x2a);
|
|
|
|
/// <summary>
|
|
/// 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.
|
|
/// </summary>
|
|
[DataField("maxWritableArea")]
|
|
public Vector2? MaxWritableArea = null;
|
|
}
|