Abstract Class: SnapshotService<TConfig, TSnapshot>

Defined in: service-framework/src/snapshot-service.ts:22

The runtime-adapter contract, the snapshot service base and the headless mock moved into @realitycollective/service-framework in 1.0.1: none of them ever touched IWSDK, and every host binding needs them. They are re-exported here unchanged so existing imports from this package keep working.

Extends

• BaseService<TConfig>

Type Parameters

Type Parameter
TConfig
TSnapshot

Constructors

Constructor

protected new SnapshotService<TConfig, TSnapshot>(context: ServiceActivationContext<TConfig>, initialSnapshot: TSnapshot): SnapshotService<TConfig, TSnapshot>;

Defined in: service-framework/src/snapshot-service.ts:26

Parameters

Parameter	Type
context	ServiceActivationContext<TConfig>
initialSnapshot	TSnapshot

Returns

SnapshotService<TConfig, TSnapshot>

Overrides

BaseService.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
abortSignal	readonly	AbortSignal	-	BaseService.abortSignal	service-framework/src/base-service.ts:23
environment	readonly	IEnvironmentDescriptor	-	BaseService.environment	service-framework/src/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.	BaseService.logEvent	service-framework/src/base-service.ts:31
manager	readonly	ServiceManager	-	BaseService.manager	service-framework/src/base-service.ts:20
scheduler	readonly	IScheduler	-	BaseService.scheduler	service-framework/src/base-service.ts:21
serviceConfig	readonly	TConfig	-	BaseService.serviceConfig	service-framework/src/base-service.ts:46
serviceName	readonly	string	-	BaseService.serviceName	service-framework/src/base-service.ts:44
servicePriority	readonly	number	-	BaseService.servicePriority	service-framework/src/base-service.ts:45
snapshot	protected	TSnapshot	-	-	service-framework/src/snapshot-service.ts:23

Accessors

isDestroyed

Get Signature

get isDestroyed(): boolean;

Defined in: service-framework/src/base-service.ts:59

Returns

boolean

Inherited from

BaseService.isDestroyed

---

isEnabled

Get Signature

get isEnabled(): boolean;

Defined in: service-framework/src/base-service.ts:47

Returns

boolean

Inherited from

BaseService.isEnabled

---

isInitialized

Get Signature

get isInitialized(): boolean;

Defined in: service-framework/src/base-service.ts:51

Returns

boolean

Inherited from

BaseService.isInitialized

---

isServiceRegistered

Get Signature

get isServiceRegistered(): boolean;

Defined in: service-framework/src/base-service.ts:63

Returns

boolean

Inherited from

BaseService.isServiceRegistered

---

isStarted

Get Signature

get isStarted(): boolean;

Defined in: service-framework/src/base-service.ts:55

Returns

boolean

Inherited from

BaseService.isStarted

---

serviceModules

Get Signature

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

Defined in: service-framework/src/base-service.ts:67

Returns

readonly IServiceModule<IService>[]

Inherited from

BaseService.serviceModules

Methods

_setDestroyedState()

_setDestroyedState(isDestroyed: boolean): void;

Defined in: service-framework/src/base-service.ts:157

Parameters

Parameter	Type
isDestroyed	boolean

Returns

void

Inherited from

BaseService._setDestroyedState

---

_setInitializedState()

_setInitializedState(isInitialized: boolean): void;

Defined in: service-framework/src/base-service.ts:149

Parameters

Parameter	Type
isInitialized	boolean

Returns

void

Inherited from

BaseService._setInitializedState

---

_setRegistrationState()

_setRegistrationState(isRegistered: boolean): void;

Defined in: service-framework/src/base-service.ts:145

Parameters

Parameter	Type
isRegistered	boolean

Returns

void

Inherited from

BaseService._setRegistrationState

---

_setStartedState()

_setStartedState(isStarted: boolean): void;

Defined in: service-framework/src/base-service.ts:153

Parameters

Parameter	Type
isStarted	boolean

Returns

void

Inherited from

BaseService._setStartedState

---

destroy()

destroy(): void;

Defined in: service-framework/src/base-service.ts:85

Returns

void

Inherited from

BaseService.destroy

---

Destroy()

Destroy(): void;

Defined in: service-framework/src/base-service.ts:133

Returns

void

Inherited from

BaseService.Destroy

---

fixedUpdate()

fixedUpdate(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:81

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseService.fixedUpdate

---

FixedUpdate()

FixedUpdate(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:125

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseService.FixedUpdate

---

getSnapshot()

getSnapshot(): TSnapshot;

Defined in: service-framework/src/snapshot-service.ts:31

Returns

TSnapshot

---

initialize()

initialize(): void;

Defined in: service-framework/src/base-service.ts:71

Returns

void

Inherited from

BaseService.initialize

---

Initialize()

Initialize(): void;

Defined in: service-framework/src/base-service.ts:105

Returns

void

Inherited from

BaseService.Initialize

---

lateUpdate()

lateUpdate(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:79

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseService.lateUpdate

---

LateUpdate()

LateUpdate(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:121

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseService.LateUpdate

---

onFocusChange()

onFocusChange(_context: FocusChangeContext): void;

Defined in: service-framework/src/base-service.ts:87

Parameters

Parameter	Type
_context	FocusChangeContext

Returns

void

Inherited from

BaseService.onFocusChange

---

OnFocusChange()

OnFocusChange(context: FocusChangeContext): void;

Defined in: service-framework/src/base-service.ts:137

Parameters

Parameter	Type
context	FocusChangeContext

Returns

void

Inherited from

BaseService.OnFocusChange

---

onPauseChange()

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

Defined in: service-framework/src/base-service.ts:89

Parameters

Parameter	Type
_context	{ paused: boolean; }
_context.paused	boolean

Returns

void

Inherited from

BaseService.onPauseChange

---

OnPauseChange()

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

Defined in: service-framework/src/base-service.ts:141

Parameters

Parameter	Type
context	{ paused: boolean; }
context.paused	boolean

Returns

void

Inherited from

BaseService.OnPauseChange

---

publishSnapshot()

protected publishSnapshot(snapshot: TSnapshot): void;

Defined in: service-framework/src/snapshot-service.ts:43

Parameters

Parameter	Type
snapshot	TSnapshot

Returns

void

---

registerServiceModule()

registerServiceModule(serviceModule: IServiceModule): void;

Defined in: service-framework/src/base-service.ts:91

Parameters

Parameter	Type
serviceModule	IServiceModule

Returns

void

Inherited from

BaseService.registerServiceModule

---

render()

render(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:83

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseService.render

---

Render()

Render(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:129

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseService.Render

---

reset()

reset(): void;

Defined in: service-framework/src/base-service.ts:75

Returns

void

Inherited from

BaseService.reset

---

Reset()

Reset(): void;

Defined in: service-framework/src/base-service.ts:113

Returns

void

Inherited from

BaseService.Reset

---

start()

start(): void;

Defined in: service-framework/src/base-service.ts:73

Returns

void

Inherited from

BaseService.start

---

Start()

Start(): void;

Defined in: service-framework/src/base-service.ts:109

Returns

void

Inherited from

BaseService.Start

---

subscribe()

subscribe(listener: SnapshotListener<TSnapshot>): () => void;

Defined in: service-framework/src/snapshot-service.ts:35

Parameters

Parameter	Type
listener	SnapshotListener<TSnapshot>

Returns

() => void

---

unregisterServiceModule()

unregisterServiceModule(serviceModule: IServiceModule): void;

Defined in: service-framework/src/base-service.ts:97

Parameters

Parameter	Type
serviceModule	IServiceModule

Returns

void

Inherited from

BaseService.unregisterServiceModule

---

update()

update(_context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:77

Parameters

Parameter	Type
_context	LifecycleContext

Returns

void

Inherited from

BaseService.update

---

Update()

Update(context: LifecycleContext): void;

Defined in: service-framework/src/base-service.ts:117

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

BaseService.Update

---

updateSnapshot()

protected updateSnapshot(partial: Partial<TSnapshot>): void;

Defined in: service-framework/src/snapshot-service.ts:48

Parameters

Parameter	Type
partial	Partial<TSnapshot>

Returns

void