Class EntityClass

Namespace: ValveResourceFormat.Renderer.Editor.Entities
Assembly: Renderer.dll

An entity class as the editor shows it: the helpers it is drawn with.

public sealed class EntityClass

Inheritance

object ← EntityClass

Properties

AutoApplyMaterial

Gets the material the meshes of an entity of the class are drawn with in place of the ones of their faces, or null where they are drawn with their own.

public string? AutoApplyMaterial { get; init; }

Property Value

string?

BaseClasses

Gets the names of the classes the class is based on, directly or through others, of the ones a class of its game requires to be placed under.

public IReadOnlySet<string> BaseClasses { get; init; }

Property Value

IReadOnlySet<string>

Helpers

Gets the helpers the class is drawn with, in order: the ones it declares, and then one for each of its keys that is drawn, which is given the name of the key.

public IReadOnlyList<HelperDeclaration> Helpers { get; init; }

Property Value

IReadOnlyList<HelperDeclaration>

Kind

Gets what an entity of the class is.

public EntityClassKind Kind { get; init; }

Property Value

EntityClassKind

Name

Gets the name of the class.

public required string Name { get; init; }

Property Value

string

PreviewAnimationKeys

Gets the keys that name the animation the model of an entity of the class plays, the one that matters most first. The first of them an entity sets is the one played.

public IReadOnlyList<string> PreviewAnimationKeys { get; init; }

Property Value

IReadOnlyList<string>

RequiredParentClass

Gets the class an entity of the class has to be placed under, or null where it can be placed anywhere.

public string? RequiredParentClass { get; init; }

Property Value

string?

Size

Gets the box the class declares entities are drawn as, or null where it declares none.

public (Vector3 Mins, Vector3 Maxs)? Size { get; init; }

Property Value

(Vector3 Mins, Vector3 Maxs)?

Methods

DerivesFrom(string)

Gets whether the class is the one of a name, or is based on it. Only the classes a class of its game requires to be placed under are known to be based on.

public bool DerivesFrom(string name)

Parameters

name string

Name of the class.

Returns

bool

Whether it is.