Skip to content

Latest commit

 

History

History
244 lines (135 loc) · 4.6 KB

payloads.rst

File metadata and controls

244 lines (135 loc) · 4.6 KB

Census Payload Reference

Base Classes & Interfaces

auraxium.models.base

Payload

RESTPayload

FallbackMixin

fallback_hook(id: int) -> auraxium.types.CensusData

ImageData

Event

Note

While this base class is defined in and accessible from the auraxium.models.base module, its canonical location is the auraxium.event namespace.

CharacterEvent

WorldEvent

REST Payloads

auraxium.models

Object-Mirror Payloads

The following payloads are used as the underlying data container for the objects defined in auraxium.ps2. To avoid needing to document these values in both places, the attribute annotations are omitted for any payloads with an exact equivalent in the auraxium.ps2 namespace.

AbilityData

AbilityTypeData

AchievementData

ArmourInfoData

CharacterData

CurrencyData

DirectiveData

DirectiveTierData

DirectiveTreeCategoryData

DirectiveTreeData

EffectData

EffectTypeData

ExperienceData

ExperienceRankData

FacilityTypeData

FactionData

FireGroupData

FireModeData

ItemCategoryData

ItemData

ItemTypeData

LoadoutData

MapHexData

MapRegionData

MarketingBundleData

MarketingBundleSingleData

MetagameEventData

ObjectiveData

ObjectiveTypeData

OutfitData

OutfitMemberData

ProfileData

ProjectileData

RegionData

ResistInfoData

ResistTypeData

ResourceTypeData

RewardData

RewardTypeData

SkillData

SkillCategoryData

SkillLineData

SkillSetData

TitleData

VehicleAttachmentData

VehicleData

WeaponData

WorldData

ZoneData

ZoneEffectData

ZoneEffectTypeData

Relational Payloads

These are payloads that are returned as part of intermediate tables with no immediate equivalent in the auraxium.ps2 namespace.

CharacterAchievement

CharacterDirective

CharacterDirectiveObjective

CharacterDirectiveTier

CharacterDirectiveTree

OutfitRankData

PlayerStateGroup

WeaponAmmoSlot

WeaponDatasheet

Events

Note

While the following objects are defined in and available through the auraxium.models module, their canonical location is within the auraxium.event namespace.

Alias of auraxium.event.AchievementAdded.

Alias of auraxium.event.BattleRankUp.

Alias of auraxium.event.ContinentLock.

Death

Alias of auraxium.event.Death.

FacilityControl

Alias of auraxium.event.FacilityControl.

GainExperience

Alias of auraxium.event.GainExperience.

ItemAdded

Alias of auraxium.event.ItemAdded.

MetagameEvent

Alias of auraxium.event.MetagameEvent.

PlayerFacilityCapture

Alias of auraxium.event.PlayerFacilityCapture.

PlayerFacilityDefend

Alias of auraxium.event.PlayerFacilityDefend.

PlayerLogin

Alias of auraxium.event.PlayerLogin.

PlayerLogout

Alias of auraxium.event.PlayerLogout.

SkillAdded

Alias of auraxium.event.SkillAdded.

VehicleDestroy

Alias of auraxium.event.VehicleDestroy.