Module content.game_mechanics.subventions.subvention🔗
global interface ISubvention
data: ISubventionData id: string acceptedTime: number spawnTime: number completedTime: number uid: number endinterface ISubventionData
upfront: {SubventionBonusMalus} complete: {SubventionBonusMalus} failure: {SubventionBonusMalus} name: string expireDurationProposed: number expireDuration: number effectDuration: integer toDeliver: integer delivered: integer endglobal record Subvention<T is ISubvention.ISubventionData> is ISubvention
endglobal record SubventionCardData
title: Entry deadline: Entry description: string expireDuration: Expiration progress: Progress location: Location cargoIcons: {string} cargoToDeliver: integer upfront: {SubventionBonusMalus.Data} failure: {SubventionBonusMalus.Data} complete: {SubventionBonusMalus.Data} status: ISubvention.Status layerConfig: LayerConfig endglobal record SubventionIcons
fallback: string proposed: string active: string complete: string failed: string endglobal record SubventionScript<T>
handleLegacy: function(Subvention<T>): Subvention<T> canSpawn: function(): boolean onSpawn: function(): T, number spawnSpecific: function(ISubvention.ISpecificSubventionParam): T, number isComplete: function(Subvention<T>): boolean onComplete: function(Subvention<T>) onFailure: function(Subvention<T>) onAccept: function(Subvention<T>) onUpdate: function(Subvention<T>) shouldDespawn: function(Subvention<T>, number): string onDespawn: function(Subvention<T>) eventsToHandle: function(): {string} handleEvent: function(string, string, string, any, Subvention<T>): any getNotificationParams: function(Subvention<T>): any getNotificationData: function(string, any, ISubvention.Status, ISubvention.FailReason, {Engine.Entity : string}): NotificationGuiData getNotificationMissedData: function(string, any, ISubvention.FailReason, {Engine.Entity : string}): NotificationGuiData getCardData: function(Subvention<T>): SubventionCardData getRelevantEntities: function(Subvention<T>): {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties} getRelevantEntityNames: function(Subvention<T>): {Engine.Entity : string} endglobal record SubventionState
lastSpawnTime: number proposedSubventions: {ISubvention} activeSubventions: {ISubvention} completedSubventions: {ISubvention} failedSubventions: {ISubvention} usedUids: {string : {string : boolean}} version: integer spawnIntervalModifier: number pause: boolean end
Category: globals🔗
ISubvention🔗
global interface ISubvention
data: ISubventionData id: string acceptedTime: number spawnTime: number completedTime: number uid: number endinterface ISubventionData
upfront: {SubventionBonusMalus} complete: {SubventionBonusMalus} failure: {SubventionBonusMalus} name: string expireDurationProposed: number expireDuration: number effectDuration: integer toDeliver: integer delivered: integer end
ISubvention.ISubventionData🔗
interface ISubvention.ISubventionData
upfront: {SubventionBonusMalus} complete: {SubventionBonusMalus} failure: {SubventionBonusMalus} name: string expireDurationProposed: number expireDuration: number effectDuration: integer toDeliver: integer delivered: integer end
ISubvention.ISubventionData.upfront🔗
ISubvention.ISubventionData.upfront: {SubventionBonusMalus}
ISubvention.ISubventionData.complete🔗
ISubvention.ISubventionData.complete: {SubventionBonusMalus}
ISubvention.ISubventionData.failure🔗
ISubvention.ISubventionData.failure: {SubventionBonusMalus}
ISubvention.ISubventionData.name🔗
ISubvention.ISubventionData.name: string
ISubvention.ISubventionData.expireDurationProposed🔗
ISubvention.ISubventionData.expireDurationProposed: number
ISubvention.ISubventionData.expireDuration🔗
ISubvention.ISubventionData.expireDuration: number
ISubvention.ISubventionData.effectDuration🔗
ISubvention.ISubventionData.effectDuration: integer
ISubvention.ISubventionData.toDeliver🔗
ISubvention.ISubventionData.toDeliver: integer
ISubvention.ISubventionData.delivered🔗
ISubvention.ISubventionData.delivered: integer
ISubvention.ISpecificSubventionParam🔗
ISubvention.ISpecificSubventionParam.expireDurationProposed🔗
ISubvention.ISpecificSubventionParam.expireDurationProposed: number
ISubvention.ISpecificSubventionParam.uid🔗
ISubvention.ISpecificSubventionParam.uid: number
ISubvention.data🔗
ISubvention.data: ISubventionData
ISubvention.id🔗
ISubvention.id: string
ISubvention.acceptedTime🔗
ISubvention.acceptedTime: number
ISubvention.spawnTime🔗
ISubvention.spawnTime: number
ISubvention.completedTime🔗
ISubvention.completedTime: number
ISubvention.uid🔗
ISubvention.uid: number
ISubvention.Status🔗
ISubvention.Status."Active"🔗
ISubvention.Status."Complete"🔗
ISubvention.Status."Failed"🔗
ISubvention.Status."Proposed"🔗
ISubvention.FailReason🔗
ISubvention.FailReason."InvalidEntity"🔗
ISubvention.FailReason."None"🔗
ISubvention.FailReason."Timeout"🔗
Subvention🔗
global record Subvention<T is ISubvention.ISubventionData> is ISubvention
end
Type Parameters
T( isISubvention.ISubventionData)
SubventionBonusMalus🔗
SubventionBonusMalus.Type🔗
SubventionBonusMalus.Type."Money"🔗
SubventionBonusMalus.Type."Reputation"🔗
SubventionBonusMalus.Type."TownExperience"🔗
SubventionBonusMalus.Money🔗
record SubventionBonusMalus.Money
amount: integer end
SubventionBonusMalus.Money.amount🔗
SubventionBonusMalus.Money.amount: integer
SubventionBonusMalus.Reputation🔗
SubventionBonusMalus.Reputation.townEntity🔗
SubventionBonusMalus.Reputation.townEntity: EntityUtil.EntityAndRevision
SubventionBonusMalus.Reputation.amount🔗
SubventionBonusMalus.Reputation.amount: number
SubventionBonusMalus.TownExperience🔗
record SubventionBonusMalus.TownExperience
townEntity: EntityUtil.EntityAndRevision amount: number end
SubventionBonusMalus.TownExperience.townEntity🔗
SubventionBonusMalus.TownExperience.townEntity: EntityUtil.EntityAndRevision
SubventionBonusMalus.TownExperience.amount🔗
SubventionBonusMalus.TownExperience.amount: number
SubventionBonusMalus.Param🔗
SubventionBonusMalus.Param.amount🔗
SubventionBonusMalus.Param.amount: integer
SubventionBonusMalus.Param.townEntity🔗
SubventionBonusMalus.Param.townEntity: EntityUtil.EntityAndRevision
SubventionBonusMalus.type🔗
SubventionBonusMalus.type: Type
SubventionBonusMalus.params🔗
SubventionBonusMalus.params: Param
SubventionBonusMalus.Data🔗
record SubventionBonusMalus.Data
text: string end
SubventionBonusMalus.Data.text🔗
SubventionBonusMalus.Data.text: string
SubventionCardData🔗
global record SubventionCardData
title: Entry deadline: Entry description: string expireDuration: Expiration progress: Progress location: Location cargoIcons: {string} cargoToDeliver: integer upfront: {SubventionBonusMalus.Data} failure: {SubventionBonusMalus.Data} complete: {SubventionBonusMalus.Data} status: ISubvention.Status layerConfig: LayerConfig end
SubventionCardData.Entry🔗
SubventionCardData.Entry.icon🔗
SubventionCardData.Entry.icon: string
SubventionCardData.Entry.name🔗
SubventionCardData.Entry.name: string
SubventionCardData.title🔗
SubventionCardData.title: Entry
SubventionCardData.deadline🔗
SubventionCardData.deadline: Entry
SubventionCardData.description🔗
SubventionCardData.description: string
SubventionCardData.Expiration🔗
SubventionCardData.Expiration.value🔗
SubventionCardData.Expiration.value: number
SubventionCardData.Expiration.name🔗
SubventionCardData.Expiration.name: string
SubventionCardData.expireDuration🔗
SubventionCardData.expireDuration: Expiration
SubventionCardData.Progress🔗
SubventionCardData.Progress.value🔗
SubventionCardData.Progress.value: number
SubventionCardData.Progress.text🔗
SubventionCardData.Progress.text: string
SubventionCardData.progress🔗
SubventionCardData.progress: Progress
SubventionCardData.Location🔗
SubventionCardData.Location.from🔗
SubventionCardData.Location.from: {Engine.Entity, string}
SubventionCardData.Location.to🔗
SubventionCardData.Location.to: {Engine.Entity, string}
SubventionCardData.location🔗
SubventionCardData.location: Location
SubventionCardData.cargoIcons🔗
SubventionCardData.cargoIcons: {string}
SubventionCardData.cargoToDeliver🔗
SubventionCardData.cargoToDeliver: integer
SubventionCardData.upfront🔗
SubventionCardData.upfront: {SubventionBonusMalus.Data}
SubventionCardData.failure🔗
SubventionCardData.failure: {SubventionBonusMalus.Data}
SubventionCardData.complete🔗
SubventionCardData.complete: {SubventionBonusMalus.Data}
SubventionCardData.status🔗
SubventionCardData.status: ISubvention.Status
SubventionCardData.layerConfig🔗
SubventionCardData.layerConfig: LayerConfig
SubventionDesc🔗
SubventionDesc.scriptFile🔗
SubventionDesc.scriptFile: string
SubventionDesc.icons🔗
SubventionDesc.icons: SubventionIcons
SubventionIcons🔗
SubventionIcons.fallback🔗
SubventionIcons.fallback: string
SubventionIcons.proposed🔗
SubventionIcons.proposed: string
SubventionIcons.active🔗
SubventionIcons.active: string
SubventionIcons.complete🔗
SubventionIcons.complete: string
SubventionIcons.failed🔗
SubventionIcons.failed: string
SubventionScript🔗
global record SubventionScript<T>
handleLegacy: function(Subvention<T>): Subvention<T> canSpawn: function(): boolean onSpawn: function(): T, number spawnSpecific: function(ISubvention.ISpecificSubventionParam): T, number isComplete: function(Subvention<T>): boolean onComplete: function(Subvention<T>) onFailure: function(Subvention<T>) onAccept: function(Subvention<T>) onUpdate: function(Subvention<T>) shouldDespawn: function(Subvention<T>, number): string onDespawn: function(Subvention<T>) eventsToHandle: function(): {string} handleEvent: function(string, string, string, any, Subvention<T>): any getNotificationParams: function(Subvention<T>): any getNotificationData: function(string, any, ISubvention.Status, ISubvention.FailReason, {Engine.Entity : string}): NotificationGuiData getNotificationMissedData: function(string, any, ISubvention.FailReason, {Engine.Entity : string}): NotificationGuiData getCardData: function(Subvention<T>): SubventionCardData getRelevantEntities: function(Subvention<T>): {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties} getRelevantEntityNames: function(Subvention<T>): {Engine.Entity : string} end
Type Parameters
T
SubventionScript.handleLegacy🔗
function SubventionScript.handleLegacy(Subvention<T>): Subvention<T>Parameters
Subvention<T>
Subvention<T>
SubventionScript.canSpawn🔗
function SubventionScript.canSpawn(): booleanReturns
boolean
SubventionScript.onSpawn🔗
function SubventionScript.onSpawn(): T, numberReturns
Tnumber
SubventionScript.spawnSpecific🔗
function SubventionScript.spawnSpecific(ISubvention.ISpecificSubventionParam): T, numberParameters
ISubvention.ISpecificSubventionParam
Tnumber
SubventionScript.isComplete🔗
function SubventionScript.isComplete(Subvention<T>): booleanParameters
Subvention<T>
boolean
SubventionScript.onComplete🔗
function SubventionScript.onComplete(Subvention<T>)Parameters
Subvention<T>
SubventionScript.onFailure🔗
function SubventionScript.onFailure(Subvention<T>)Parameters
Subvention<T>
SubventionScript.onAccept🔗
function SubventionScript.onAccept(Subvention<T>)Parameters
Subvention<T>
SubventionScript.onUpdate🔗
function SubventionScript.onUpdate(Subvention<T>)Parameters
Subvention<T>
SubventionScript.shouldDespawn🔗
function SubventionScript.shouldDespawn(Subvention<T>, number): stringParameters
Subvention<T>number
string
SubventionScript.onDespawn🔗
function SubventionScript.onDespawn(Subvention<T>)Parameters
Subvention<T>
SubventionScript.eventsToHandle🔗
function SubventionScript.eventsToHandle(): {string}Returns
{string}
SubventionScript.handleEvent🔗
function SubventionScript.handleEvent(string, string, string, any, Subvention<T>): anyParameters
stringstringstringanySubvention<T>
any
SubventionScript.getNotificationParams🔗
function SubventionScript.getNotificationParams(Subvention<T>): anyParameters
Subvention<T>
any
SubventionScript.getNotificationData🔗
function SubventionScript.getNotificationData(string, any, ISubvention.Status, ISubvention.FailReason, {Engine.Entity : string}): NotificationGuiDataParameters
stringanyISubvention.StatusISubvention.FailReason{Engine.Entity : string}
NotificationGuiData
SubventionScript.getNotificationMissedData🔗
function SubventionScript.getNotificationMissedData(string, any, ISubvention.FailReason, {Engine.Entity : string}): NotificationGuiDataParameters
stringanyISubvention.FailReason{Engine.Entity : string}
NotificationGuiData
SubventionScript.getCardData🔗
function SubventionScript.getCardData(Subvention<T>): SubventionCardDataParameters
Subvention<T>
SubventionCardData
SubventionScript.getRelevantEntities🔗
function SubventionScript.getRelevantEntities(Subvention<T>): {Engine.Entity}, {CargoTypeId : CargoUtil.StockProperties}Parameters
Subvention<T>
{Engine.Entity}{CargoTypeId : CargoUtil.StockProperties}
SubventionScript.getRelevantEntityNames🔗
function SubventionScript.getRelevantEntityNames(Subvention<T>): {Engine.Entity : string}Parameters
Subvention<T>
{Engine.Entity : string}
SubventionState🔗
global record SubventionState
lastSpawnTime: number proposedSubventions: {ISubvention} activeSubventions: {ISubvention} completedSubventions: {ISubvention} failedSubventions: {ISubvention} usedUids: {string : {string : boolean}} version: integer spawnIntervalModifier: number pause: boolean end
SubventionState.lastSpawnTime🔗
SubventionState.lastSpawnTime: number
SubventionState.proposedSubventions🔗
SubventionState.proposedSubventions: {ISubvention}
SubventionState.activeSubventions🔗
SubventionState.activeSubventions: {ISubvention}
SubventionState.completedSubventions🔗
SubventionState.completedSubventions: {ISubvention}
SubventionState.failedSubventions🔗
SubventionState.failedSubventions: {ISubvention}
SubventionState.usedUids🔗
SubventionState.usedUids: {string : {string : boolean}}
SubventionState.version🔗
SubventionState.version: integer
SubventionState.spawnIntervalModifier🔗
SubventionState.spawnIntervalModifier: number
SubventionState.pause🔗
SubventionState.pause: boolean