API Reference › EntitySystem
IEntitySystemService
InterfaceNamespace: SwiftlyS2.Shared.EntitySystem · Assembly: SwiftlyS2.CS2.dll
public interface IEntitySystemServiceMethods
Create an entity by class.
T CreateEntity<T>() where T : class, ISchemaClass<T>Returns
T
Created entity.
Exceptions
- ArgumentExceptionThrown when failed to create entity by class or class doesn't have a designer name.
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Create an entity by class.
T CreateEntity<T>(int forcedIndex) where T : class, ISchemaClass<T>Parameters
- forcedIndexintForced entity index.
Returns
T
Created entity.
Exceptions
- ArgumentExceptionThrown when failed to create entity by class or class doesn't have a designer name.
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Create an entity by designer name.
T CreateEntityByDesignerName<T>(string designerName) where T : class, ISchemaClass<T>Parameters
- designerNamestringDesigner name.
Returns
T
Created entity.
Exceptions
- ArgumentExceptionThrown when failed to create entity by designer name or designer name is invalid.
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Create an entity by designer name.
T CreateEntityByDesignerName<T>(string designerName, int forcedIndex) where T : class, ISchemaClass<T>Returns
T
Created entity.
Exceptions
- ArgumentExceptionThrown when failed to create entity by designer name or designer name is invalid.
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get all entities.
IEnumerable<CEntityInstance> GetAllEntities()Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get all entities by class.
IEnumerable<T> GetAllEntitiesByClass<T>() where T : class, ISchemaClass<T>Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get all entities by designer name, and cast to type T.
IEnumerable<T> GetAllEntitiesByDesignerName<T>(string designerName) where T : class, ISchemaClass<T>Parameters
- designerNamestringDesigner name.
Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get an entity by address.
T? GetEntityByAddress<T>(nint address) where T : class, ISchemaClass<T>Parameters
- addressnintEntity address.
Returns
T?
Entity by address. Nullable.
Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
- InvalidOperationExceptionThrown when the entity is not of type T.
Get an entity by address.
CEntityInstance? GetEntityByAddress(nint address)Parameters
- addressnintEntity address.
Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get an entity by index.
T? GetEntityByIndex<T>(uint index) where T : class, ISchemaClass<T>Parameters
- indexuintEntity index.
Returns
T?
Entity by index. Nullable.
Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
- InvalidOperationExceptionThrown when the entity is not of type T.
Get an entity by index. The object return will have the actual type of the entity. You can cast it to the actual type.
CEntityInstance? GetEntityByIndex(uint index)Parameters
- indexuintEntity index.
Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get the game rules entity.
CCSGameRules? GetGameRules()Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Get a reference handle to the entity.
CHandle<T> GetRefEHandle<T>(T entity) where T : class, ISchemaClass<T>Parameters
- entityTEntity instance.
Returns
CHandle<T>
Reference entity handle to the entity.
Exceptions
- InvalidOperationExceptionThrown when called too early that entity system is not valid at this moment.
Hooks an input of the specified entity type to a callback function.
Guid HookEntityInput<T>(string inputName, IEntitySystemService.EntityInputEventHandler callback) where T : class, ISchemaClass<T>Parameters
- inputNamestringThe name of the input to hook. This value cannot be null or empty.
- callbackIEntitySystemService.EntityInputEventHandlerThe callback function to invoke when the input is accepted. This value cannot be null .
Returns
A Guid that uniquely identifies the hook. This identifier can be used to remove the hook.
This method allows you to attach a handler to a specific input of an entity. The callback will be invoked whenever the input is accepted.
Hooks an input of the specified entity type to a callback function.
Guid HookEntityInput(string designerName, string inputName, IEntitySystemService.EntityInputEventHandler callback)Parameters
- designerNamestringThe designer name of the entity to hook. This value cannot be null or empty.
- inputNamestringThe name of the input to hook. This value cannot be null or empty.
- callbackIEntitySystemService.EntityInputEventHandlerThe callback function to invoke when the input is accepted. This value cannot be null .
Returns
A Guid that uniquely identifies the hook. This identifier can be used to remove the hook.
This method allows you to attach a handler to a specific input of an entity. The callback will be invoked whenever the input is accepted.
Hooks an output of the specified entity type to a callback function.
Guid HookEntityOutput<T>(string outputName, IEntitySystemService.EntityOutputEventHandler callback) where T : class, ISchemaClass<T>Parameters
- outputNamestringThe name of the output to hook. This value cannot be null or empty.
- callbackIEntitySystemService.EntityOutputEventHandlerThe callback function to invoke when the output is triggered. This value cannot be null .
Returns
A Guid that uniquely identifies the hook. This identifier can be used to remove the hook.
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.
Hooks an output of the specified entity type to a callback function.
Guid HookEntityOutput(string designerName, string outputName, IEntitySystemService.EntityOutputEventHandler callback)Parameters
- designerNamestringThe designer name of the entity to hook. This value cannot be null or empty.
- outputNamestringThe name of the output to hook. This value cannot be null or empty.
- callbackIEntitySystemService.EntityOutputEventHandlerThe callback function to invoke when the output is triggered. This value cannot be null .
Returns
A Guid that uniquely identifies the hook. This identifier can be used to remove the hook.
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.
Removes the association between the specified entity input and its handler.
bool UnhookEntityInput(Guid guid)Parameters
- guidGuidThe unique identifier of the entity input to unhook.