Class Joel

Namespace

Helldivers2API

Assembly

Helldivers2API.dll

Main entry point to retrieve data and use this library.

public sealed class Joel

Inheritance

object

Joel

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Singleton, there can only be one Joel.

Properties

Instance

Singleton instance

public static Joel Instance { get; }

Property Value

Joel

IsClientReady

True if the client has been set to a war id

public bool IsClientReady { get; }

Property Value

bool

WarId

The target war id

public int WarId { get; }

Property Value

int

Methods

GetAssignmentPlanets()

Get planets associated with an assignment. This is where the MAJOR ORDER appears.

public IPlanet[] GetAssignmentPlanets()

Returns

IPlanet[]

Remarks

Returns all planets with any assignments.
If more than the major order begin to appear in assignments, the type may need to be used to filter result specific to major orders. Assignment.IsMajorOrder will return true if the type == 4.

GetAssignments()

Get all the assignments.
To get associated planets, use GetAssignmentPlanets().

public Assignment[] GetAssignments()

Returns

Assignment[]

GetBiomes()

Get all the known biomes.

public IBiome[] GetBiomes()

Returns

IBiome[]

GetCampaignPlanets()

Get planets in the current campaign. These are the playable planets, unless they've been 100% liberated.

public IPlanet[] GetCampaignPlanets()

Returns

IPlanet[]

GetEnvironments()

Get all the known environmental conditions.

public IEnvironment[] GetEnvironments()

Returns

IEnvironment[]

GetFactions()

Get all the known factions.

public IFaction[] GetFactions()

Returns

IFaction[]

GetGlobalEventPlanets()

Get planets with global events (open access to weapons, stratagem, etc).

public IPlanet[] GetGlobalEventPlanets()

Returns

IPlanet[]

Remarks

effectIds might be a weapon id, not sure but see title to know what it is

GetHomeWorlds()

Get planets which are homeworlds for a faction.

public IPlanet[] GetHomeWorlds()

Returns

IPlanet[]

GetLastRefreshed()

Returns a dictionary of when each of the known api endpoints were last refreshed.

public Dictionary<string, DateTime?> GetLastRefreshed()

Returns

Dictionary<string, DateTime?>

GetLatestNews()

Gets the latest news.

public NewsFeed[] GetLatestNews()

Returns

NewsFeed[]

GetPlanetEventPlanets()

Get planets with planet events (focuses player efforts). These are the planets with a focus on the galactic map. E.g. "DEFEND with a countdown"

public IPlanet[] GetPlanetEventPlanets()

Returns

IPlanet[]

GetPlanets()

Get information about all the known planets, their biomes, environmental conditions, sector, etc. Use the extension methods to pull live war data from the Helldivers2 api (player counts, health, trade routes, etc)

public IPlanet[] GetPlanets()

Returns

IPlanet[]

GetWarInfo()

Gets info on the war Use Planet extension methods to get planet associated data.

public WarInfo GetWarInfo()

Returns

WarInfo

GetWarStats()

Gets stats on the war Use Planet extension methods to get planet associated data.

public WarStats GetWarStats()

Returns

WarStats

GetWarStatus()

Gets the status of the war.
Use Planet extension methods to get planet associated data.

public WarStatus GetWarStatus()

Returns

WarStatus

GetWebApiCalls()

Returns a list of calls to the api endpoints and when.

public List<KeyValuePair<string, long>> GetWebApiCalls()

Returns

List<KeyValuePair<string, long>>

SetWarId(int)

Set the current war id. As of 1.1.4, the war id will automatically be set to the current season id.

public Joel SetWarId(int warId)

Parameters

warId int

The current war id

Returns

Joel