Table of Contents

Namespace SampSharp.Entities

Classes

Component

Represents a component which can be attached to an entity.

ComponentExtension

Represents an extension to an open.mp component which binds its lifetime to the lifetime of an Component.

DisposableSystem

Represents a base type for systems that contain disposable objects.

EcsBuilderEventScopeExtensions

Provides extended functionality for configuring a IEcsBuilder instance.

EcsBuilderUseMiddlewareExtensions

Provides extended functionality for configuring a IEcsBuilder instance.

EventAttribute

Indicates a method is to be invoked when an event occurs.

EventContext

Contains context information about a fired event.

EventParameterAttribute

Indicates that the class should be handled as a parameter for an event instead of as an injectable service.

EventScopeMiddleware

Represents a middleware which adds a Dependency Injection scope to the EventContext of an event.

GtaVector

Provides various default vector constants for GTA: San Andreas.

MathHelper

Contains commonly used pre-calculated values and mathematical operations.

MethodInvokerFactory

Provides a compiler for an invoke method for an instance method with injected dependencies and entity-to-component conversion.

MethodParameterSource

Provides information about the origin of a parameter of a method.

MethodResult

Boxed boolean event-handler return value. SampSharp.Entities.EventDispatcher's invokers convert bool-returning handlers to MethodResult so the dispatcher can distinguish "explicit false" from "no handler ran" (which is null). Public so middlewares can interpret the truthiness of an upstream result.

SafeComponentHandle<T>

Provides a safe pointer to an open.mp component of type T.

SafeEventHandlerSampSharpEnvironmentExtensions

Provides extension methods for safely adding event handlers to components within a SampSharpEnvironment.

SampSharpEnvironment

Represents the environment of a SampSharp application, providing access to the entry assembly, game server core, and registered components.

ServiceCollectionSystemExtensions

Extension methods for adding systems to an IServiceCollection.

StartupContextEcsExtensions

Contains extension methods for IStartupContext to configure the ECS system.

SystemRegistryException

Represents an error which occurs while registering a system.

TimerAttribute

An attribute which indicates the method should be invoked at a specified interval.

TimerReference

Represents a reference to an interval or timeout.

TimerServiceExtensions

Provides extended methods for ITimerService.

Structs

EntityId

Represents an identifier of an entity.

Interfaces

IEcsBuilder

Provides functionality for configuring the SampSharp Entity Component System.

IEcsHostBuilder

Defines methods for configuring the Entity Component System (ECS) framework, including systems, services, logging, exception handling, and service provider factories.

IEcsStartup

Provides methods for configuring an Entity Component System in SampSharp.

IEntityManager

Provides functionality for the creation, modification and destruction of entities.

IEventDispatcher

Provides functionality for handling events.

IEventService

Provides functionality for handling events.

ISafeComponentHandleProvider

Provides handles to open.mp components which are automatically cleared when the component is freed. This allows for safe access to components without risking access to freed components, which can lead to crashes or undefined behavior.

ISystem

Represents a marker interface for systems. All systems must implement this interface.

ISystemRegistry

Provides the functionality for a registry of system types.

ITickingSystem

Contains methods which can be implemented by systems which handle server ticks.

ITimerService

Provides methods for starting and stopping timers.

IUnhandledExceptionHandler

Provides a handler for logging unhandled exceptions that occur during runtime.

Delegates

EventDelegate

Invokes the next event handler with the specified event context.

MethodInvoker

Invoker for an instance method with dependency injection.

UnhandledExceptionHandler

Represents a method that handles an unhandled exception occurred within SampSharp.OpenMp.Entities.