Pixi’VNClass: StageBaseModel
Defined in: src/classes/quest/StageBaseModel.ts:6
Extends
Constructors
Constructor
> new StageBaseModel(id, props): StageBaseModel
Defined in: src/classes/quest/StageBaseModel.ts:7
Parameters
id
string
props
Returns
StageBaseModel
Overrides
Properties
id
> readonly id: string
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:41
Is id of the stored class. is unique for this class.
Inherited from
Accessors
adviceDescription
Get Signature
> get adviceDescription(): string
Defined in: src/classes/quest/StageBaseModel.ts:43
The advice description of the stage.
Returns
string
canStart
Get Signature
> get canStart(): boolean
Defined in: src/classes/quest/StageBaseModel.ts:94
Check if the stage can start.
Example
export default class Stage extends StageStoredClass {
override get canStart(): boolean {
if (this.flagsRequired.length > 0 && !this.flagsRequired.every((flag) => storage.getFlag(flag.flag))) {
return false;
}
return super.canStart;
}
}Returns
boolean
Overrides
completed
Get Signature
> get completed(): boolean
Defined in: src/classes/quest/StageBaseModel.ts:79
Check if the flag and goals are completed. You can force the completion of the stage by setting the completed property to true.
Example
export default class Stage extends StageStoredClass {
override get completed(): boolean {
if (super.completed) {
return true;
}
if (this.flags.length > 0) {
if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
return false;
}
return true;
}
return false;
}
override set completed(value: boolean) {
super.completed = value;
}
}Returns
boolean
Set Signature
> set completed(value): void
Defined in: src/classes/quest/StageBaseModel.ts:91
Check if the flag and goals are completed. You can force the completion of the stage by setting the completed property to true.
Example
export default class Stage extends StageStoredClass {
override get completed(): boolean {
if (super.completed) {
return true;
}
if (this.flags.length > 0) {
if (!this.flags.every((flag) => storage.getFlag(flag.flag))) {
return false;
}
return true;
}
return false;
}
override set completed(value: boolean) {
super.completed = value;
}
}Parameters
value
boolean
Returns
void
Overrides
deltaDateRequired
Get Signature
> get deltaDateRequired(): number
Defined in: src/classes/quest/StageStoredClass.ts:122
The number of day/date required to start the stage.
Returns
number
Inherited from
StageStoredClass.deltaDateRequired
description
Get Signature
> get description(): string
Defined in: src/classes/quest/StageBaseModel.ts:35
The description of the stage.
Returns
string
flags
Get Signature
> get flags(): StageFlags[]
Defined in: src/classes/quest/StageBaseModel.ts:59
The list of flags that the player must complete to finish the stage.
Returns
StageFlags[]
flagsRequired
Get Signature
> get flagsRequired(): StageFlags[]
Defined in: src/classes/quest/StageBaseModel.ts:67
The list of flags required to start the stage.
Returns
StageFlags[]
image
Get Signature
> get image(): string | undefined
Defined in: src/classes/quest/StageBaseModel.ts:51
The image of the stage.
Returns
string | undefined
name
Get Signature
> get name(): string
Defined in: src/classes/quest/StageBaseModel.ts:27
The name of the stage.
Returns
string
onEnd
Get Signature
> get onEnd(): OnRunEvent<StageInterface> | undefined
Defined in: src/classes/quest/StageStoredClass.ts:48
The function that will be called when the stage ends.
Returns
OnRunEvent<StageInterface> | undefined
Inherited from
onStart
Get Signature
> get onStart(): OnRunEvent<StageInterface> | undefined
Defined in: src/classes/quest/StageStoredClass.ts:43
The function that will be called when the stage starts.
Returns
OnRunEvent<StageInterface> | undefined
Inherited from
questsRequired
Get Signature
> get questsRequired(): QuestsRequiredType[]
Defined in: src/classes/quest/StageStoredClass.ts:127
The list of quests required to start the stage.
Returns
Inherited from
StageStoredClass.questsRequired
requestDescriptionToStart
Get Signature
> get requestDescriptionToStart(): string
Defined in: src/classes/quest/StageBaseModel.ts:75
The description of the request to start the stage.
Returns
string
startDate
Get Signature
> get startDate(): number | undefined
Defined in: src/classes/quest/StageStoredClass.ts:73
The date when the stage starts.
Returns
number | undefined
Inherited from
started
Get Signature
> get started(): boolean
Defined in: src/classes/quest/StageStoredClass.ts:59
If the stage is started.
Returns
boolean
Set Signature
> set started(value): void
Defined in: src/classes/quest/StageStoredClass.ts:62
If the stage is started.
Parameters
value
boolean
Returns
void
Inherited from
Methods
getStorageProperty()
> protected getStorageProperty<T>(propertyName, idToUse?): T | undefined
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:56
Get a property from the storage.
Type Parameters
T
T = StorageElementType
Parameters
propertyName
string
The name of the property to get.
idToUse?
string
The id of the instance to get the property.
Returns
T | undefined
The value of the property. If the property is not found, returns undefined.
Default
this.idInherited from
StageStoredClass.getStorageProperty
inizialize()
> inizialize(): void
Defined in: src/classes/quest/StageStoredClass.ts:103
Returns
void
Inherited from
migrateOldStorage()
> protected migrateOldStorage(oldCategoryId?): void
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:37
Parameters
oldCategoryId?
string
Returns
void
Inherited from
StageStoredClass.migrateOldStorage
setStorageProperty()
> protected setStorageProperty<T>(propertyName, value): void
Defined in: node_modules/@drincs/pixi-vn/dist/StoredClassModel-uMifeNzV.d.ts:49
Update a property in the storage.
Type Parameters
T
T
The type of the value to set. (Deprecated, it is not necessary to specify the type of the value, it will be inferred from the value)
Parameters
propertyName
string
The name of the property to set.
value
StorageElementType
The value to set. If is undefined, the property will be removed from the storage.
Returns
void
Inherited from
StageStoredClass.setStorageProperty
start()
> start(props): Promise<void>
Defined in: src/classes/quest/StageStoredClass.ts:110
The function that will be called when the stage starts.
Parameters
props
Returns
Promise<void>