Class Text

Namespace

Exiled.API.Features.Toys

Assembly

Exiled.API.dll

A wrapper class for AdminToys.TextToy.

public class Text : AdminToy, IWorldSpace, IPosition, IRotation, IWrapper<TextToy>

Inheritance

object

AdminToy

Text

Implements

IWorldSpace

IPosition

IRotation

IWrapper<TextToy>

Inherited Members

AdminToy.List

AdminToy.AdminToyBase

AdminToy.ToyType

AdminToy.Player

AdminToy.Footprint

AdminToy.Position

AdminToy.Rotation

AdminToy.Scale

AdminToy.GameObject

AdminToy.Transform

AdminToy.MovementSmoothing

AdminToy.IsStatic

AdminToy.Get(AdminToyBase)

AdminToy.Get<T>(AdminToyBase)

AdminToy.Spawn()

AdminToy.UnSpawn()

AdminToy.Destroy()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.ReferenceEquals(object, object)

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Base

Gets the base AdminToys.TextToy.

public TextToy Base { get; }

Property Value

TextToy

DisplaySize

Gets or sets the size of the Display Size of the Text.

public Vector2 DisplaySize { get; set; }

Property Value

Vector2

Prefab

Gets the prefab.

public static TextToy Prefab { get; }

Property Value

TextToy

TextFormat

Gets or sets the Text shown.

public string TextFormat { get; set; }

Property Value

string

Methods

Create(Vector3?, Quaternion?, Vector3?, string, Vector2?, Transform, bool)

Creates a new Text.

public static Text Create(Vector3? position = null, Quaternion? rotation = null, Vector3? scale = null, string text = "Default Text", Vector2? displaySize = null, Transform parent = null, bool spawn = true)

Parameters

position Vector3?

The local position of the Text.

rotation Quaternion?

The local rotation of the Text.

scale Vector3?

The local scale of the Text.

text string

The text content to display.

displaySize Vector2?

The display size of the text.

parent Transform

The transform to create this Text on.

spawn bool

Whether the Text should be initially spawned.

Returns

Text

The new Text.

Create(Transform, string)

Creates a new Text based on a Transform.

public static Text Create(Transform transform, string text)

Parameters

transform Transform

The transform to spawn at.

text string

The text content to display.

Returns

Text

The new Text.

Create(Transform, string, Vector2)

Creates a new Text based on a Transform with custom size.

public static Text Create(Transform transform, string text, Vector2 displaySize)

Parameters

transform Transform

The transform to spawn at.

text string

The text content to display.

displaySize Vector2

The display size of the text.

Returns

Text

The new Text.

Create(Vector3, string)

Creates a new Text at the specified position.

public static Text Create(Vector3 position, string text)

Parameters

position Vector3

The local position of the Text.

text string

The text content to display.

Returns

Text

The new Text.

Create(Vector3, string, Vector2)

Creates a new Text with a specific position, text, and display size.

public static Text Create(Vector3 position, string text, Vector2 displaySize)

Parameters

position Vector3

The local position of the Text.

text string

The text content to display.

displaySize Vector2

The display size of the text.

Returns

Text

The new Text.