Skip to main content

Class: BaseService<TConfig = unknown, TParent extends IService | undefined = IService | undefined>

Defined in: base-service.ts:13

Extended by​

Type Parameters​

Type ParameterDefault type
TConfigunknown
TParent extends IService | undefinedIService | undefined

Implements​

Constructors​

Constructor​

new BaseService<TConfig = unknown, TParent extends IService | undefined = IService | undefined>(context: ServiceActivationContext<TConfig, TParent>): BaseService<TConfig, TParent>;

Defined in: base-service.ts:33

Parameters​

ParameterType
contextServiceActivationContext<TConfig, TParent>

Returns​

BaseService<TConfig, TParent>

Properties​

PropertyModifierTypeDescriptionDefined in
abortSignalreadonlyAbortSignal-base-service.ts:23
environmentreadonlyIEnvironmentDescriptor-base-service.ts:22
logEventreadonlyTelemetryLogEmit a telemetry record. Named logEvent rather than log because log is the name a service is most likely to have already claimed for its own logging helper, and an inherited member would break it. With no telemetry configured this is NO_OP_TELEMETRY_LOG.base-service.ts:31
managerreadonlyServiceManager-base-service.ts:20
schedulerreadonlyIScheduler-base-service.ts:21
serviceConfigreadonlyTConfig-base-service.ts:46
serviceNamereadonlystring-base-service.ts:44
servicePriorityreadonlynumber-base-service.ts:45

Accessors​

isDestroyed​

Get Signature​

get isDestroyed(): boolean;

Defined in: base-service.ts:59

Returns​

boolean

Implementation of​

IService.isDestroyed


isEnabled​

Get Signature​

get isEnabled(): boolean;

Defined in: base-service.ts:47

Returns​

boolean

Implementation of​

IService.isEnabled


isInitialized​

Get Signature​

get isInitialized(): boolean;

Defined in: base-service.ts:51

Returns​

boolean

Implementation of​

IService.isInitialized


isServiceRegistered​

Get Signature​

get isServiceRegistered(): boolean;

Defined in: base-service.ts:63

Returns​

boolean

Implementation of​

IService.isServiceRegistered


isStarted​

Get Signature​

get isStarted(): boolean;

Defined in: base-service.ts:55

Returns​

boolean

Implementation of​

IService.isStarted


serviceModules​

Get Signature​

get serviceModules(): readonly IServiceModule<IService>[];

Defined in: base-service.ts:67

Returns​

readonly IServiceModule<IService>[]

Implementation of​

IService.serviceModules

Methods​

_setDestroyedState()​

_setDestroyedState(isDestroyed: boolean): void;

Defined in: base-service.ts:157

Parameters​

ParameterType
isDestroyedboolean

Returns​

void


_setInitializedState()​

_setInitializedState(isInitialized: boolean): void;

Defined in: base-service.ts:149

Parameters​

ParameterType
isInitializedboolean

Returns​

void


_setRegistrationState()​

_setRegistrationState(isRegistered: boolean): void;

Defined in: base-service.ts:145

Parameters​

ParameterType
isRegisteredboolean

Returns​

void


_setStartedState()​

_setStartedState(isStarted: boolean): void;

Defined in: base-service.ts:153

Parameters​

ParameterType
isStartedboolean

Returns​

void


destroy()​

destroy(): void;

Defined in: base-service.ts:85

Returns​

void

Implementation of​

IService.destroy


Destroy()​

Destroy(): void;

Defined in: base-service.ts:133

Returns​

void


fixedUpdate()​

fixedUpdate(_context: LifecycleContext): void;

Defined in: base-service.ts:81

Parameters​

ParameterType
_contextLifecycleContext

Returns​

void

Implementation of​

IService.fixedUpdate


FixedUpdate()​

FixedUpdate(context: LifecycleContext): void;

Defined in: base-service.ts:125

Parameters​

ParameterType
contextLifecycleContext

Returns​

void


initialize()​

initialize(): void;

Defined in: base-service.ts:71

Returns​

void

Implementation of​

IService.initialize


Initialize()​

Initialize(): void;

Defined in: base-service.ts:105

Returns​

void


lateUpdate()​

lateUpdate(_context: LifecycleContext): void;

Defined in: base-service.ts:79

Parameters​

ParameterType
_contextLifecycleContext

Returns​

void

Implementation of​

IService.lateUpdate


LateUpdate()​

LateUpdate(context: LifecycleContext): void;

Defined in: base-service.ts:121

Parameters​

ParameterType
contextLifecycleContext

Returns​

void


onFocusChange()​

onFocusChange(_context: FocusChangeContext): void;

Defined in: base-service.ts:87

Parameters​

ParameterType
_contextFocusChangeContext

Returns​

void

Implementation of​

IService.onFocusChange


OnFocusChange()​

OnFocusChange(context: FocusChangeContext): void;

Defined in: base-service.ts:137

Parameters​

ParameterType
contextFocusChangeContext

Returns​

void


onPauseChange()​

onPauseChange(_context: {
paused: boolean;
}): void;

Defined in: base-service.ts:89

Parameters​

ParameterType
_context{ paused: boolean; }
_context.pausedboolean

Returns​

void

Implementation of​

IService.onPauseChange


OnPauseChange()​

OnPauseChange(context: {
paused: boolean;
}): void;

Defined in: base-service.ts:141

Parameters​

ParameterType
context{ paused: boolean; }
context.pausedboolean

Returns​

void


registerServiceModule()​

registerServiceModule(serviceModule: IServiceModule): void;

Defined in: base-service.ts:91

Parameters​

ParameterType
serviceModuleIServiceModule

Returns​

void

Implementation of​

IService.registerServiceModule


render()​

render(_context: LifecycleContext): void;

Defined in: base-service.ts:83

Parameters​

ParameterType
_contextLifecycleContext

Returns​

void

Implementation of​

IService.render


Render()​

Render(context: LifecycleContext): void;

Defined in: base-service.ts:129

Parameters​

ParameterType
contextLifecycleContext

Returns​

void


reset()​

reset(): void;

Defined in: base-service.ts:75

Returns​

void

Implementation of​

IService.reset


Reset()​

Reset(): void;

Defined in: base-service.ts:113

Returns​

void


start()​

start(): void;

Defined in: base-service.ts:73

Returns​

void

Implementation of​

IService.start


Start()​

Start(): void;

Defined in: base-service.ts:109

Returns​

void


unregisterServiceModule()​

unregisterServiceModule(serviceModule: IServiceModule): void;

Defined in: base-service.ts:97

Parameters​

ParameterType
serviceModuleIServiceModule

Returns​

void

Implementation of​

IService.unregisterServiceModule


update()​

update(_context: LifecycleContext): void;

Defined in: base-service.ts:77

Parameters​

ParameterType
_contextLifecycleContext

Returns​

void

Implementation of​

IService.update


Update()​

Update(context: LifecycleContext): void;

Defined in: base-service.ts:117

Parameters​

ParameterType
contextLifecycleContext

Returns​

void