User:Pixloen/FPANModding/Classes and Methods: Difference between revisions
< User:Pixloen | FPANModding
Jump to navigation
Jump to search
No edit summary |
(added terminology guide for new modders) |
||
| Line 10: | Line 10: | ||
--> | --> | ||
= Terminology Guide = | |||
<!-- | |||
note: i don't actually know what im talking about here. i'm basing this off of several other documentations ive read | |||
--> | |||
{| class="wikitable mw-collapsible mw-collapsed" style="width:60%" | |||
|- | |||
! colspan="2" | Terminology | |||
|- | |||
| colspan="2" |'''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== | ==BMvEff== | ||
| Line 22: | Line 55: | ||
''int'' start_pat = Sets the pattern based on it's number in the HA6.<br /> | ''int'' start_pat = Sets the pattern based on it's number in the HA6.<br /> | ||
''string'' mvname = Sets the mv clause based on the name. e.g. <code>mvname = "Mv_Startup"</code><br /> | ''string'' mvname = Sets the mv clause based on the name. e.g. <code>mvname = "Mv_Startup"</code><br /> | ||
''flags'' flags = Assigns the object flags. | ''flags'' flags = Assigns the object flags. | ||
}} | }} | ||
Revision as of 09:45, 21 December 2023
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
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"
BMvTbl
GetPlayerSide( void )Returns the player side, as either 0 or 1 (Player 1 and Player 2 respectively).
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.SetMuki( type direction )Sets the facing direction of the object.
type direction:
_Direction_Left, _Direction_Right, _Direction_Auto, _Direction_ReverseGetMuki( void )Returns the facing direction of the object as either -1 or 1 (facing left and right respectively).
CBtlInfo
CBtlInfo( void )Collects info about the current battle.
CBtlInfo.IsSelectBgm( void )Whether the current playing BGM was player-chosen. Returns a bool.
CBtlInfo.SetSelectBgm( int number )Sets the BGM.
int number: The BGM number to play.
CBtlInfo.GetSelectBgm( void )Returns the current BGM number. -2 is Off / MUTE.
