fairy

package module

Go to main page

Versions in this module

v0

v0.6.0

Aug 12, 2026

Changes in this version

type Attribute

+ func (a Attribute) BaseAttribute() Attribute

type DriveDiscSetBonus

+ func (sb DriveDiscSetBonus) FormatHTML() string

+ func (sb DriveDiscSetBonus) FormatMarkdown() string

+ func (sb DriveDiscSetBonus) FormatPlainText() string

type FormattedStatBreakdown

+ Name string

type FormattedStats

+ AttributeDMGBonus string

type PropertyID

+ const PropAnomalyMasteryPercent

+ const PropElectricDMGBonus

+ const PropEtherDMGBonus

+ const PropFireDMGBonus

+ const PropIceDMGBonus

+ const PropPhysicalDMGBonus

+ const PropWindDMGBonus

type Stats

+ AttributeDMGBonus float64

type UIStats

+ AttributeDMGBonus FormattedStatBreakdown

type WEngine

+ func (w *WEngine) FormatHTML() string

+ func (w *WEngine) FormatMarkdown() string

+ func (w *WEngine) FormatPlainText() string

v0.5.0

Aug 11, 2026

Changes in this version

+ func EvaluateFormulas(text string, skillLevel int) string

+ func FormatHTML(text string, skillLevel ...int) string

+ func FormatMarkdown(text string, skillLevel ...int) string

+ func FormatPlainText(text string, skillLevel ...int) string

type Attribute

+ func (a Attribute) IconURL() string

+ func (a Attribute) SVG() string

type Rarity

+ func (r Rarity) IconURL() string

type Skill

+ func (s Skill) EvaluatedDescription() string

+ func (s Skill) FormatHTML() string

+ func (s Skill) FormatMarkdown() string

+ func (s Skill) FormatPlainText() string

type Specialty

+ func (s Specialty) IconURL() string

v0.4.1

Aug 11, 2026

v0.4.0

Aug 11, 2026

Changes in this version

type FormattedStats

+ SheerForce string

type PropertyID

+ const PropBaseSheerForce

+ const PropSheerForce

type Stats

+ SheerForce float64

type UIStats

+ SheerForce FormattedStatBreakdown

v0.3.2

Aug 11, 2026

v0.3.1

Aug 10, 2026

v0.3.0

Aug 10, 2026

Changes in this version

+ var ErrMaintenance = api.ErrMaintenance

+ var ErrNetwork = api.ErrNetwork

+ var ErrProfileNotFound = api.ErrProfileNotFound

+ var ErrRateLimit = api.ErrRateLimit

v0.2.1

Aug 9, 2026

v0.2.0

Aug 9, 2026

Changes in this version

type DriveDisc

+ UID string

type WEngine

+ UID string

v0.1.0

Aug 8, 2026

Changes in this version

+ func GetRawProfile(ctx context.Context, uid string) (*zzz.Profile, error)

+ type Agent struct

+ ActiveSetBonuses []DriveDiscSetBonus

+ Attribute Attribute

+ AttributeName string

+ BaseStats Stats

+ CoreSkillEnhancement int

+ DriveDiscs []DriveDisc

+ ID int

+ Level int

+ MindscapeCinema int

+ Name string

+ Promotion int

+ Rarity Rarity

+ Skills []Skill

+ Skin *Skin

+ Specialty Specialty

+ SpecialtyName string

+ SplashArtURL string

+ Stats Stats

+ WEngine *WEngine

+ func (a *Agent) CountEffectiveRolls(targetProps ...PropertyID) int

+ func (a *Agent) FormattedUIStats() UIStats

+ func (a *Agent) SubStatTotals() []StatValue

+ type Attribute string

+ const AttributeAuricInk

+ const AttributeElectric

+ const AttributeEther

+ const AttributeFire

+ const AttributeFrost

+ const AttributeHonedEdge

+ const AttributeIce

+ const AttributeLumiflux

+ const AttributePhysical

+ const AttributeWind

+ type Avatar struct

+ ID int

+ URL string

+ type Badge struct

+ ID int

+ IconURL string

+ Title string

+ Value int

+ type Client struct

+ func NewClient(opts ...Option) (*Client, error)

+ func (c *Client) GetProfile(ctx context.Context, uid string) (*Profile, error)

+ func (c *Client) GetProfileWithLang(ctx context.Context, uid string, lang Language) (*Profile, error)

+ func (c *Client) GetRawProfile(ctx context.Context, uid string) (*zzz.Profile, error)

+ func (c *Client) Localize(raw *zzz.Profile, lang Language) (*Profile, error)

+ type DriveDisc struct

+ ID int

+ IconPath string

+ Level int

+ MainStat StatValue

+ Rarity Rarity

+ Set Set

+ Slot int

+ SubStats []StatValue

+ func (d *DriveDisc) CountEffectiveRolls(targetProps ...PropertyID) int

+ type DriveDiscSetBonus struct

+ Description string

+ PieceCount int

+ Set Set

+ type FormattedStatBreakdown struct

+ Added string

+ Base string

+ Total string

+ type FormattedStats struct

+ ATK string

+ AnomalyMastery string

+ AnomalyProficiency string

+ CritDMG string

+ CritRate string

+ DEF string

+ EnergyRegen string

+ HP string

+ Impact string

+ PenFlat string

+ PenRatio string

+ type Language string

+ const LangDE

+ const LangEN

+ const LangES

+ const LangFR

+ const LangID

+ const LangJA

+ const LangKO

+ const LangPT

+ const LangRU

+ const LangTH

+ const LangVI

+ const LangZHCN

+ const LangZHTW

+ type Namecard struct

+ ID int

+ URL string

+ type Option func(*Options)

+ func WithDefaultLang(lang Language) Option

+ func WithEnkaOptions(enkaOpts zzz.Options) Option

+ func WithStore(s store.MetadataStore) Option

+ type Options struct

+ DefaultLang Language

+ EnkaOpts zzz.Options

+ Store store.MetadataStore

+ type Profile struct

+ Agents []Agent

+ Avatar *Avatar

+ Badges []Badge

+ InterknotLevel int

+ Namecard *Namecard

+ Nickname string

+ Region Region

+ Title *Title

+ UID string

+ func GetProfile(ctx context.Context, uid string) (*Profile, error)

+ func GetProfileWithLang(ctx context.Context, uid string, lang Language) (*Profile, error)

+ func Localize(raw *zzz.Profile, lang Language) (*Profile, error)

+ type PropertyID int

+ const PropATKFlat

+ const PropATKPercent

+ const PropAnomalyMastery

+ const PropAnomalyProficiency

+ const PropAnomalyProficiencyPercent

+ const PropBaseATK

+ const PropBaseAnomalyMastery

+ const PropBaseAnomalyProficiency

+ const PropBaseCritDMG

+ const PropBaseCritRate

+ const PropBaseDEF

+ const PropBaseEnergyRegen

+ const PropBaseHP

+ const PropBaseImpact

+ const PropBasePENFlat

+ const PropBasePENRatio

+ const PropCritDMG

+ const PropCritRate

+ const PropDEFFlat

+ const PropDEFPercent

+ const PropEnergyRegen

+ const PropEnergyRegenPercent

+ const PropHPFlat

+ const PropHPFlatBonus

+ const PropHPPercent

+ const PropHPPercentBonus

+ const PropImpactFlat

+ const PropImpactPercent

+ const PropPENFlat

+ const PropPENRatio

+ type Rarity string

+ const RarityA

+ const RarityB

+ const RarityS

+ type Region string

+ const RegionAsia

+ const RegionEU

+ const RegionNA

+ const RegionTWHKMO

+ type Set struct

+ ID int

+ Name string

+ type Skill struct

+ Description string

+ Level int

+ Name string

+ type Skin struct

+ Description string

+ ID int

+ Name string

+ SplashArtURL string

+ type Specialty string

+ const SpecialtyAnomaly

+ const SpecialtyAttack

+ const SpecialtyDefense

+ const SpecialtyRupture

+ const SpecialtyStun

+ const SpecialtySupport

+ type StatValue struct

+ IsPercent bool

+ Name string

+ PropertyID PropertyID

+ Rolls int

+ Value float64

+ func (s StatValue) DisplayValue() string

+ type Stats struct

+ ATK float64

+ AnomalyMastery float64

+ AnomalyProficiency float64

+ CritDMG float64

+ CritRate float64

+ DEF float64

+ EnergyRegen float64

+ HP float64

+ Impact float64

+ PenFlat float64

+ PenRatio float64

+ func (s *Stats) Formatted() FormattedStats

+ type Title struct

+ ID int

+ PrimaryColor string

+ SecondaryColor string

+ Text string

+ func (t *Title) PrimaryColorHex() string

+ func (t *Title) SecondaryColorHex() string

+ type UIStats struct

+ ATK FormattedStatBreakdown

+ AnomalyMastery FormattedStatBreakdown

+ AnomalyProficiency FormattedStatBreakdown

+ CritDMG FormattedStatBreakdown

+ CritRate FormattedStatBreakdown

+ DEF FormattedStatBreakdown

+ EnergyRegen FormattedStatBreakdown

+ HP FormattedStatBreakdown

+ Impact FormattedStatBreakdown

+ PenFlat FormattedStatBreakdown

+ PenRatio FormattedStatBreakdown

+ type WEngine struct

+ ID int

+ IconURL string

+ Level int

+ MainStat StatValue

+ Modification int

+ Name string

+ PassiveDescription string

+ Phase int

+ Rarity Rarity

+ SecondaryStat StatValue

+ Specialty Specialty

+ SpecialtyName string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL