AvA/Cyrodiil function differences

[Enodoc]

Apologies if this is in the wrong place, this is my first foray into ESO's API (or indeed, any API or LUA coding).

I was wondering if anyone is able to identify the functionality differences between the following API functions relating to AvA/PvP/Cyrodiil. ie, what the states are that return true to the following functions:

IsPlayerInAvAWorld() - boolean isInAvAWorld
IsInCyrodiil() - boolean isInCyrodiil
IsInAvAZone() - boolean isInAvAZone
IsInCampaign() - boolean inCampaign

To me, these seem essentially the same, but if they were actually the same, then only one would be needed. Thanks for any help!

[Ayantir]

There was some Capture the flag projects at the begenning of the game. I assume

IsPlayerInAvAWorld() - boolean isInAvAWorld
IsInAvAZone() - boolean isInAvAZone

are for that kind of arenas.

IsInCyrodiil() - boolean isInCyrodiil
IsInCampaign() - boolean inCampaign

are for Cyrodiil

and you forget

IsInImperialCity()

which will be for Imperial City


I guess that if there was a IsInRvR() function it will be :

IsInRvR() == IsInCampaign() and (IsInCyrodiil() or IsInImperialCity())

But yes, there almost sames. With Imperial City , we'll et a revamp of Cyro api, so let's wait.

[Enodoc]

Cool, thanks for that. Has anyone tested this within delves? Since delves are separately-loaded instances, are they included with IsInCyrodiil(), or is that just for the overworld zone?

[Enodoc]

Originally Posted by Enodoc Cool, thanks for that. Has anyone tested this within delves? Since delves are separately-loaded instances, are they included with IsInCyrodiil(), or is that just for the overworld zone?

Just for reference, I checked this myself, now that I know how to use /script d() in chat.

In a delve,
IsPlayerInAvAWorld() returns true
IsInCyrodiil() returns false
InInAvAZone() returns false
IsInCampaign() returns true

In overworld Cyrodiil, they're all true.

[merlight]

Originally Posted by Enodoc Just for reference, I checked this myself, now that I know how to use /script d() in chat. In a delve, IsPlayerInAvAWorld() returns true IsInCyrodiil() returns false InInAvAZone() returns false IsInCampaign() returns true In overworld Cyrodiil, they're all true.

Just curious, have you tried inside "gated" buildings, e.g. the temples near Brindle or Kingscrest? They're somewhat separate, as you can't enter/leave them in combat.

[Enodoc]

Originally Posted by merlight Just curious, have you tried inside "gated" buildings, e.g. the temples near Brindle or Kingscrest? They're somewhat separate, as you can't enter/leave them in combat.

I haven't, but I certainly could do.

In the meantime, here's the Imperial City Sewers:
IsPlayerInAvAWorld() returns true
IsInCyrodiil() returns false
InInAvAZone() returns true
IsInCampaign() returns true

and of course
IsInImperialCity() returns true

[ZOS_DanBatson]

IsPlayerInAvAWorld() return true if the world you're in is Cyrodiil, IC, IC Sewers, or one of the caves.
IsInCyrodiil() returns true if you're in Cyrodiil (not IC, and not the caves.)
IsInImperialCity() returns true if you're in IC or the IC sewers
InInAvAZone() returns true if either IsInCyrodiil() or IsInImperialCity() returns true
IsInCampaign() returns true if you are currently counted as inside a campaign (home or guest)

The differences are subtle, but they are used for different things, and while they may seem effectively the same now, they have the potential to diverge, giving us flexibility.

[sirinsidiator]

Thanks for this clarification. I created a table on the wiki. Could anyone double check if I got it right?

[circonian]

Originally Posted by sirinsidiator Thanks for this clarification. I created a table on the wiki. Could anyone double check if I got it right?

It looks good to me. I double checked the links from the API page too, looks good too, thanks for doing that.

[Enodoc]

Originally Posted by ZOS_DanBatson IsPlayerInAvAWorld() return true if the world you're in is Cyrodiil, IC, IC Sewers, or one of the caves. IsInCyrodiil() returns true if you're in Cyrodiil (not IC, and not the caves.) IsInImperialCity() returns true if you're in IC or the IC sewers InInAvAZone() returns true if either IsInCyrodiil() or IsInImperialCity() returns true IsInCampaign() returns true if you are currently counted as inside a campaign (home or guest) The differences are subtle, but they are used for different things, and while they may seem effectively the same now, they have the potential to diverge, giving us flexibility.

That's awesome, thanks!