warframe-worldstate-parser Global

Members

arbitration :ExternalMission

Arbitration mission

Type:

ExternalMission

Source:

WorldState.js, line 327

<constant> defaultDeps :Dependency

Default Dependency object

Type:

Dependency

Source:

WorldState.js, line 45

kuva :Array.<ExternalMission>

Kuva missions array

Type:

Array.<ExternalMission>

Source:

WorldState.js, line 322

<constant> parseAsyncArray

Parse array of objects that requires async parsing

Source:

WorldState.js, line 84

<constant> start :Date

Start of Steel Path cycle calculations

Type:

Date

Source:

models/SteelPathOffering.js, line 65

Methods

<async> build(data, expiry, deps)

Generate a job with async data (reward pool)

Parameters:

Name Type Description

data object The syndicate mission data

expiry Date The syndicate job expiration

deps

object

The dependencies object

Properties

Name	Type	Description
`locale`	string	Locale to use for translations

Source:

models/SyndicateJob.js, line 94

Returns:

The created SyndicateJob object with rewardPool

Type: Promise.<SyndicateJob>

<async> build(data, deps)

Build a new SyndicateMission with async operations & data

Parameters:

Name Type Description

data object The syndicate mission data

deps

object

The dependencies object

Properties

Name	Type	Description
`locale`	string	Locale to use for translations

Source:

models/SyndicateMission.js, line 20

Returns:

SyndicateMission object w/ async resolution of jobs

Type: Promise.<SyndicateMission>

<async> build(data, deps)

Asynchronously build a new WorldEvent

Parameters:

Name Type Description

data object The event data

deps

object

The dependencies object

Properties

Name	Type	Description
`locale`	string	Locale to use for translations

Source:

models/WorldEvent.js, line 37

Returns:

The created WorldEvent object

Type: Promise.<WorldEvent>

compileDesription()

Turn the global upgrade into a plain text description

Source:

models/GlobalUpgrade.js, line 108

Returns:

Descriptio

Type: string

getBoss()

Get the sortie's boss

Source:

models/Sortie.js, line 99

Returns:

the sortie's boss

Type: string

getCurrentCycle()

Get the current cycle state for Orb Vallis

Source:

models/VallisCycle.js, line 25

Returns:

current cycle state

Type: CurrentCycle

getCurrentEarthCycle()

Get the current Earth Day/Night Cycle

Source:

models/EarthCycle.js, line 23

Returns:

The current Earth Day/Night Cycle

Type: EarthCycle

getDescription()

Get the alert's description text

Source:

models/Alert.js, line 53

Returns:

the description

Type: string

getEndOfDay()

When was the end of the day

Source:

models/SteelPathOffering.js, line 52

Returns:

end of the day

Type: Date

getEndString()

Get a string indicating how much time is left before the challenge expires

Source:

models/ConclaveChallenge.js, line 142

Returns:

The time left before the challenge expires

Type: string

getEndString()

Get a string indicating how long it will take for the trader to leave

Source:

models/VoidTrader.js, line 104

Returns:

time delta string from now to the end

Type: string

getEndString()

Get a string indicating how long it will take for the trader to leave

Source:

models/WorldstateObject.js, line 103

Returns:

time delta string from now to the end

Type: string

getETAString()

Get a string indicating how much time is left before the alert expires

Source:

models/Alert.js, line 69

Returns:

the time left

Type: string

getETAString()

Get a string indicating how much time is left before the deal expires

Source:

models/DailyDeal.js, line 86

Returns:

estimated time remaining on the deal

Type: string

getETAString()

Get a string representation of how long the void fissure will remain active

Source:

models/Fissure.js, line 125

Returns:

The string representation of the fissure's remaining time

Type: string

getETAString()

Get how much time is left before the deal expires

Source:

models/FlashSale.js, line 92

Returns:

The time left before the deal expires

Type: string

getETAString()

Get a string indicating how long it will take for the upgrade to expire

Source:

models/GlobalUpgrade.js, line 100

Returns:

estimated timer of the upgrade

Type: string

getETAString()

Get a string estimating how much time is left before the invasion ends

Source:

models/Invasion.js, line 150

Returns:

time delta string from now to the end

Type: string

getETAString()

Get a string indicating how long it will take for the event to start or how long it's been since the news went up

Source:

models/News.js, line 122

Returns:

the estimated time of arrival for the event

Type: string

getETAString()

Get a string indicating how much time is left before the alert expires

Source:

models/Nightwave.js, line 70

Returns:

estimated timer of the alert

Type: string

getETAString()

Gets a string indicating how long it will take for the sortie to end

Source:

models/Sortie.js, line 115

Returns:

estimated time of arrival

Type: string

getETAString()

Get a string indicating how much time is left before the syndicate mission expries

Source:

models/SyndicateMission.js, line 95

Returns:

time delta string from now to the expiry

Type: string

getExpired()

Get whether the event has expired

Source:

models/CambionCycle.js, line 29

Returns:

whether the event has expired

Type: boolean

getExpired()

Get whether or not the event has expired

Source:

models/CetusCycle.js, line 86

Returns:

whether the event has expired

Type: boolean

getExpired()

Get whether or not the event has expired

Source:

models/EarthCycle.js, line 103

Returns:

Whether or not the event has expired

Type: boolean

getExpired()

Get whether this deal has expired

Source:

models/Fissure.js, line 117

Returns:

Whether or not the deal has expired

Type: boolean

getExpired()

Get whether or not this deal has expired

Source:

models/FlashSale.js, line 100

Returns:

Whether or not the deal has expired

Type: boolean

getExpired()

Get whether or not the event has expired

Source:

models/GlobalUpgrade.js, line 92

Returns:

whether the event has expired

Type: boolean

getExpired()

Get whether or not the event has expired

Source:

models/VallisCycle.js, line 109

Returns:

whether this event has expired

Type: boolean

getExpired()

Get whether the event has expired

Source:

models/WorldEvent.js, line 277

Returns:

whether the event has expired

Type: boolean

getExpired()

Get whether the event has expired

Source:

models/ZarimanCycle.js, line 80

Returns:

whether this is expired

Type: boolean

getFaction()

Get the sortie's faction

Source:

models/Sortie.js, line 107

Returns:

the sortie's faction

Type: string

getFirstDayOfWeek()

Gets the first day of the week

Source:

models/SteelPathOffering.js, line 9

Returns:

first day of the week

Type: Date

getItemType(item [, types])

Returns the type of a given item

Parameters:

Name	Type	Argument	Description
`item`	string		The item whose type needs to be determined
`types`	Array.<RewardType>	<optional>	The possible types

Source:

models/Reward.js, line 22

Returns:

The type name

Type: string

getItemTypeFull(item [, types])

Returns the full type of a given item

Parameters:

Name	Type	Argument	Description
`item`	string		The item whose type needs to be determined
`types`	Array.<RewardType>	<optional>	The possible types

Source:

models/Reward.js, line 32

Returns:

The type

Type: RewardType

getLastDayOfWeek()

Get the last day of the week

Source:

models/SteelPathOffering.js, line 25

Returns:

last day of the week

Type: Date

getLevelString(job)

Determine the level string for the bounty

Parameters:

Name	Type	Description
`job`	object	Original raw job data

Source:

models/SyndicateJob.js, line 14

Returns:

level range string

Type: string

getRemainingTime()

Get an estimation of how much time is left before the invasion ends in milliseconds

Source:

models/Invasion.js, line 139

Returns:

remaining time in ms

Type: number

getReward()

Get the alert's reward

Source:

models/Alert.js, line 61

Returns:

the reward

Type: Reward

getRewardTypes()

Get an array containing the types of all of the alert's rewards

Source:

models/Alert.js, line 77

Returns:

an array containing the types of all of the alert's rewards

Type: Array.<string>

getRewardTypes()

Get the types of the items being rewarded in the invasion

Source:

models/Invasion.js, line 158

Returns:

types of items being rewarded

Type: Array.<string>

getRewardTypes()

Get an array containing the types of all of the nightwave season's rewards

Source:

models/Nightwave.js, line 78

Returns:

an array containing the types of all of the nightwave season's rewards

Type: Array.<string>

getStartOfDay()

When was the start of the day

Source:

models/SteelPathOffering.js, line 39

Returns:

start of the day

Type: Date

getStartString()

Get a string indicating how long it will take for the trader to arrive

Source:

models/VoidTrader.js, line 96

Returns:

time delta string from now to the start

Type: string

getStartString()

Get a string indicating how long it will take for the trader to arrive

Source:

models/WorldstateObject.js, line 95

Returns:

time delta string from now to the start

Type: string

getTitle(langCode)

The title of the news item in the specified language

Parameters:

Name	Type	Description
`langCode`	string	Ex. 'es', 'de', 'fr'

Source:

models/News.js, line 171

Returns:

The title of the news item in the specified language

Type: string

getTypes()

The types of all items that are being rewarded

Source:

models/Reward.js, line 86

Returns:

types as array of string

Type: Array.<string>

getTypesFull()

The types of all the items that are being rewarded

Source:

models/Reward.js, line 94

Returns:

array of reward types

Type: Array.<RewardType>

isActive()

Get whether or not the trader is currently active

Source:

models/VoidTrader.js, line 88

Returns:

whether the trader is active

Type: boolean

isActive()

Get whether the trader is currently active

Source:

models/WorldstateObject.js, line 87

Returns:

whether the trader is active

Type: boolean

isAttackerWinning()

Whether or not the attackers are winning. This is always false when the infestation is attacking

Source:

models/Invasion.js, line 131

Returns:

whether the attacker is winning

Type: boolean

isDaily()

Get whether or not the challenge is daily

Source:

models/ConclaveChallenge.js, line 118

Returns:

whether the category is daily

Type: boolean

isExpired()

Get whether or not the challenge has expired

Source:

models/ConclaveChallenge.js, line 134

Returns:

Whether or not the challenge has expired

Type: boolean

isExpired()

Get whether or not the sortie has expired

Source:

models/Sortie.js, line 123

Returns:

whether the sortie has expired

Type: boolean

isPrimeAccess()

Whether this is about a new Prime Access

Source:

models/News.js, line 143

Returns:

whether the news is about a new Prime Access

Type: boolean

isRootChallenge()

Get whether or not this is the weekly root challenge

Source:

models/ConclaveChallenge.js, line 126

Returns:

whether this is the root challenge

Type: boolean

isStream()

Whether this is about a new stream

Source:

models/News.js, line 151

Returns:

whether the news is for a stream

Type: boolean

isUpdate()

Whether or not this is about a game update

Source:

models/News.js, line 135

Returns:

whether the news is about an update

Type: boolean

parse(data, locale)

Parse kuva & arbitration data

Parameters:

Name	Type	Description
`data`	object	Data to split for kuva/arbitration
`locale`	string	locale to translate

Source:

models/Kuva.js, line 61

Returns:

Split parsed data

Type: Kuva

parseArray(ParserClass, dataArray, deps [, uniqueField])

Parameters:

Name	Type	Argument	Description
`ParserClass`	object		class for parsing data
`dataArray`	Array.<BaseContentObject>		array of raw data
`deps`	Dependency		shared dependency object
`uniqueField`	*	<optional>	field to treat as unique

Source:

WorldState.js, line 59

Returns:

array of parsed objects

Type: Array.<WorldstateObject>

scrub(mission)

Scrub unnecessary details from the mission

Parameters:

Name	Type	Description
`mission`	object	parsed mission with re-aligned field names

Source:

models/Kuva.js, line 43

toString()

The alert's string representation

Source:

models/Alert.js, line 85

Returns:

the string representation

Type: string

toString()

The event's string representation

Source:

models/CetusCycle.js, line 118

Returns:

The string representation of the event

Type: string

toString()

The conclave challenge's string representation

Source:

models/ConclaveChallenge.js, line 151

Returns:

The string representation of the conclave challenge

Type: string

toString()

The alert's string representation

Source:

models/ConstructionProgress.js, line 25

Returns:

string representation

Type: string

toString()

Returns a string representation of the daily deal

Source:

models/DailyDeal.js, line 94

Returns:

The string representation of the daily deal

Type: string

toString()

The event's string representation

Source:

models/EarthCycle.js, line 111

Returns:

The string representation of the event

Type: string

toString()

Returns a string representation of the fissure

Source:

models/Fissure.js, line 133

Returns:

The string representation of the fissure

Type: string

toString()

Returns a string representation of the flash sale

Source:

models/FlashSale.js, line 108

Returns:

The string representation of the flash sale

Type: string

toString()

Returns a string representation of the upgrade

Source:

models/GlobalUpgrade.js, line 116

Returns:

string representation

Type: string

toString()

The invasion's string representation

Source:

models/Invasion.js, line 166

Returns:

string representation of the invasion

Type: string

toString()

The Mission's string representation

Source:

models/Mission.js, line 170

Returns:

Mission's string representation

Type: string

toString()

String representation

Source:

models/News.js, line 159

Returns:

string representation

Type: string

toString()

The alert's string representation

Source:

models/Nightwave.js, line 86

Returns:

string representation of the alert

Type: string

toString()

Returns a string representation of the persistent enemy

Source:

models/PersistentEnemy.js, line 91

Returns:

string representation

Type: string

toString()

The reward's string representation

Source:

models/Reward.js, line 102

Returns:

reward's string representation

Type: string

toString()

Returns a string representation of the current sanctuary status

Source:

models/Simaris.js, line 41

Returns:

a string representation of the current sanctuary status

Type: string

toString()

Returns the sortie's string representation

Source:

models/Sortie.js, line 131

Returns:

the string representation

Type: string

toString()

Returns a string representation of the sortie variant

Source:

models/SortieVariant.js, line 52

Returns:

string representation

Type: string

toString()

Returns a string representation of the syndicate mission

Source:

models/SyndicateMission.js, line 103

Returns:

the string representation

Type: string

toString()

The event's string representation

Source:

models/VallisCycle.js, line 117

Returns:

the event's string representation

Type: string

toString()

Returns a string representation of the trader

Source:

models/VoidTrader.js, line 112

Returns:

string representation

Type: string

toString()

Returns a string representation of the trader

Source:

models/WeeklyChallenge.js, line 22

Returns:

string representation

Type: string

toString()

The event's string representation

Source:

models/WorldEvent.js, line 285

Returns:

the event's string representation

Type: string

toString()

Returns a string representation of the object

Source:

models/WorldstateObject.js, line 79

Returns:

basic representation from the id

Type: string

toString()

The event's string representation

Source:

models/ZarimanCycle.js, line 116

Returns:

string representation

Type: string

truncateTime(mission)

Truncate time for a semlar-provided mission

Parameters:

Name	Type	Description
`mission`	object	parsed mission with re-aligned field names

Source:

models/Kuva.js, line 31

Type Definitions

BaseContentObject

Type:

object

Properties:

Name	Type	Description
`_id`	Identifier	object identifier
`Activation`	ContentTimestamp	activation timestamp
`Expiry`	ContentTimestamp	expiry timestamp

Source:

models/WorldstateObject.js, line 20

ContentTimestamp

Type:

object

Properties:

Name	Type	Description
`$date`	LegacyTimestamp \| Timestamp	timestamp number wrapper

Source:

models/WorldstateObject.js, line 16

CurrentCycle

Type:

object

Properties:

Name	Type	Description
`state`	string	Current cycle state. One of `warm`, `cold`
`toNextMinor`	number	Time remaining in the current cycle state
`toNextFull`	number	Time remaining until the next cycle
`timeAtPrevious`	Date	Date and time at which the event started
`timeAtNext`	Date	Date and time at which the event start

Source:

models/VallisCycle.js, line 12

DuviriCycle

Type:

WorldstateObject

Source:

models/DuviriCycle.js, line 28

EarthCycle

Type:

object

Properties:

Name	Type	Description
`expiry`	Date	The date and time at which the event ends
`activation`	Date	The date and time at which the event started
`isDay`	boolean	Whether or not this it's daytime
`state`	string	Current cycle state. One of `day`, `night`
`timeLeft`	string	Time remaining string
`rounded`	Date	The date and time at which the event ends, rounded to the nearest minute
`start`	Date	The date and time at which the event started, 4 hours before the end
`expired`	boolean	Whether or not the event has expired

Source:

models/EarthCycle.js, line 7

ExternalMission

External mission data retrieved from https://10o.io/kuvalog.json

Type:

object

Properties:

Name	Type	Description
`activation`	Date	start time
`expiry`	Date	end timer
`node`	string	formatted node name with planet
`enemy`	string	Enemy on tile
`type`	string	Mission type of node
`archwing`	boolean	whether or not the tile requires archwing
`sharkwing`	boolean	whether or not the tile requires sumbersible archwing

Source:

models/Kuva.js, line 5

ExternalMission

External mission data retrieved from https://10o.io/kuvalog.json

Type:

object

Properties:

Name	Type	Description
`activation`	Date	start time
`expiry`	Date	end timer
`node`	string	formatted node name with planet
`enemy`	string	Enemy on tile
`type`	string	Mission type of node
`archwing`	boolean	whether or not the tile requires archwing
`sharkwing`	boolean	whether or not the tile requires sumbersible archwing

Source:

supporting/ExternalMission.js, line 1

Identifier

Type:

object

Properties:

Name	Type	Description
`$id`	string	older identifier schema
`$oid`	string	newer global identifier schema

Source:

models/WorldstateObject.js, line 3

InterimStep

Interim step for an event reward system.

Type:

object

Properties:

Name	Type	Description
`goal`	number	Goal amount
`reward`	Reward	Reward for reaching the step
`winnerCount`	number	Amount of players at this step
`message`	object	Message received when reaching the interim step

Source:

models/WorldEvent.js, line 9

InvasionParticipant

An invasion participant

Type:

object

Properties:

Name	Type	Description
`reward`	string	Reward for supporting this participant in the invasion
`faction`	string	Faction of this participant (localized)
`factionKey`	string	Faction of this participant (always English)

Source:

models/Invasion.js, line 7

Kuva

Stores and parses kuva data from https://10o.io/kuvalog.json

Type:

object

Properties:

Name	Type	Description
`kuva`	Array.<ExternalMission>	currently active kuva missions
`arbitration`	ExternalMission	current arbitration

Source:

models/Kuva.js, line 18

LegacyTimestamp

Type:

object

Properties:

Name	Type	Description
`sec`	number	second-based timestamp

Source:

models/WorldstateObject.js, line 8

Mission

Mission typeDef

Type:

object

Properties:

Name	Type	Description
`node`	string	Mission node name
`enemy`	string	Node enemy
`type`	string	Mission type of the node

Source:

models/SentientOutpost.js, line 21

ProgressStep

Progress for one of multiple stages

Type:

object

Properties:

Name	Type	Description
`type`	string	Type of progress
`progressAmt`	number	Amount of progress

Source:

models/WorldEvent.js, line 18

RewardType

An object describing a type of reward, including name, description, test function to verify type from a string, thumbnail url, and color

Type:

object

Properties:

Name	Type	Description
`name`	string	Name of the reward type
`description`	string	Description of the reward type
`test`	string	Function for testing the return type against a string
`thumbnail`	string	Thumbnail url for this reward type
`color`	string	Summary color representing this reward type

Source:

models/Reward.js, line 5

Timestamp

Type:

object

Properties:

Name	Type	Description
`$numberLong`	number	millisecond-based timestamp

Source:

models/WorldstateObject.js, line 12