User:Pixloen/FPANModding/Classes and Methods: Difference between revisions

From Mizuumi Wiki
Jump to navigation Jump to search
(start of the page)
 
No edit summary
Line 10: Line 10:


-->
-->
==BMvEff==
{{MFPG Content Box
|header=CreateObject({ x = ''int'' , y = ''int'' , pat = ''int'' , start_pat = ''int'' , mvname = ''string'' , flags = ''flags'' })
|content=
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.<br />
''int'' y = Y position of the object.<br />
''int'' 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 />
''flags'' flags = Assigns the object flags. Flags are to be seperated with {{!}}. e.g. <code>flags=_ObjFlags_NoRender_{{!}}ObjFlags_NoGround</code>
}}
==BMvTbl==
==BMvTbl==


Line 16: Line 31:
|content=
|content=
Returns the player side, as either 0 or 1 (Player 1 and Player 2 respectively).
Returns the player side, as either 0 or 1 (Player 1 and Player 2 respectively).
}}<!--
}}{{MFPG Content Box
 
|header=SetPattern( ''int'' number '''or''' ''string'' name )
-->{{MFPG Content Box
|header=SetPattern( ''int'' number / "string" name )
|content=
|content=
Sets the pattern of the object.
Sets the pattern of the object.
''int'' number: Sets the pattern based on it's number in the HA6.
''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.
''string'' name: Sets the pattern based on the code name in the HA6.
}}<!--
}}{{MFPG Content Box
 
-->{{MFPG Content Box
|header=SetMuki( ''type'' direction )
|header=SetMuki( ''type'' direction )
|content=
|content=
Sets the facing direction of the object.
Sets the facing direction of the object.
''type'' direction: <code>_Direction_Left, _Direction_Right, _Direction_Auto, _Direction_Reverse</code>
''type'' direction: <code>_Direction_Left, _Direction_Right, _Direction_Auto, _Direction_Reverse</code>
}}<!--
}}{{MFPG Content Box
 
-->{{MFPG Content Box
|header=GetMuki( ''void'' )
|header=GetMuki( ''void'' )
|content=
|content=
Returns the facing direction of the object as either -1 or 1 (facing left and right respectively).
Returns the facing direction of the object as either -1 or 1 (facing left and right respectively).
}}<!--
}}


===CBtlInfo===


-->
===CBtlInfo===
{{MFPG Content Box
{{MFPG Content Box
|header=CBtlInfo( ''void'' )
|header=CBtlInfo( ''void'' )
|content=
|content=
Collects info about the current battle.
Collects info about the current battle.
}}<!--
}}{{MFPG Content Box
 
-->{{MFPG Content Box
|header=CBtlInfo.IsSelectBgm( ''void'' )
|header=CBtlInfo.IsSelectBgm( ''void'' )
|content=
|content=
Whether the current playing BGM was player-chosen. Returns a bool.
Whether the current playing BGM was player-chosen. Returns a bool.
}}<!--
}}{{MFPG Content Box
 
|header=CBtlInfo.SetSelectBgm( ''int'' number )
-->{{MFPG Content Box
|content=
Sets the BGM.
''int'' number: The BGM number to play.
}}{{MFPG Content Box
|header=CBtlInfo.GetSelectBgm( ''void'' )
|header=CBtlInfo.GetSelectBgm( ''void'' )
|content=
|content=
Returns the current BGM number. -2 is Off / MUTE.
Returns the current BGM number. -2 is Off / MUTE.
}}
}}
== Navigation ==
== Navigation ==


{{Navbox-MFPG}}
{{Navbox-MFPG}}
[[Category:Modding French Bread Games]]
[[Category:Modding French Bread Games]]

Revision as of 09:27, 21 December 2023

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"

flags flags = Assigns the object flags. Flags are to be seperated with |. e.g. flags=_ObjFlags_NoRender_|ObjFlags_NoGround


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_Reverse

GetMuki( 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.


Navigation

For Beginners
Getting Started
File Structure
Installing Mods
Example Mods
Glossary
Links & Resources
File Formats & Software Guide
Hantei-chan
CGTOOL & CGLIB
.pat Effects
Palettes
DDS Images
Engine Documentation
Audio
Backgrounds
Classes and Methods
Cutscenes
D File Folder
Functions
Shaders
Quick Start
Getting Started
Installing Mods
Mods List
Guides
Character File Setup
Using Hantei-chan
Character Scripts
Miscellaneous
Dialogue
HUD and UI
Stages
Audio
Battle Scripts
CG & Patterns
Editng Vectors
Define
Documentation
Classes and Methods
Functions
HA6 Pattern Reference
UNI2 Modding Notes