Interface IEntitySystemService

Namespace: SwiftlyS2.Shared.EntitySystem

Assembly: SwiftlyS2.CS2.dll

public interface IEntitySystemService

Methods

CreateEntity<T>()

Create an entity by class.

T CreateEntity<T>() where T : class, ISchemaClass<T>

• T — Created entity.

• T — Entity type.

• ArgumentException — Thrown when failed to create entity by class or class doesn't have a designer name.

CreateEntityByDesignerName<T>(string)

Create an entity by designer name.

T CreateEntityByDesignerName<T>(string designerName) where T : ISchemaClass<T>

• designerName string — Designer name.

• T — Created entity.

• T — Entity type.

• ArgumentException — Thrown when failed to create entity by designer name or designer name is invalid.

GetAllEntities()

Get all entities.

IEnumerable<CEntityInstance> GetAllEntities()

• IEnumerable<CEntityInstance> — All entities.

GetAllEntitiesByClass<T>()

Get all entities by class.

IEnumerable<T> GetAllEntitiesByClass<T>() where T : class, ISchemaClass<T>

• IEnumerable<T> — All entities by class.

• T — Entity type.

GetAllEntitiesByDesignerName<T>(string)

Get all entities by designer name, and cast to type T.

IEnumerable<T> GetAllEntitiesByDesignerName<T>(string designerName) where T : class, ISchemaClass<T>

• designerName string — Designer name.

• IEnumerable<T> — All entities by designer name.

• T — Entity type.

GetEntityByIndex<T>(uint)

Get an entity by index.

T? GetEntityByIndex<T>(uint index) where T : class, ISchemaClass<T>

• index uint — Entity index.

• T? — Entity by index. Nullable.

• T — Entity type.

GetGameRules()

Get the game rules entity.

CCSGameRules? GetGameRules()

• CCSGameRules? — Game rules entity. Nullable.

GetRefEHandle<T>(T)

Get a reference handle to the entity.

CHandle<T> GetRefEHandle<T>(T entity) where T : class, ISchemaClass<T>

• entity T — Entity instance.

• CHandle<T> — Reference entity handle to the entity.

• T — Entity type.

HookEntityOutput<T>(string, EntityOutputHandler)

Hooks an output of the specified entity type to a callback function.

Guid HookEntityOutput<T>(string outputName, IEntitySystemService.EntityOutputHandler callback) where T : class, ISchemaClass<T>

• outputName string — The name of the output to hook. This value cannot be null or empty.
• callback IEntitySystemService.EntityOutputHandler — The callback function to invoke when the output is triggered. This value cannot be null.

• Guid — A System.Guid that uniquely identifies the hook. This identifier can be used to manage or remove the hook.

• T — The type of the entity, which must implement SwiftlyS2.Shared.Schemas.ISchemaClass%601.

This method allows you to attach a handler to a specific output of an entity. The callback will be invoked whenever the output is triggered.

UnhookEntityOutput(Guid)

Removes the association between the specified entity output and its handler.

void UnhookEntityOutput(Guid guid)

• guid Guid — The unique identifier of the entity output to unhook.