Home

WARNING, THIS API IS STILL A WIP MEANING ANYTHING HERE CAN CHANGE

---

So you want to use FateGrandOrderAPI but you don't know where to start, well let's help with that!

Basics

To use FateGrandOrderAPI you need to get the NuGet package (Azy.FateGrandOrderAPI) and add using FateGrandOrderApi; at the top of your cs file

Once you done that you can get:

1. Skills

var skill = FateGrandOrderParsing.GetSkill("SkillName"); //Returns a Skill class

2. Active Skills

var activeSkill = FateGrandOrderParsing.GetActiveSkill("SkillName"); //Returns a ActiveSkill class

3. Items

var item = FateGrandOrderParsing.GetItem("ItemName"); //Returns a Item class

4. Enemies

var enemy = FateGrandOrderParsing.GetEnemy("EnemyName"); //Returns a Enemy class

5. Servant

var servant = FateGrandOrderParsing.GetServant("ServantName"); //Returns a Servant class

Changing what GetServant("ServantName") returns with

So because Servants have got so much data this API will allow you to choose what it grabs. There are 3 presets for this: AllInformation (Grabs everything the API can get), BasicInformation (Only the basic information about the servant) and NotSet (returns nothing). GetServant is set with AllInformation by default

To use this you would change the servant line to this

var servant = FateGrandOrderParsing.GetServant("ServantName", presetsForInformation: PresetsForInformation.<Preset you want to use>); //Returns a Servant class

There is also a ToGrab class with three settings, Grab (Grab the content), DontGrab (Don't Grab the content) and NotSet (Isn't set if to grab or not grab (For Servants this will result in the content being grabbed))

The ToGrab's that tell the API what it's going to get are:

1. GetBasicInformation (Get's basic information)
2. GetActiveSkills (Get's Active Skills)
3. GetPassiveSkills (Get's Passive Skills)
4. GetNoblePhantasm (Get's Noble Phantasm)
5. GetAscension (Get's Ascension)
6. GetSkillReinforcement (Get's Skill Reinforcement)
7. GetStats (Get's Stats)
8. GetBondLevel (Get's Bond Level)
9. GetBiography (Get's Biography)
10. GetAvailability (Get's Availability)
11. GetTrivia (Get's Trivia)
12. GetImages (Get's Images of/with the servant)

To use them you would do

var servant = FateGrandOrderParsing.GetServant("ServantName", GetImages: ToGrab.Grab);  //Returns a Servant class

Examples

So let's say that you only wanted to get images then you would do

var servant = FateGrandOrderParsing.GetServant("ServantName", presetsForInformation: PresetsForInformation.NotSet, GetImages: ToGrab.Grab); //Returns a Servant class

Or everything but the images then you would do

var servant = FateGrandOrderParsing.GetServant("ServantName", presetsForInformation: PresetsForInformation.AllInformation, GetImages: ToGrab.DontGrab); //Returns a Servant class