ff7tk  1.2.0.13
Work with Final Fantasy 7 game data
Classes | Public Types | Static Public Member Functions | Static Public Attributes | Static Protected Member Functions | Properties | Friends | List of all members
FF7Materia Class Reference

#include <FF7Materia.h>

Inheritance diagram for FF7Materia:
Inheritance graph
[legend]
Collaboration diagram for FF7Materia:
Collaboration graph
[legend]

Public Types

enum  MateriaType {
  AllMaterias, Magic, Summon, Independent,
  Support, Command
}
 The MateriaType enum - All the Materia Types. More...
 
enum  MateriaName {
  MpPlus = 0x00, HpPlus = 0x01, SpeedPlus = 0x02, MagicPlus = 0x03,
  LuckPlus = 0x04, ExpPlus = 0x05, GilPlus = 0x06, EnemyAway = 0x07,
  EnemyLure = 0x08, ChocoboLure = 0x09, PreEmptive = 0x0A, LongRange = 0x0B,
  MegaAll = 0x0C, CounterAttack = 0x0D, SlashAll = 0x0E, DoubleCut = 0x0F,
  Cover = 0x10, Underwater = 0x11, HPMP = 0x12, WMagic = 0x13,
  WSummon = 0x14, WItem = 0x15, All = 0x17, Counter = 0x18,
  MagicCounter = 0x19, MpTurbo = 0x1A, MpAbsorb = 0x1B, HpAbsorb = 0x1C,
  Elemental = 0x1D, AddedEffect = 0x1E, SneakAttack = 0x1F, FinalAttack = 0x20,
  AddedCut = 0x21, StealAsWell = 0x22, QuadraMagic = 0x23, Steal = 0x24,
  Sense = 0x25, Throw = 0x27, Morph = 0x28, Deathblow = 0x29,
  Manipulate = 0x2A, Mime = 0x2B, EnemySkill = 0x2C, MasterCommand = 0x30,
  Fire = 0x31, Ice = 0x32, Earth = 0x33, Lightning = 0x34,
  Restore = 0x35, Heal = 0x36, Revive = 0x37, Seal = 0x38,
  Mystify = 0x39, Transform = 0x3A, Exit = 0x3B, Poison = 0x3C,
  Demi = 0x3D, Barrier = 0x3E, Comet = 0x40, Time = 0x41,
  Destruct = 0x44, Contain = 0x45, FullCure = 0x46, Shield = 0x47,
  Ultima = 0x48, MasterMagic = 0x49, ChocoMog = 0x4A, Shiva = 0x4B,
  Ifrit = 0x4C, Ramuh = 0x4D, Titan = 0x4E, Odin = 0x4F,
  Leviathan = 0x50, Bahamut = 0x51, Kujata = 0x52, Alexander = 0x53,
  Phoenix = 0x54, NeoBahamut = 0x55, Hades = 0x56, Typhoon = 0x57,
  BahamutZERO = 0x58, KOTR = 0x59, MasterSummon = 0x5A, EmptyId = 0xFF
}
 The MateriaName enum - Name to ID Enum. More...
 

Static Public Member Functions

static const Q_INVOKABLE QString name (const int id)
 name - Name of materia More...
 
static const Q_INVOKABLE QString statString (const int id)
 statString - Get the stat changes String for a materia More...
 
static const Q_INVOKABLE QString enemySkill (const int skill)
 enemySkill - Get translated string of an enemy skill More...
 
static const Q_INVOKABLE QString masterCommandSkill (const int skill)
 masterCommandSkill - Get translated string of the Master Command skill More...
 
static const Q_INVOKABLE QString masterSummonSkill (const int skill)
 masterSummonSkill - Get translated string of the Master Summon skill More...
 
static const Q_INVOKABLE QString masterMagicSkill (const int skill)
 masterMagicSkill - Get translated string of the Master Magic skill More...
 
static const Q_INVOKABLE QString element (const int id)
 element - Get Elemental Type(s) for materia More...
 
static const Q_INVOKABLE QStringList skills (const int id)
 skills - Get Skill for a materia More...
 
static const Q_INVOKABLE QStringList skillsForLevel (const int id, const int level)
 skills - Get Skill for a materia at a given level More...
 
static const Q_INVOKABLE QStringList addedEffects (const int id)
 addedEffects - The Effects the materia can have when paried with "Added Effect" materia More...
 
static const Q_INVOKABLE qint8 levels (const int id)
 levels More...
 
static const Q_INVOKABLE int materiaLevel (const int id, const quint32 ap)
 materiaLevel - Returns the ap needed for a materia at a level More...
 
static const Q_INVOKABLE qint32 apForLevel (const int id, const int level)
 apForLevel - Returns the ap needed for a materia at a level More...
 
static const Q_INVOKABLE qint32 apToMax (const int id)
 apToMax More...
 
static const Q_INVOKABLE qint8 strengthChange (const int id)
 strengthChange - The Change to the Strength stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 vitalityChange (const int id)
 vitalityChange - The Change to the vitality stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 magicChange (const int id)
 magicChange - The Change to the magic stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 spiritChange (const int id)
 spiritChange - The Change to the spirit stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 dexterityChange (const int id)
 dexterityChange - The Change to the dexterity stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 luckChange (const int id)
 luckChange - The Change to the luck stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 hpChange (const int id)
 hpChange - The Change to the baseHp stat when materia is equipped More...
 
static const Q_INVOKABLE qint8 mpChange (const int id)
 mpChange - The Change to the baseMp stat when materia is equipped More...
 
static const Q_INVOKABLE int type (const int id)
 type Get Materia Type More...
 
static Q_INVOKABLE materia encodeMateria (const int id, const qint32 ap)
 encodeMateria encode a materia More...
 
static const Q_INVOKABLE int materiaID (materia mat)
 materiaID - The Id of a given materia More...
 
static const Q_INVOKABLE qint32 materiaAP (const quint8 ap1, const quint8 ap2, const quint8 ap3)
 materiaAP - Transform 3 bytes into a materia AP More...
 
static const Q_INVOKABLE qint32 materiaAP (const materia mat)
 materiaAP - read Ap from Materia type More...
 
static const Q_INVOKABLE qint32 materiaAP (const quint8 ap[3])
 materiaAP - Transform array into Ap More...
 
static const QIcon icon (const int id)
 
static const QPixmap pixmap (const int id)
 
static const QImage image (const int id)
 
static const Q_INVOKABLE QString iconResource (const int id)
 
static const QPixmap pixmapEmptyStar (int id)
 
static const QImage imageEmptyStar (int id)
 
static const Q_INVOKABLE QString emptyStarResource (int id)
 
static const QPixmap pixmapFullStar (int id)
 
static const QImage imageFullStar (int id)
 
static const Q_INVOKABLE QString fullStarResource (int id)
 
static const QIcon iconAllMateria ()
 
static const QImage imageAllMateria ()
 
static const Q_INVOKABLE QString imageAllResource ()
 
static const Q_INVOKABLE QString & placeHolderNameFilter ()
 
static const Q_INVOKABLE QList< int > placeHolderIdList ()
 
static bool isModID (int id)
 isModID More...
 

Static Public Attributes

static const int TotalMateria = 90
 TotalMateria - Total Number of Different Materia in the Game. More...
 
static const int MaxMateriaAp = 0xFFFFFF
 MaxMateriaAp - The Maximum Materia Ap Allowed, All materia has this Ap when "Mastered". More...
 

Static Protected Member Functions

static FF7Materiaget ()
 Get the FF7Materia Instance. More...
 

Properties

int totalMateria
 
int maxMateriaAp
 

Friends

class FF7MateriaSingleton
 

Member Enumeration Documentation

◆ MateriaName

The MateriaName enum - Name to ID Enum.

Enumerator
MpPlus 

0x00

HpPlus 

0x01

SpeedPlus 

0x02

MagicPlus 

0x03

LuckPlus 

0x04

ExpPlus 

0x05

GilPlus 

0x06

EnemyAway 

0x07

EnemyLure 

0x08

ChocoboLure 

0x09

PreEmptive 

0x0A

LongRange 

0x0B

MegaAll 

0x0C

CounterAttack 

0x0D

SlashAll 

0x0E

DoubleCut 

0x0F

Cover 

0x10

Underwater 

0x11

HPMP 

0x12

WMagic 

0x13

WSummon 

0x14

WItem 

0x15

All 

0x17

Counter 

0x18

MagicCounter 

0x19

MpTurbo 

0x1A

MpAbsorb 

0x1B

HpAbsorb 

0x1C

Elemental 

0x1D

AddedEffect 

0x1E

SneakAttack 

0x1F

FinalAttack 

0x20

AddedCut 

0x21

StealAsWell 

0x22

QuadraMagic 

0x23

Steal 

0x24

Sense 

0x25

Throw 

0x27

Morph 

0x28

Deathblow 

0x29

Manipulate 

0x2A

Mime 

0x2B

EnemySkill 

0x2C

MasterCommand 

0x30

Fire 

0x31

Ice 

0x32

Earth 

0x33

Lightning 

0x34

Restore 

0x35

Heal 

0x36

Revive 

0x37

Seal 

0x38

Mystify 

0x39

Transform 

0x3A

Exit 

0x3B

Poison 

0x3C

Demi 

0x3D

Barrier 

0x3E

Comet 

0x40

Time 

0x41

Destruct 

0x44

Contain 

0x45

FullCure 

0x46

Shield 

0x47

Ultima 

0x48

MasterMagic 

0x49

ChocoMog 

0x4A

Shiva 

0x4B

Ifrit 

0x4C

Ramuh 

0x4D

Titan 

0x4E

Odin 

0x4F

Leviathan 

0x50

Bahamut 

0x51

Kujata 

0x52

Alexander 

0x53

Phoenix 

0x54

NeoBahamut 

0x55

Hades 

0x56

Typhoon 

0x57

BahamutZERO 

0x58

KOTR 

0x59

MasterSummon 

0x5A

EmptyId 

0xFF

◆ MateriaType

The MateriaType enum - All the Materia Types.

Enumerator
AllMaterias 

0

Magic 

1

Summon 

2

Independent 

3

Support 

4

Command 

5

Member Function Documentation

◆ addedEffects()

static const Q_INVOKABLE QStringList FF7Materia::addedEffects ( const int  id)
inlinestatic

addedEffects - The Effects the materia can have when paried with "Added Effect" materia

Parameters
id- ID of Materia
Returns
The Effects the materia can have when paried with "Added Effect" materia

◆ apForLevel()

static const Q_INVOKABLE qint32 FF7Materia::apForLevel ( const int  id,
const int  level 
)
inlinestatic

apForLevel - Returns the ap needed for a materia at a level

Parameters
id- Materia Id
level- Level that you want to know the ap needed for
Returns
the ap needed for that materia to reach the level (0 if invalid)

◆ apToMax()

static const Q_INVOKABLE qint32 FF7Materia::apToMax ( const int  id)
inlinestatic

apToMax

Parameters
id- Materia Id
Returns
Ap Needed To Master the Materia

◆ dexterityChange()

static const Q_INVOKABLE qint8 FF7Materia::dexterityChange ( const int  id)
inlinestatic

dexterityChange - The Change to the dexterity stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the dexterity stat for this materia

◆ element()

static const Q_INVOKABLE QString FF7Materia::element ( const int  id)
inlinestatic

element - Get Elemental Type(s) for materia

Parameters
id- Id of materia to get the type of
Returns
An Elemental String Or QString()

◆ emptyStarResource()

static const Q_INVOKABLE QString FF7Materia::emptyStarResource ( int  id)
inlinestatic

◆ encodeMateria()

static Q_INVOKABLE materia FF7Materia::encodeMateria ( const int  id,
const qint32  ap 
)
inlinestatic

encodeMateria encode a materia

Parameters
id- Id to Encode
ap- Ap to Encode
Returns
Encoded Materia

◆ enemySkill()

static const Q_INVOKABLE QString FF7Materia::enemySkill ( const int  skill)
inlinestatic

enemySkill - Get translated string of an enemy skill

Parameters
skill- Skill Number
Returns
Name of Enemy Skill skill

◆ fullStarResource()

static const Q_INVOKABLE QString FF7Materia::fullStarResource ( int  id)
inlinestatic

◆ get()

static FF7Materia* FF7Materia::get ( )
inlinestaticprotected

Get the FF7Materia Instance.

◆ hpChange()

static const Q_INVOKABLE qint8 FF7Materia::hpChange ( const int  id)
inlinestatic

hpChange - The Change to the baseHp stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the baseHp stat for this materia

◆ icon()

static const QIcon FF7Materia::icon ( const int  id)
inlinestatic

◆ iconAllMateria()

static const QIcon FF7Materia::iconAllMateria ( )
inlinestatic

◆ iconResource()

static const Q_INVOKABLE QString FF7Materia::iconResource ( const int  id)
inlinestatic

◆ image()

static const QImage FF7Materia::image ( const int  id)
inlinestatic

◆ imageAllMateria()

static const QImage FF7Materia::imageAllMateria ( )
inlinestatic

◆ imageAllResource()

static const Q_INVOKABLE QString FF7Materia::imageAllResource ( )
inlinestatic

◆ imageEmptyStar()

static const QImage FF7Materia::imageEmptyStar ( int  id)
inlinestatic

◆ imageFullStar()

static const QImage FF7Materia::imageFullStar ( int  id)
inlinestatic

◆ isModID()

static bool FF7Materia::isModID ( int  id)
inlinestatic

isModID

Parameters
idMateria id to check
Returns
true if the id is in the range of 91 - 254 (unused but could be added by a mod)

◆ levels()

static const Q_INVOKABLE qint8 FF7Materia::levels ( const int  id)
inlinestatic

levels

Parameters
id- Materia ID
Returns
Total Number of levels for the materia

◆ luckChange()

static const Q_INVOKABLE qint8 FF7Materia::luckChange ( const int  id)
inlinestatic

luckChange - The Change to the luck stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the luck stat for this materia

◆ magicChange()

static const Q_INVOKABLE qint8 FF7Materia::magicChange ( const int  id)
inlinestatic

magicChange - The Change to the magic stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the magic stat for this materia

◆ masterCommandSkill()

static const Q_INVOKABLE QString FF7Materia::masterCommandSkill ( const int  skill)
inlinestatic

masterCommandSkill - Get translated string of the Master Command skill

Parameters
skill- Skill Number
Returns
Name of the skill

◆ masterMagicSkill()

static const Q_INVOKABLE QString FF7Materia::masterMagicSkill ( const int  skill)
inlinestatic

masterMagicSkill - Get translated string of the Master Magic skill

Parameters
skill- Skill Number
Returns
Name of the skill

◆ masterSummonSkill()

static const Q_INVOKABLE QString FF7Materia::masterSummonSkill ( const int  skill)
inlinestatic

masterSummonSkill - Get translated string of the Master Summon skill

Parameters
skill- Skill Number
Returns
Name of the skill

◆ materiaAP() [1/3]

static const Q_INVOKABLE qint32 FF7Materia::materiaAP ( const materia  mat)
inlinestatic

materiaAP - read Ap from Materia type

Parameters
mat- materia to read Ap from
Returns
qint32 value of AP
See also
FF7Materia::materiaAP(const quint8 ap1 , const quint8 ap2, const quint8 ap3), FF7Materia::materiaAP(const quint8 ap[3])

◆ materiaAP() [2/3]

static const Q_INVOKABLE qint32 FF7Materia::materiaAP ( const quint8  ap1,
const quint8  ap2,
const quint8  ap3 
)
inlinestatic

materiaAP - Transform 3 bytes into a materia AP

Parameters
ap1First Ap Byte
ap2Second Ap Byte
ap3Third Ap Byte
Returns
qint32 value of AP
See also
FF7Materia::materiaAP(const materia mat), FF7Materia::materiaAP(const quint8 ap[3])

◆ materiaAP() [3/3]

static const Q_INVOKABLE qint32 FF7Materia::materiaAP ( const quint8  ap[3])
inlinestatic

materiaAP - Transform array into Ap

Parameters
ap- 3 int array
Returns
qint32 value of AP
See also
FF7Materia::materiaAP(const quint8 ap1 , const quint8 ap2, const quint8 ap3), FF7Materia::materiaAP(const materia mat)

◆ materiaID()

static const Q_INVOKABLE int FF7Materia::materiaID ( materia  mat)
inlinestatic

materiaID - The Id of a given materia

Parameters
mat- Materia
Returns
Id of the materia.

◆ materiaLevel()

static const Q_INVOKABLE int FF7Materia::materiaLevel ( const int  id,
const quint32  ap 
)
inlinestatic

materiaLevel - Returns the ap needed for a materia at a level

Parameters
id- Materia Id
ap- the current ap of the materia
Returns
the materia current level

◆ mpChange()

static const Q_INVOKABLE qint8 FF7Materia::mpChange ( const int  id)
inlinestatic

mpChange - The Change to the baseMp stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the baseMp stat for this materia

◆ name()

static const Q_INVOKABLE QString FF7Materia::name ( const int  id)
inlinestatic

name - Name of materia

Parameters
id- Materia ID
Returns
Materia Name

◆ pixmap()

static const QPixmap FF7Materia::pixmap ( const int  id)
inlinestatic

◆ pixmapEmptyStar()

static const QPixmap FF7Materia::pixmapEmptyStar ( int  id)
inlinestatic

◆ pixmapFullStar()

static const QPixmap FF7Materia::pixmapFullStar ( int  id)
inlinestatic

◆ placeHolderIdList()

static const Q_INVOKABLE QList<int> FF7Materia::placeHolderIdList ( )
inlinestatic

◆ placeHolderNameFilter()

static const Q_INVOKABLE QString& FF7Materia::placeHolderNameFilter ( )
inlinestatic

◆ skills()

static const Q_INVOKABLE QStringList FF7Materia::skills ( const int  id)
inlinestatic

skills - Get Skill for a materia

Parameters
id- Id of Materia
Returns
List of skills the materia can have

◆ skillsForLevel()

static const Q_INVOKABLE QStringList FF7Materia::skillsForLevel ( const int  id,
const int  level 
)
inlinestatic

skills - Get Skill for a materia at a given level

Parameters
id- Id of Materia
level- Level of Materia
Returns
List of skills the materia has unlocked for that level

◆ spiritChange()

static const Q_INVOKABLE qint8 FF7Materia::spiritChange ( const int  id)
inlinestatic

spiritChange - The Change to the spirit stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the spirit stat for this materia

◆ statString()

static const Q_INVOKABLE QString FF7Materia::statString ( const int  id)
inlinestatic

statString - Get the stat changes String for a materia

Parameters
id- Materia ID
Returns
String contining stat changes when materia is equiped.

◆ strengthChange()

static const Q_INVOKABLE qint8 FF7Materia::strengthChange ( const int  id)
inlinestatic

strengthChange - The Change to the Strength stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the strength stat for this materia

◆ type()

static const Q_INVOKABLE int FF7Materia::type ( const int  id)
inlinestatic

type Get Materia Type

Parameters
id
Returns
The Type of the materia

◆ vitalityChange()

static const Q_INVOKABLE qint8 FF7Materia::vitalityChange ( const int  id)
inlinestatic

vitalityChange - The Change to the vitality stat when materia is equipped

Parameters
id- The materia id to check
Returns
The change in the vitality stat for this materia

Friends And Related Function Documentation

◆ FF7MateriaSingleton

friend class FF7MateriaSingleton
friend

Member Data Documentation

◆ MaxMateriaAp

const int FF7Materia::MaxMateriaAp = 0xFFFFFF
static

MaxMateriaAp - The Maximum Materia Ap Allowed, All materia has this Ap when "Mastered".

◆ TotalMateria

const int FF7Materia::TotalMateria = 90
static

TotalMateria - Total Number of Different Materia in the Game.

Property Documentation

◆ maxMateriaAp

int FF7Materia::maxMateriaAp

< Property Exposure For QML

◆ totalMateria

int FF7Materia::totalMateria

The documentation for this class was generated from the following file: