#include <sf_campaign_hook.h>

Public Attributes
char	name [64]
uint16_t	campaign_name_id
char	description [256]
char	author [64]
char	start_map [64]
char	tutorial_map [64]
char	campaign_folder [64]
char	intro_video [64]
char	starterkit [128]
int8_t	avatar_type

Detailed Description

Definition at line 23 of file sf_campaign_hook.h.

Member Data Documentation

◆ author

char SFSF_CampaignDef::author[64]

Optional, shown under the name in the detail panel

Definition at line 28 of file sf_campaign_hook.h.

◆ avatar_type

int8_t SFSF_CampaignDef::avatar_type

GdAvatar field should continue past a GameInfo reset in PrepareNewGame and is serialized into saves). Vanilla: 3 = SF1, 4 = AddOn1, 7 = AddOn2, 1/5 = multiplayer. Custom campaigns: Currently setup to use 8 + campaign_index so saves are identified for each custom campaign load order issues might happen with differnt mods though will need extensive error handling / checking.

Definition at line 38 of file sf_campaign_hook.h.

◆ campaign_folder

char SFSF_CampaignDef::campaign_folder[64]

Folder for save separation and map loading, e.g. "mycampaign"

Definition at line 31 of file sf_campaign_hook.h.

◆ campaign_name_id

uint16_t SFSF_CampaignDef::campaign_name_id

Optional, reserved for future use. Empty string when unset.

Definition at line 26 of file sf_campaign_hook.h.

◆ description

char SFSF_CampaignDef::description[256]

For the right-hand detail panel

Definition at line 27 of file sf_campaign_hook.h.

◆ intro_video

char SFSF_CampaignDef::intro_video[64]

Optional: "videos\\myintro" - empty = engine_type default. NOT implemented yet (needs CUiVideo replication of PlayCampaignIntroVideo).

Definition at line 32 of file sf_campaign_hook.h.

◆ name

char SFSF_CampaignDef::name[64]

Shown on the campaign button

Definition at line 25 of file sf_campaign_hook.h.

◆ start_map

char SFSF_CampaignDef::start_map[64]

Map name WITHOUT path/extension, e.g. "mycampaign"

Definition at line 29 of file sf_campaign_hook.h.

◆ starterkit

char SFSF_CampaignDef::starterkit[128]

Starter kit .des filename, relative to figure_template\starterkit. Replaces the whole "SK_<skill><subskill>.des" name, this will need work to ensure the skill subskill stuff is taken into account. Leave empty to keep the vanilla skill-derived name.

Definition at line 34 of file sf_campaign_hook.h.

◆ tutorial_map

char SFSF_CampaignDef::tutorial_map[64]

Optional tutorial map.

Definition at line 30 of file sf_campaign_hook.h.

The documentation for this struct was generated from the following file:

src/internal/core/hooks/sf_campaign_hook.h

Public Attributes