Class: BaseService<TConfig = unknown, TParent extends IService | undefined = IService | undefined>
Defined in: base-service.ts:13
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
TConfig | unknown |
TParent extends IService | undefined | IService | 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
| Parameter | Type |
|---|---|
context | ServiceActivationContext<TConfig, TParent> |
Returns
BaseService<TConfig, TParent>
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
abortSignal | readonly | AbortSignal | - | base-service.ts:23 |
environment | readonly | IEnvironmentDescriptor | - | base-service.ts:22 |
logEvent | readonly | TelemetryLog | Emit 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 |
manager | readonly | ServiceManager | - | base-service.ts:20 |
scheduler | readonly | IScheduler | - | base-service.ts:21 |
serviceConfig | readonly | TConfig | - | base-service.ts:46 |
serviceName | readonly | string | - | base-service.ts:44 |
servicePriority | readonly | number | - | base-service.ts:45 |
Accessors
isDestroyed
Get Signature
get isDestroyed(): boolean;
Defined in: base-service.ts:59
Returns
boolean
Implementation of
isEnabled
Get Signature
get isEnabled(): boolean;
Defined in: base-service.ts:47
Returns
boolean
Implementation of
isInitialized
Get Signature
get isInitialized(): boolean;
Defined in: base-service.ts:51
Returns
boolean
Implementation of
isServiceRegistered
Get Signature
get isServiceRegistered(): boolean;
Defined in: base-service.ts:63
Returns
boolean
Implementation of
isStarted
Get Signature
get isStarted(): boolean;
Defined in: base-service.ts:55
Returns
boolean
Implementation of
serviceModules
Get Signature
get serviceModules(): readonly IServiceModule<IService>[];
Defined in: base-service.ts:67
Returns
readonly IServiceModule<IService>[]
Implementation of
Methods
_setDestroyedState()
_setDestroyedState(isDestroyed: boolean): void;
Defined in: base-service.ts:157
Parameters
| Parameter | Type |
|---|---|
isDestroyed | boolean |
Returns
void
_setInitializedState()
_setInitializedState(isInitialized: boolean): void;
Defined in: base-service.ts:149
Parameters
| Parameter | Type |
|---|---|
isInitialized | boolean |
Returns
void
_setRegistrationState()
_setRegistrationState(isRegistered: boolean): void;
Defined in: base-service.ts:145
Parameters
| Parameter | Type |
|---|---|
isRegistered | boolean |
Returns
void
_setStartedState()
_setStartedState(isStarted: boolean): void;
Defined in: base-service.ts:153
Parameters
| Parameter | Type |
|---|---|
isStarted | boolean |
Returns
void
destroy()
destroy(): void;
Defined in: base-service.ts:85
Returns
void
Implementation of
Destroy()
Destroy(): void;
Defined in: base-service.ts:133
Returns
void
fixedUpdate()
fixedUpdate(_context: LifecycleContext): void;
Defined in: base-service.ts:81
Parameters
| Parameter | Type |
|---|---|
_context | LifecycleContext |
Returns
void
Implementation of
FixedUpdate()
FixedUpdate(context: LifecycleContext): void;
Defined in: base-service.ts:125
Parameters
| Parameter | Type |
|---|---|
context | LifecycleContext |
Returns
void
initialize()
initialize(): void;
Defined in: base-service.ts:71
Returns
void
Implementation of
Initialize()
Initialize(): void;
Defined in: base-service.ts:105
Returns
void
lateUpdate()
lateUpdate(_context: LifecycleContext): void;
Defined in: base-service.ts:79
Parameters
| Parameter | Type |
|---|---|
_context | LifecycleContext |
Returns
void
Implementation of
LateUpdate()
LateUpdate(context: LifecycleContext): void;
Defined in: base-service.ts:121
Parameters
| Parameter | Type |
|---|---|
context | LifecycleContext |
Returns
void
onFocusChange()
onFocusChange(_context: FocusChangeContext): void;
Defined in: base-service.ts:87
Parameters
| Parameter | Type |
|---|---|
_context | FocusChangeContext |
Returns
void
Implementation of
OnFocusChange()
OnFocusChange(context: FocusChangeContext): void;
Defined in: base-service.ts:137
Parameters
| Parameter | Type |
|---|---|
context | FocusChangeContext |
Returns
void
onPauseChange()
onPauseChange(_context: {
paused: boolean;
}): void;
Defined in: base-service.ts:89
Parameters
| Parameter | Type |
|---|---|
_context | { paused: boolean; } |
_context.paused | boolean |
Returns
void
Implementation of
OnPauseChange()
OnPauseChange(context: {
paused: boolean;
}): void;
Defined in: base-service.ts:141
Parameters
| Parameter | Type |
|---|---|
context | { paused: boolean; } |
context.paused | boolean |
Returns
void
registerServiceModule()
registerServiceModule(serviceModule: IServiceModule): void;
Defined in: base-service.ts:91
Parameters
| Parameter | Type |
|---|---|
serviceModule | IServiceModule |
Returns
void
Implementation of
IService.registerServiceModule
render()
render(_context: LifecycleContext): void;
Defined in: base-service.ts:83
Parameters
| Parameter | Type |
|---|---|
_context | LifecycleContext |
Returns
void
Implementation of
Render()
Render(context: LifecycleContext): void;
Defined in: base-service.ts:129
Parameters
| Parameter | Type |
|---|---|
context | LifecycleContext |
Returns
void
reset()
reset(): void;
Defined in: base-service.ts:75
Returns
void
Implementation of
Reset()
Reset(): void;
Defined in: base-service.ts:113
Returns
void
start()
start(): void;
Defined in: base-service.ts:73
Returns
void
Implementation of
Start()
Start(): void;
Defined in: base-service.ts:109
Returns
void
unregisterServiceModule()
unregisterServiceModule(serviceModule: IServiceModule): void;
Defined in: base-service.ts:97
Parameters
| Parameter | Type |
|---|---|
serviceModule | IServiceModule |
Returns
void
Implementation of
IService.unregisterServiceModule
update()
update(_context: LifecycleContext): void;
Defined in: base-service.ts:77
Parameters
| Parameter | Type |
|---|---|
_context | LifecycleContext |
Returns
void
Implementation of
Update()
Update(context: LifecycleContext): void;
Defined in: base-service.ts:117
Parameters
| Parameter | Type |
|---|---|
context | LifecycleContext |
Returns
void