Interface IEntityToolVisuals

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

What a tool draws for entities beyond what the game shows: a stand-in for an entity with nothing of its own to draw, and nodes relating entities to each other. The renderer only draws what the game does, and leaves the rest to whoever sets EntitySystem.ToolVisuals.

public interface IEntityToolVisuals

Methods

AddEntityRelations(Scene, IReadOnlyList<BaseEntity>)

Adds nodes relating the entities a world spawned into a scene, once all of them have spawned.

void AddEntityRelations(Scene scene, IReadOnlyList<BaseEntity> entities)

Parameters

scene Scene

The scene they spawned into.

entities IReadOnlyList<BaseEntity>

The spawned entities.

CreateStandIn(BaseEntity, ObjectTypeFlags)

Builds the stand-in drawn for an entity that has nothing of its own to draw. It is not added to the scene: the entity owns and places it.

SceneNode? CreateStandIn(BaseEntity entity, ObjectTypeFlags flags)

Parameters

entity BaseEntity

The entity.

flags ObjectTypeFlags

Flags for the node.

Returns

SceneNode?

The node, or null to draw nothing.

GetResourcesToPreload(string)

Gets the resources the stand-in for an entity of a class loads, so a world can load them alongside its own.

IEnumerable<string> GetResourcesToPreload(string classname)

Parameters

classname string

The entity classname.

Returns

IEnumerable<string>

The resource names.