Table of Contents

Class EntityBehaviorWritingSurface

Namespace
Vintagestory.GameContent
Assembly
VSSurvivalMod.dll

Adds writeable surface to entity.
Uses the "writingsurface" code Open in GitHub

[DocumentAsJson]
[AddDocumentationProperty("pigment", "Use on a collectible type. If set and the collectible is used to write on a writing surface with this behavior, its pigment color will be used for text color.", "Vintagestory.API.Datastructures.JsonObject", "Optional", "None", true)]
public class EntityBehaviorWritingSurface : EntityBehavior
Inheritance
EntityBehaviorWritingSurface

Examples

"behaviors": [
 "writingsurface": {
    "fontConfig": {
        "maxWidth": 208,
        "maxHeight": 96,
        "fontSize": 20,
        "textVoxelOffsetY": -1,
        "textVoxelOffsetZ": 0.25,
        "textVoxelHeight": 6,
        "fontName": "Almendra",
        "verticalAlign": "Middle",
        "boldFont": true
    },
    "writingSurfaces": [ "LPlaqueAP", "RPlaqueAP" ]
 },
],

Inside a collectible used as a pigment...

"attributes": {
    "pigment": {
        "name": "Carbon black",
        "color": { "red": 25, "green": 24, "blue": 22 }
    }
    ...
},

Fields

FontConfig (Required)

Font settings of writeable surface, such as text position, font type and others

[DocumentAsJson("Required", "", false)]
protected TextAreaConfig signTextConfig

Field Value

TextAreaConfig

writingSurfaces (Required)

A list of shape element codes that can be written on.

[DocumentAsJson("Required", "", false)]
protected string[] writingSurfaces

Field Value

string[]

Properties

pigment (Optional) (Default: None)

Use on a collectible type. If set and the collectible is used to write on a writing surface with this behavior, its pigment color will be used for text color.

Property Value

JsonObject