TextRendererclass

Renders text in the world

objectRendererTextRenderer
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.TextRenderer : Sandbox.Renderer

Constructors1

Showing 1 constructors

Properties13

Showing 13 properties

public Sandbox.BlendMode Sandbox.TextRenderer.BlendMode { get; set; }PUBLICGETSET

The blend mode of the text. This determines how the text is rendered over the world.

Returns:BlendMode

public virtual int Sandbox.TextRenderer.ComponentVersion { get; set; }PUBLICVIRTUALGETSET

Returns:int

public float Sandbox.TextRenderer.FogStrength { get; set; }PUBLICGETSET

The strength of the fog effect applied to the text. This determines how much the text blends with any fog in the scene.

Returns:float

public string Sandbox.TextRenderer.FontFamily { get; set; }PUBLICGETSET

Returns:string

public float Sandbox.TextRenderer.FontSize { get; set; }PUBLICGETSET

The font size of the text from the TextScope. This is different from the Scale, which determines how large the text appears in the world.

Returns:float

public int Sandbox.TextRenderer.FontWeight { get; set; }PUBLICGETSET

Returns:int

public Sandbox.TextRenderer.HAlignment Sandbox.TextRenderer.HorizontalAlignment { get; set; }PUBLICGETSET

The horizontal alignment of the text in the world.

Returns:HAlignment

public float Sandbox.TextRenderer.Scale { get; set; }PUBLICGETSET

The size of the text in the world. This is different from the font size, which is defined in the TextScope and determines resolution of the rendered text.

Returns:float

public string Sandbox.TextRenderer.Text { get; set; }PUBLICGETSET

Returns:string

public Sandbox.TextRendering.Scope Sandbox.TextRenderer.TextScope { get; set; }PUBLICGETSET

The text scope defines what text to render and it's visual properties (such as font, color, outline, etc.)

Returns:Scope

public Sandbox.TextRenderer.VAlignment Sandbox.TextRenderer.VerticalAlignment { get; set; }PUBLICGETSET

The vertical alignment of the text in the world.

Returns:VAlignment

On this page