Module content.game_mechanics.company.company_util🔗

[Expand All] [Collapse All]
global record CompanyUtil
  prospectionTimeMs: number
  prospectionIntervalTimeMs: number
  prospectionStartChance: number
  prospectionEndChance: number
  getActualPermitKey: function(ResName, ConstructionDescMetadata): ResName
  getMaximumNumberOfPermits: function(CompaniesGrowthState.CompanyData, ResName, ConstructionDescMetadata): integer, boolean
  getNumberOfPermitsForRank: function(CompaniesGrowthState.CompanyData, ConstructionDescMetadata): integer, boolean
  
record ItemDisableReason
    reason: string
    elapsedCooldownFraction: number
    category: string
    numRemaining: integer
end
  
record ConstructionDisableCacheData
    
record CooldownState
      remainingMs: number
      elapsedFraction: number
end
    companyRank: integer
    extraPermits: {ResName : integer}
    maximumPermits: {ResName : integer}
    consumedPermits: {ResName : integer}
    remainingPermitCooldown: {ResName : CooldownState}
    
record ItemDisableCacheData
      numBuilt: integer
end
    data: {ResName : ItemDisableCacheData}
end
  getConstructionDisableCacheData: function({{ResName, ConstructionDescMetadata, string}}): ConstructionDisableCacheData
  getConstructionDisableReason: function(ResName, ConstructionDescMetadata, ConstructionDisableCacheData): ItemDisableReason
  findStateIndex: function(CompaniesState, EntityUtil.EntityAndRevision): integer
  getCompanyState: function(CompaniesState, Engine.Entity): CompanyState
  setCompanyState: function(CompaniesState, Engine.Entity, CompanyState): CompanyState
  externalGetCompanyState: function(Engine.Entity): CompanyState
  externalGetCompaniesState: function(): CompaniesState
  getNeededPermitsForProposal: function(Proposal, ProposalData): {ResName : integer}, {ResName : ConstructionDescMetadata}
  countUsedConstructionPermits: function({ResName : <any type>}): {ResName : integer}
  getCompanyMetadataFromConstructionResource: function(Engine.Entity): CompanyMetadata.ConstructionDesc
  
record CurrentCompanyState
    level: integer
    potentialLevel: integer
    experience: integer
end
  getCurrentCompanyState: function(): CurrentCompanyState
  getBasePopulation: function(): integer
  computeWorldPopulation: function(): integer
  isConstructionLandmark: function(Engine.Entity): boolean
end

Category: globals🔗

CompanyUtil🔗

[Expand All] [Collapse All]
global record CompanyUtil
  prospectionTimeMs: number
  prospectionIntervalTimeMs: number
  prospectionStartChance: number
  prospectionEndChance: number
  getActualPermitKey: function(ResName, ConstructionDescMetadata): ResName
  getMaximumNumberOfPermits: function(CompaniesGrowthState.CompanyData, ResName, ConstructionDescMetadata): integer, boolean
  getNumberOfPermitsForRank: function(CompaniesGrowthState.CompanyData, ConstructionDescMetadata): integer, boolean
  
record ItemDisableReason
    reason: string
    elapsedCooldownFraction: number
    category: string
    numRemaining: integer
end
  
record ConstructionDisableCacheData
    
record CooldownState
      remainingMs: number
      elapsedFraction: number
end
    companyRank: integer
    extraPermits: {ResName : integer}
    maximumPermits: {ResName : integer}
    consumedPermits: {ResName : integer}
    remainingPermitCooldown: {ResName : CooldownState}
    
record ItemDisableCacheData
      numBuilt: integer
end
    data: {ResName : ItemDisableCacheData}
end
  getConstructionDisableCacheData: function({{ResName, ConstructionDescMetadata, string}}): ConstructionDisableCacheData
  getConstructionDisableReason: function(ResName, ConstructionDescMetadata, ConstructionDisableCacheData): ItemDisableReason
  findStateIndex: function(CompaniesState, EntityUtil.EntityAndRevision): integer
  getCompanyState: function(CompaniesState, Engine.Entity): CompanyState
  setCompanyState: function(CompaniesState, Engine.Entity, CompanyState): CompanyState
  externalGetCompanyState: function(Engine.Entity): CompanyState
  externalGetCompaniesState: function(): CompaniesState
  getNeededPermitsForProposal: function(Proposal, ProposalData): {ResName : integer}, {ResName : ConstructionDescMetadata}
  countUsedConstructionPermits: function({ResName : <any type>}): {ResName : integer}
  getCompanyMetadataFromConstructionResource: function(Engine.Entity): CompanyMetadata.ConstructionDesc
  
record CurrentCompanyState
    level: integer
    potentialLevel: integer
    experience: integer
end
  getCurrentCompanyState: function(): CurrentCompanyState
  getBasePopulation: function(): integer
  computeWorldPopulation: function(): integer
  isConstructionLandmark: function(Engine.Entity): boolean
end

CompanyUtil.prospectionTimeMs🔗

CompanyUtil.prospectionTimeMs: number

CompanyUtil.prospectionIntervalTimeMs🔗

CompanyUtil.prospectionIntervalTimeMs: number

CompanyUtil.prospectionStartChance🔗

CompanyUtil.prospectionStartChance: number

CompanyUtil.prospectionEndChance🔗

CompanyUtil.prospectionEndChance: number

CompanyUtil.getActualPermitKey🔗

function CompanyUtil.getActualPermitKey(ResName, ConstructionDescMetadata): ResName

Parameters

• ResName
• ConstructionDescMetadata

Returns

1. ResName

CompanyUtil.getMaximumNumberOfPermits🔗

function CompanyUtil.getMaximumNumberOfPermits(CompaniesGrowthState.CompanyData, ResName, ConstructionDescMetadata): integer, boolean

Parameters

• CompaniesGrowthState.CompanyData
• ResName
• ConstructionDescMetadata

Returns

1. integer
2. boolean

CompanyUtil.getNumberOfPermitsForRank🔗

function CompanyUtil.getNumberOfPermitsForRank(CompaniesGrowthState.CompanyData, ConstructionDescMetadata): integer, boolean

Parameters

• CompaniesGrowthState.CompanyData
• ConstructionDescMetadata

Returns

1. integer
2. boolean

CompanyUtil.ItemDisableReason🔗

record CompanyUtil.ItemDisableReason
  reason: string
  elapsedCooldownFraction: number
  category: string
  numRemaining: integer
end

CompanyUtil.ItemDisableReason.reason🔗

CompanyUtil.ItemDisableReason.reason: string

CompanyUtil.ItemDisableReason.elapsedCooldownFraction🔗

CompanyUtil.ItemDisableReason.elapsedCooldownFraction: number

CompanyUtil.ItemDisableReason.category🔗

CompanyUtil.ItemDisableReason.category: string

CompanyUtil.ItemDisableReason.numRemaining🔗

CompanyUtil.ItemDisableReason.numRemaining: integer

CompanyUtil.ConstructionDisableCacheData🔗

[Expand All] [Collapse All]
record CompanyUtil.ConstructionDisableCacheData
  
record CooldownState
    remainingMs: number
    elapsedFraction: number
end
  companyRank: integer
  extraPermits: {ResName : integer}
  maximumPermits: {ResName : integer}
  consumedPermits: {ResName : integer}
  remainingPermitCooldown: {ResName : CooldownState}
  
record ItemDisableCacheData
    numBuilt: integer
end
  data: {ResName : ItemDisableCacheData}
end

CompanyUtil.ConstructionDisableCacheData.CooldownState🔗

record CompanyUtil.ConstructionDisableCacheData.CooldownState
  remainingMs: number
  elapsedFraction: number
end

CompanyUtil.ConstructionDisableCacheData.CooldownState.remainingMs🔗

CompanyUtil.ConstructionDisableCacheData.CooldownState.remainingMs: number

CompanyUtil.ConstructionDisableCacheData.CooldownState.elapsedFraction🔗

CompanyUtil.ConstructionDisableCacheData.CooldownState.elapsedFraction: number

CompanyUtil.ConstructionDisableCacheData.companyRank🔗

CompanyUtil.ConstructionDisableCacheData.companyRank: integer

CompanyUtil.ConstructionDisableCacheData.extraPermits🔗

CompanyUtil.ConstructionDisableCacheData.extraPermits: {ResName : integer}

CompanyUtil.ConstructionDisableCacheData.maximumPermits🔗

CompanyUtil.ConstructionDisableCacheData.maximumPermits: {ResName : integer}

CompanyUtil.ConstructionDisableCacheData.consumedPermits🔗

CompanyUtil.ConstructionDisableCacheData.consumedPermits: {ResName : integer}

CompanyUtil.ConstructionDisableCacheData.remainingPermitCooldown🔗

CompanyUtil.ConstructionDisableCacheData.remainingPermitCooldown: {ResName : CooldownState}

CompanyUtil.ConstructionDisableCacheData.ItemDisableCacheData🔗

record CompanyUtil.ConstructionDisableCacheData.ItemDisableCacheData
  numBuilt: integer
end

CompanyUtil.ConstructionDisableCacheData.ItemDisableCacheData.numBuilt🔗

CompanyUtil.ConstructionDisableCacheData.ItemDisableCacheData.numBuilt: integer

CompanyUtil.ConstructionDisableCacheData.data🔗

CompanyUtil.ConstructionDisableCacheData.data: {ResName : ItemDisableCacheData}

CompanyUtil.getConstructionDisableCacheData🔗

function CompanyUtil.getConstructionDisableCacheData({{ResName, ConstructionDescMetadata, string}}): ConstructionDisableCacheData

Parameters

• {{ResName, ConstructionDescMetadata, string}}

Returns

1. ConstructionDisableCacheData

CompanyUtil.getConstructionDisableReason🔗

function CompanyUtil.getConstructionDisableReason(ResName, ConstructionDescMetadata, ConstructionDisableCacheData): ItemDisableReason

Parameters

• ResName
• ConstructionDescMetadata
• ConstructionDisableCacheData

Returns

1. ItemDisableReason

CompanyUtil.findStateIndex🔗

function CompanyUtil.findStateIndex(CompaniesState, EntityUtil.EntityAndRevision): integer

Parameters

• CompaniesState
• EntityUtil.EntityAndRevision

Returns

1. integer

CompanyUtil.getCompanyState🔗

function CompanyUtil.getCompanyState(CompaniesState, Engine.Entity): CompanyState

Parameters

• CompaniesState
• Engine.Entity

Returns

1. CompanyState

CompanyUtil.setCompanyState🔗

function CompanyUtil.setCompanyState(CompaniesState, Engine.Entity, CompanyState): CompanyState

Parameters

• CompaniesState
• Engine.Entity
• CompanyState

Returns

1. CompanyState

CompanyUtil.externalGetCompanyState🔗

function CompanyUtil.externalGetCompanyState(Engine.Entity): CompanyState

Parameters

• Engine.Entity

Returns

1. CompanyState

CompanyUtil.externalGetCompaniesState🔗

function CompanyUtil.externalGetCompaniesState(): CompaniesState

Returns

1. CompaniesState

CompanyUtil.getNeededPermitsForProposal🔗

function CompanyUtil.getNeededPermitsForProposal(Proposal, ProposalData): {ResName : integer}, {ResName : ConstructionDescMetadata}

Parameters

• Proposal
• ProposalData

Returns

1. {ResName : integer}
2. {ResName : ConstructionDescMetadata}

CompanyUtil.countUsedConstructionPermits🔗

function CompanyUtil.countUsedConstructionPermits({ResName : <any type>}): {ResName : integer}

Parameters

• {ResName : <any type>}

Returns

1. {ResName : integer}

CompanyUtil.getCompanyMetadataFromConstructionResource🔗

function CompanyUtil.getCompanyMetadataFromConstructionResource(Engine.Entity): CompanyMetadata.ConstructionDesc

Parameters

• Engine.Entity

Returns

1. CompanyMetadata.ConstructionDesc

CompanyUtil.CurrentCompanyState🔗

record CompanyUtil.CurrentCompanyState
  level: integer
  potentialLevel: integer
  experience: integer
end

CompanyUtil.CurrentCompanyState.level🔗

CompanyUtil.CurrentCompanyState.level: integer

CompanyUtil.CurrentCompanyState.potentialLevel🔗

CompanyUtil.CurrentCompanyState.potentialLevel: integer

CompanyUtil.CurrentCompanyState.experience🔗

CompanyUtil.CurrentCompanyState.experience: integer

CompanyUtil.getCurrentCompanyState🔗

function CompanyUtil.getCurrentCompanyState(): CurrentCompanyState

Returns

1. CurrentCompanyState

CompanyUtil.getBasePopulation🔗

function CompanyUtil.getBasePopulation(): integer

Returns

1. integer

CompanyUtil.computeWorldPopulation🔗

function CompanyUtil.computeWorldPopulation(): integer

Returns

1. integer

CompanyUtil.isConstructionLandmark🔗

function CompanyUtil.isConstructionLandmark(Engine.Entity): boolean

Parameters

• Engine.Entity

Returns

1. boolean