Interface: ChangeAwareService<TSnapshot>

Defined in: service-framework-client/src/contracts.ts:157

Extends

• IEventService<{ changed: TSnapshot; }>

Type Parameters

Type Parameter
TSnapshot

Properties

Property	Modifier	Type	Inherited from	Defined in
isDestroyed	readonly	boolean	IEventService.isDestroyed	service-framework/src/contracts.ts:70
isEnabled	readonly	boolean	IEventService.isEnabled	service-framework/src/contracts.ts:67
isInitialized	readonly	boolean	IEventService.isInitialized	service-framework/src/contracts.ts:68
isServiceRegistered	readonly	boolean	IEventService.isServiceRegistered	service-framework/src/contracts.ts:71
isStarted	readonly	boolean	IEventService.isStarted	service-framework/src/contracts.ts:69
serviceConfig	readonly	unknown	IEventService.serviceConfig	service-framework/src/contracts.ts:66
serviceModules	readonly	readonly IServiceModule<IService>[]	IEventService.serviceModules	service-framework/src/contracts.ts:72
serviceName	readonly	string	IEventService.serviceName	service-framework/src/contracts.ts:64
servicePriority	readonly	number	IEventService.servicePriority	service-framework/src/contracts.ts:65

Methods

destroy()

destroy(): void;

Defined in: service-framework/src/contracts.ts:80

Returns

void

Inherited from

IEventService.destroy

---

emit()

emit<TEventName extends "changed">(eventName: TEventName, payload: {
  changed: TSnapshot;
}[TEventName]): void;

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

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
payload	{ changed: TSnapshot; }[TEventName]

Returns

void

Inherited from

IEventService.emit

---

fixedUpdate()

fixedUpdate(context: LifecycleContext): void;

Defined in: service-framework/src/contracts.ts:78

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

IEventService.fixedUpdate

---

getSnapshot()

getSnapshot(): TSnapshot;

Defined in: service-framework-client/src/contracts.ts:158

Returns

TSnapshot

---

initialize()

initialize(): void;

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

Returns

void

Inherited from

IEventService.initialize

---

lateUpdate()

lateUpdate(context: LifecycleContext): void;

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

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

IEventService.lateUpdate

---

listenerCount()

listenerCount<TEventName extends "changed">(eventName: TEventName): number;

Defined in: service-framework/src/contracts.ts:98

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName

Returns

number

Inherited from

IEventService.listenerCount

---

off()

off<TEventName extends "changed">(eventName: TEventName, handler: EventHandler<{
  changed: TSnapshot;
}[TEventName]>): void;

Defined in: service-framework/src/contracts.ts:95

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
handler	EventHandler<{ changed: TSnapshot; }[TEventName]>

Returns

void

Inherited from

IEventService.off

---

on()

on<TEventName extends "changed">(eventName: TEventName, handler: EventHandler<{
  changed: TSnapshot;
}[TEventName]>): () => void;

Defined in: service-framework/src/contracts.ts:94

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
handler	EventHandler<{ changed: TSnapshot; }[TEventName]>

Returns

() => void

Inherited from

IEventService.on

---

once()

once<TEventName extends "changed">(eventName: TEventName, handler: EventHandler<{
  changed: TSnapshot;
}[TEventName]>): () => void;

Defined in: service-framework/src/contracts.ts:96

Type Parameters

Type Parameter
TEventName extends "changed"

Parameters

Parameter	Type
eventName	TEventName
handler	EventHandler<{ changed: TSnapshot; }[TEventName]>

Returns

() => void

Inherited from

IEventService.once

---

onFocusChange()

onFocusChange(context: FocusChangeContext): void;

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

Parameters

Parameter	Type
context	FocusChangeContext

Returns

void

Inherited from

IEventService.onFocusChange

---

onPauseChange()

onPauseChange(context: PauseChangeContext): void;

Defined in: service-framework/src/contracts.ts:82

Parameters

Parameter	Type
context	PauseChangeContext

Returns

void

Inherited from

IEventService.onPauseChange

---

registerServiceModule()

registerServiceModule(serviceModule: IServiceModule): void;

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

Parameters

Parameter	Type
serviceModule	IServiceModule

Returns

void

Inherited from

IEventService.registerServiceModule

---

render()

render(context: LifecycleContext): void;

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

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

IEventService.render

---

reset()

reset(): void;

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

Returns

void

Inherited from

IEventService.reset

---

start()

start(): void;

Defined in: service-framework/src/contracts.ts:74

Returns

void

Inherited from

IEventService.start

---

unregisterServiceModule()

unregisterServiceModule(serviceModule: IServiceModule): void;

Defined in: service-framework/src/contracts.ts:84

Parameters

Parameter	Type
serviceModule	IServiceModule

Returns

void

Inherited from

IEventService.unregisterServiceModule

---

update()

update(context: LifecycleContext): void;

Defined in: service-framework/src/contracts.ts:76

Parameters

Parameter	Type
context	LifecycleContext

Returns

void

Inherited from

IEventService.update