User:Pixloen/FPANModding/Classes and Methods

Terminology Guide

Terminology
Disclaimer: Writer pixloen has no idea what she's talking about.
void	Nothing needs to be put into the brackets of the function. Usually reserved for functions that return a value.
int	An integer can be supplied.
float	A float can be supplied.
string	A line of text surrounded by ".
text	A line of text. Not surrounded by ".
flags	Flags that can change properties can be supplied. If more than one is specified, they are to be separated using a vertical slash.

Classes and Methods

BMvEff

BG_GetNum()

BG_GetNum( void )

---

Returns the background number.

---

CockpitSetView()

CockpitSetView({ mode = int })

---

Creates an object that has properties based on the array. Not all of the above properties are needed.

---

int mode = whether to enable the Cockpit (1 or 0).

CreateObject()

CreateObject({ x = int , y = int , pat = int , start_pat = int , mvname = string , flags = flags })

---

Creates an object that has properties based on the array. Not all of the above properties are needed.

---

int x = X position of the object.

int y = Y position of the object.
int pat = Sets the pattern based on it's number in the HA6.
int start_pat = Sets the pattern based on it's number in the HA6.
string mvname = Sets the mv clause based on the name. e.g. mvname = "Mv_Startup"

flags flags = Assigns the object flags.

SetCharaColor()

SetCharaColor({ color = color, intime = int, time = int, outtime = int, type = int })

---

Adds a color effect to the player's sprite. Does not apply to effects or objects spawned by the player.

---

BMvTbl

CBtlInfo()

CBtlInfo( void )

---

Collects info about the current battle.

---

CBtlInfo.GetSelectBgm()

CBtlInfo.GetSelectBgm( void )

---

Returns the current BGM number. -2 is Off / MUTE.

---

CBtlInfo.IsSelectBgm()

CBtlInfo.IsSelectBgm( void )

---

Whether the current playing BGM was player-chosen. Returns a bool.

---

CBtlInfo.SetSelectBgm()

CBtlInfo.SetSelectBgm( int number )

---

Sets the BGM.

---

int number: The BGM number to play.

GetMuki()

GetMuki( void )

---

Returns the facing direction of the object as either -1 or 1 (facing left and right respectively).

---

GetPlayerSide()

GetPlayerSide( void )

---

Returns the player side, as either 0 or 1 (Player 1 and Player 2 respectively).

---

SetMuki()

SetMuki( type direction )

---

Sets the facing direction of the object. type direction: _Direction_Left, _Direction_Right, _Direction_Auto, _Direction_Reverse

---

SetPattern()

SetPattern( int number or string name )

---

Sets the pattern of the object.

---

int number: Sets the pattern based on it's number in the HA6. string name: Sets the pattern based on the code name in the HA6.