Limited support
This feature is only present in Portal 2: Community Edition.

CampaignAPI

[API not finalized] The Campaign API. Exclusive to P2:CE!

Functions

CampaignHasSaveData

CampaignAPI.CampaignHasSaveData(campaign: string): boolean

No description provided.

Parameter

NameTypeDescription
campaignstringNo description provided.

CompleteRating

CampaignAPI.CompleteRating(): void

No description provided.

ContinueCampaign

CampaignAPI.ContinueCampaign(campaign: string): boolean

No description provided.

Parameter

NameTypeDescription
campaignstringNo description provided.

FindCampaign

CampaignAPI.FindCampaign(campaign: string): pano-typed.CampaignPair | null

No description provided.

Parameter

NameTypeDescription
campaignstringNo description provided.

GetActiveCampaign

CampaignAPI.GetActiveCampaign(): pano-typed.CampaignPair | null

No description provided.

GetAllCampaignBuckets

CampaignAPI.GetAllCampaignBuckets(): pano-typed.CampaignBucket[]

No description provided.

GetCampaignMeta

CampaignAPI.GetCampaignMeta(name: string): typescript.Map<string, string> | null

No description provided.

Parameter

NameTypeDescription
namestringNo description provided.

GetCampaignUnlockProgress

CampaignAPI.GetCampaignUnlockProgress(campaign: string): number

No description provided.

Parameter

NameTypeDescription
campaignstringNo description provided.

IsCampaignActive

CampaignAPI.IsCampaignActive(): boolean

No description provided.

IsRatingCampaign

CampaignAPI.IsRatingCampaign(): boolean

No description provided.

MoveToNextMap

CampaignAPI.MoveToNextMap(): void

No description provided.

OpenRatingMenu

CampaignAPI.OpenRatingMenu(): void

No description provided.

ReloadCampaigns

CampaignAPI.ReloadCampaigns(): void

No description provided.

SetActiveCampaign

CampaignAPI.SetActiveCampaign(name: string): boolean

No description provided.

Parameter

NameTypeDescription
namestringNo description provided.

StartCampaign

CampaignAPI.StartCampaign(campaign: string, chapter: string, map: number): boolean

No description provided.

Parameters

NameTypeDescription
campaignstringNo description provided.
chapterstringNo description provided.
mapnumberNo description provided.