-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added globalEvents flags json and documentation md file #45
Closed
Closed
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d1d567d
added globalEvents flags json and documentation md file
DetKewlDog a78cd0e
i forgot to add ` at the end
DetKewlDog 4229d46
really minor change to documentation
DetKewlDog db64291
fixed keys being indexed from 1 instead of 0 (embarassing)
DetKewlDog 3f1440f
Update jrd.tree
DetKewlDog 3959f04
Create jekyll-gh-pages.yml
DetKewlDog 560bfed
Create blank.yml
DetKewlDog 99bebe0
Delete .github/workflows/blank.yml
DetKewlDog 09473f1
Delete .github/workflows/jekyll-gh-pages.yml
DetKewlDog 20c3349
Create blank.yml
DetKewlDog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Global Events Flags | ||
|
||
## dictionary | ||
This json contains a dictionary of key: value pairs, representing the globalEvent flag (which correlates to its type) returned from the Helldivers 2 | ||
Status API. | ||
|
||
```json | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would avoid copying the contents of |
||
{ | ||
"1": "Stratagem", | ||
"2": "Briefing", | ||
dealloc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"3": "Success", | ||
"4": "Fail" | ||
} | ||
``` | ||
```json | ||
{ | ||
"eventId": 1499087, | ||
"id32": 0, | ||
"portraitId32": 0, | ||
"title": "BRIEFING", | ||
"titleId32": 2908633975, | ||
"message": "...", | ||
"messageId32": 46181626, | ||
"race": 1, | ||
"flag": 1, // <-- This one | ||
"assignmentId32": 2311178494, | ||
"effectIds": [], | ||
"planetIndices": [] | ||
} | ||
``` | ||
|
||
### Keys | ||
The key values of the dictionary will be the value that is assigned in the api. In the file you can see that a key of | ||
`"1"` has been assigned to the value `"Stratagem"`, as that is what is shown in the API. | ||
|
||
```json | ||
{ | ||
"1" // <- The key, which corresponds to the integer in the "flag" field above. | ||
} | ||
``` | ||
|
||
### Values | ||
The value that is mapped to each key is derived from in-game observation. For example, we have derived that the key `"1"` | ||
is `"Stratagem"` as when in-game, the global event was an additional stratagem that became available for everyone ("Weapons Experimentation" / "Open License" effects). | ||
|
||
```json | ||
{ | ||
"1": "Stratagem" // <- The value we assigned based off our observations | ||
} | ||
``` | ||
|
||
As stated above, global events where the value of `flag` is `1` correlate to events where an additional stratagem becomes available for everyone (known as "Weapons Experimentation" / "Open License" effects). | ||
|
||
For this kind of global event, the value of `assignmentId32` in the same `globalEvent` object will be the stratagem's internal ID in the game files. | ||
|
||
![Global Event with flag=1 in game](../images/globalEvents_flags_stratagem.png) | ||
|
||
The other 3 values are all Major Order related, and will trigger an in-game "Incoming Transmission from Super Earth" cutscene when interacting with the war map - in which a modal with a title and text (which are taken from the `title` and `message` properties of the `globalEvent` object respectively) will appear. The text that appears above the modal's top right corner will be determined by the value mapped to the flag assigned by the API. | ||
|
||
`"Briefing"` (`flag: 2`) events usually happen at the beginning of Major Orders, while `"Success"` (`flag: 3`) and `"Fail"` (`flag: 4`) appear after a Major Order has been completed or has failed, respectively. | ||
|
||
![Briefing](../images/globalEvents_flags_briefing.png) | ||
|
||
The text that will appear above the modal will be equal to the the value of `flag` (in uppercase) prepended to the string `"MAJOR ORDER / "` like this: | ||
|
||
```json | ||
{ | ||
"2": "MAJOR ORDER / BRIEFING", | ||
"3": "MAJOR ORDER / SUCCESS", | ||
"4": "MAJOR ORDER / FAIL" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"1": "Stratagem", | ||
"2": "Briefing", | ||
"3": "Success", | ||
"4": "Fail" | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall documentation could use work, it reads a little choppy still.
Try moving away from the 'dictionary' style of documentation and describe what global events are, point out which property indicates the global event, and in the example I'm missing what JSON you're showing (is this a planet, dispatch, ...)