Class Story

Hierarchy

GameCfgModel<StoryGameCfgResolver>
- Story

Implements

IModel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Story(id: string): Story

Overrides Model.constructor
- Defined in lib/models/gamecfg/model..story.ts:25
Parameters
- id: string
Returns Story

Properties

dialogue

dialogue: Dialogue[]

id

id: string

resolver

resolver: { constructor: any }

Type declaration

constructor: function
- new __type(lang: string, repo: Repository): StoryGameCfgResolver
- - Defined in lib/models/model.base.ts:36
  Parameters
  - lang: string
  - repo: Repository
  Returns StoryGameCfgResolver

Optional resolverOptions

resolverOptions: ModelResolverOptions

Methods

load

load(resolver: StoryGameCfgResolver): Promise<void>

Overrides GameCfgModel.load
- Defined in lib/models/gamecfg/model..story.ts:33
Parameters
- resolver: StoryGameCfgResolver
Returns Promise<void>

loadComplete

loadComplete(): void

Implementation of IModel.loadComplete

Inherited from ShareCfgModel.loadComplete
- Defined in lib/models/model.base.ts:57
Called after all nested Models' dependencies are resolved. Useful if you require certain properties only available after it being resolved.

Returns void

mixin

mixin(model: Model<StoryGameCfgResolver>): void

Inherited from ShareCfgModel.mixin
- Defined in lib/models/model.base.ts:165
Applies the provided model to this instance.

Parameters
- model: Model<StoryGameCfgResolver>
  
  The model to be applied.
Returns void

resolve

resolve(resolver: Resolver): Promise<void>

Implementation of IModel.resolve

Inherited from ShareCfgModel.resolve
- Defined in lib/models/model.base.ts:133
Resolves nested Models that was instanced inside the parent including those nested in objects and arrays.

Parameters
- resolver: Resolver
  
  The resolver to use.
Returns Promise<void>

run

run(raw?: boolean, resolver?: Resolver): Promise<Object | IModel>

Implementation of IModel.run

Inherited from ShareCfgModel.run
- Defined in lib/models/model.base.ts:64
Runs the entire lifecycle of this model.

Parameters
- Default value raw: boolean = false
  
  Whether to return itself or the serialized version
- Default value resolver: Resolver = null
  
  The resolver to use for model serialization
Returns Promise<Object | IModel>

serialize

serialize(): Object

Implementation of IModel.serialize

Inherited from ShareCfgModel.serialize
- Defined in lib/models/model.base.ts:93
Serializes public properties including those nested inside arrays and objects into an Object.

Returns Object

setResolverDefaults

setResolverDefaults(token: string, repo: string, region: ResolverRegion): void

Implementation of IModel.setResolverDefaults

Inherited from ShareCfgModel.setResolverDefaults
- Defined in lib/models/model.base.ts:86
Parameters
- token: string
- repo: string
- region: ResolverRegion
Returns void

Generated using TypeDoc