Skip to main content

Interface: GameDataProvider

Methods

FindAllNPCInstance()

FindAllNPCInstance(filter): NPCInstance[]

Parameters

filter: NPCInstanceFilter

Returns

NPCInstance[]


FindAllSkillRequirements()

FindAllSkillRequirements(skill): {requiredLevel: number;skillDefine: SkillDefine; }[]

Finds all skill requirements, including the requirements of its requirements (recursive)

Parameters

skill: SkillDefine

Returns

{requiredLevel: number;skillDefine: SkillDefine; }[]


FindNPCInstance()

FindNPCInstance(filter): NPCInstance

Parameters

filter: NPCInstanceFilter

Returns

NPCInstance


FindSkillsForJob()

FindSkillsForJob(internalJobID): SkillDefine[]

Returns all matching skill defines for the input job. Does not include child job (ie ringmaster will not include assist)

Parameters

internalJobID: number

Returns

SkillDefine[]


GetContinentNameAtPosition()

GetContinentNameAtPosition(position, worldName?): string

Parameters

position: IVector3

The position you need to get the continent name for.

worldName?: string

The name of the world you want to get the continent name for, defaults to wdmadrigal for the main overworld.

Returns

string

The name of the continent, or "flaris" if no match was found.


GetItemDefine()

GetItemDefine(itemID): ItemDefine

Parameters

itemID: number

Returns

ItemDefine


GetItemIDByName()

GetItemIDByName(itemName): number

Parameters

itemName: string

The name of the item (in any game language) you need the id for.

Returns

number

The internal ID of the item, or -1 if no match was found.


GetItemNameByID()

GetItemNameByID(itemID): string

Parameters

itemID: number

The internal ID of the item you need to get the name for.

Returns

string

The english name of the item, or an empty string if no match was found.


GetMonsterDataByID()

GetMonsterDataByID(monsterId): MonsterData

Parameters

monsterId: number

The internal ID of the monster you need to get the data for.

Returns

MonsterData

The monster data, or undefined if no match was found.


GetSkillDefineByID()

GetSkillDefineByID(skillId): SkillDefine

Parameters

skillId: number

The internal ID of the skill you need to get the name for.

Returns

SkillDefine

The SkillDefine object (or undefined)


GetSkillIDByName()

GetSkillIDByName(skillName): number

Parameters

skillName: string

The name of the skill (in any game language) you need the id for.

Returns

number

The internal ID of the skill, or -1 if no match was found.


GetSkillNameByID()

GetSkillNameByID(skillId): string

Parameters

skillId: number

The internal ID of the skill you need to get the name for.

Returns

string

The english name of the skill, or an empty string if no match was found.