====== UFE Coding (Advanced) ======
Besides visual tools, UFE also comes with several easy to use classes, events and methods all done in C#.\\
You can find usage examples under ''UFE\Engine\Scripts\UI\Base\BattleGUI.cs'' ([[prices|Source]]) and ''UFE\Engine\Scripts\UI\Templates\DefaultBattleGUI.cs''.\\


----
===== Example =====
<code c#>
void OnAwake(){
	/* Subscribe to UFE events:
	 * Possible Events:
	 * OnLifePointsChange(float newLifePoints, ControlsScript player)
	 * OnNewAlert(string newString, ControlsScript player)
	 * OnHit(HitBox strokeHitBox, MoveInfo move, Hit hitInfo, ControlsScript player)
	 * OnBlock(HitBox strokeHitBox, MoveInfo move, Hit hitInfo, ControlsScript player)
	 * OnParry(HitBox strokeHitBox, MoveInfo move, Hit hitInfo, ControlsScript player)
	 * OnMove(MoveInfo move, ControlsScript player)
	 * OnRoundEnds(ControlsScript winner, ControlsScript loser)
	 * OnRoundBegins(int roundNumber)
	 * OnGameEnds(ControlsScript winner, ControlsScript loser)
	 * OnGameBegins(ControlsScript player1, ControlsScript player2, StageOptions stage)
	 * 
	 * usage:
	 * UFE.OnMove += YourFunctionHere;
	 * .
	 * .
	 * void YourFunctionHere(T param1, T param2){...}
	 * 
	 * The following code shows more usage examples
	 */
	UFE.OnGameBegin += this.OnGameBegin;
	UFE.OnGameEnds += this.OnGameEnd;
	UFE.OnGamePaused += this.OnGamePaused;
	UFE.OnRoundBegins += this.OnRoundBegin;
	UFE.OnRoundEnds += this.OnRoundEnd;
	UFE.OnLifePointsChange += this.OnLifePointsChange;
	UFE.OnNewAlert += this.OnNewAlert;
	UFE.OnHit += this.OnHit;
	UFE.OnBlock += this.OnBlock;
	UFE.OnParry += this.OnParry;
	UFE.OnMove += this.OnMove;
	UFE.OnTimer += this.OnTimer;
	UFE.OnTimeOver += this.OnTimeOver;
	UFE.OnInput += this.OnInput;
}

void OnStart(){
	UFE.StartIntroScreen(1f);
}

void OnDisable{
// Make sure to unsubscribe from events
	UFE.OnHit -= this.OnHit;
}

void OnDestroy{
// Make sure to unsubscribe from events
	UFE.OnHit -= this.OnHit;
}

public void OnGameBegin(ControlsScript player1, ControlsScript player2, StageOptions stage){
	Debug.Log(player1.myInfo.characterName + " - " player1.playerNum);
	Debug.Log(player2.myInfo.characterName + " - " player2.playerNum);

	UFE.PlayMusic(stage.music);
}
</code>

----
===== Global Events =====
Use these to listen to several in-game events.

<code c#>void OnLifePointsChange(float newFloat, ControlsScript player)</code>
> Triggered when the a character's life points change.

<code c#>void OnGaugeUpdate(int targetGauge, float newValue, ControlsScript character)</code>
> Triggered when the a character's gauge meter change.

<code c#>void OnNewAlert(string newString, ControlsScript player)</code>
> Triggered when the game fires a new alert (first hit, combo, round 1, etc.).

<code c#>void OnHit(HitBox strokeHitBox, MoveInfo move, Hit hitInfo, ControlsScript player)</code>
> Triggered whenever a character gets hit.

<code c#>void OnBlock(HitBox strokeHitBox, MoveInfo move, Hit hitInfo, ControlsScript player)</code>
> Triggered whenever a character blocks.

<code c#>void OnParry(HitBox strokeHitBox, MoveInfo move, Hit hitInfo, ControlsScript player)</code>
> Triggered whenever a character parries.

<code c#>void OnMove(MoveInfo move, ControlsScript player)</code>
> Triggered whenever a new move is cast by a character.

<code c#>void OnBasicMove(BasicMoveReference basicMove, ControlsScript player)</code>
> Triggered whenever a basic move is cast by a character.

<code c#>void OnButton(ButtonPress button, ControlsScript player)</code>
> Triggered whenever a button is pressed.

<code c#>void OnBodyVisibilityChange(MoveInfo move, ControlsScript player, BodyPartVisibilityChange bodyPartVisibilityChange, HitBox hitBox)</code>
> Triggered whenever [[move:bodypartsvisibilitychanges|Body Parts Visibility Changes]] is casted.

<code c#>void OnParticleEffects(MoveInfo move, ControlsScript player, MoveParticleEffect particleEffects)</code>
> Triggered whenever [[move:particleeffects|Particle Effects]] is casted in a move.

<code c#>void OnRoundBegins(int roundNumber)</code>
> Triggered when the round begins.

<code c#>void OnGameBegins(ControlsScript player1, ControlsScript player2, StageOptions stage)</code>
> Triggered when the game begins.

<code c#>void OnGameEnds(ControlsScript winner, ControlsScript loser)</code>
> Triggered when the game ends. Use ''winner.playerNum'' or ''loser.playerNum'' to know which player is which.

<code c#>void OnTimer(Fix64 time)</code>
> Triggered whenever the timer ticks and returns the current timer value (Fix64).

<code c#>void OnTimeOver()</code>
> Triggered when timer runs out.

<code c#>void OnInput(InputReferences[] inputReferences, int player)</code>
> Triggered whenever a player presses a button.

----
===== Public Methods =====
You can find examples on all these under the following folders:

''.\Core\Scripts\UI\Base\'' ([[prices|UFE Source and Bundle]])\\
''.\Scripts\UI\Templates\'' (Any version)\\

Note: All screen transition methods use the //Default Fade Duration// value under [[global:gui|Global Editor -> GUI Options]]. You can override this value by typing the time (in seconds) as a parameter. Example:
<code c#>
void OnStart(){
	//Fades for 3 seconds before reaching the Main Menu:
	UFE.StartMainMenuScreen(3f);
}
</code>

\\
==== Main ====
<code c#>UFE.StartMainMenuScreen()</code>
> Fades from the current loaded screen (if any) to the [[global:gui#main|main menu screen]].


<code c#>UFE.StartOptionsScreen()</code>
> Fades from the current loaded screen to the [[global:gui#main|options screen]].


<code c#>UFE.StartCharacterSelectionScreen()</code>
> Fades from the current loaded to the [[global:gui#main|selected character selection screen]].


<code c#>UFE.StartStageSelectionScreen()</code>
> Fades from the current loaded screen to the [[global:gui#main|stage selection screen]].


<code c#>UFE.StartTrainingMode()</code>
> Starts the [[global:gui#main|character selection screen]] and sets ''UFE.gameMode'' to ''GameMode.TrainingMode''. See [[global:trainingmode|Training Mode Options]] for more information.


<code c#>UFE.StartLoadingBattleScreen()</code>
> Fades to [[global:gui|loading screen]] before starting the game. Its recommended you load the game this way, specially if you are using the [[global:preload|Preload Options]]. Calling this function will use the current defined ''GameMode'' and characters selected.


<code c#>UFE.StartGame()</code>
> Skips the loading screens and fades to the game screen instantly. Calling this function will use the current defined ''GameMode'' and characters selected.


\\
==== Extras ====
<code c#>UFE.StartIntroScreen()</code>
> Fades from the current loaded screen (if any) to the [[global:gui#extras|selected intro screen]].


<code c#>UFE.StartCreditsScreen()</code>
> Fades from the current loaded screen to the [[global:gui#extras|selected credits screen]].

<code c#>UFE.SetAIDifficulty(AIDifficultyLevel)</code>
> Sets the difficulty level for the [[ai:start|current AI]].


<code c#>UFE.Quit()</code>
> Quits the application.


\\
==== Versus ====
<code c#>UFE.StartPlayerVersusPlayer()</code>
> Starts the [[global:gui#main|character selection screen]] and sets ''UFE.gameMode'' to ''GameMode.VersusMode''.


<code c#>UFE.StartCpuVersusCpu()</code>
> Starts the [[global:gui#main|character selection screen]] with UFE.SetCPU set to ''true'' for both players. It also sets ''UFE.gameMode'' to ''GameMode.VersusMode''.


<code c#>UFE.StartPlayerVersusCpu()</code>
> Starts the [[global:gui#main|character selection screen]] with UFE.SetCPU set to ''true'' for player 2. It also sets ''UFE.gameMode'' to ''GameMode.VersusMode''.


<code c#>UFE.StartVersusModeAfterBattleScreen()</code>
> Starts the option menu that shows after a match on //Versus Mode//.


\\
==== Story ====
<code c#>UFE.StartStoryMode()</code>
> Starts the [[global:gui#main|character selection screen]] and sets ''UFE.gameMode'' to ''GameMode.StoryMode''. During //Story Mode// ''UFE.SetCPU'' is set to ''true'' for player 2 and it runs a series of battles listed under [[global:storymode|Story Mode options]] while following the intro and outro instructions. All subsequent functions are executed automatically after this.


<code c#>UFE.StartStoryModeOpeningScreen()</code>
> (*) Starts the [[global:storymode|opening]] screen. This function is automatically called after player selects the character on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeBattle()</code>
> (*) Starts the next battle listed on the [[global:storymode|story]] of this character. This function is automatically called after every conversation on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeContinueScreen()</code>
> (*) Starts the [[global:storymode|continue]] screen. This function is automatically called after the player loses a match on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeConversationBeforeBattleScreen(UFEScreen conversationScreen)</code>
> (*) Starts the conversation before battle listed on the [[global:storymode|story]] for this match. This function is automatically called after each battle on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeConversationAfterBattleScreen(UFEScreen conversationScreen)</code>
> (*) Starts the conversation after battle listed on the [[global:storymode|story]] for this match. This function is automatically called after each battle on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeCongratulationsScreen()</code>
> (*) Starts the [[global:storymode|congratulation]] screen. This function is automatically called after the player defeats all the opponents on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeEndingScreen()</code>
> (*) Starts the [[global:storymode|ending]] screen. This function is automatically called after the congratulations screen on ''GameMode.StoryMode''.


<code c#>UFE.StartStoryModeGameOverScreen()</code>
> (*) Starts the [[global:storymode|game over]] screen. This function is automatically called after the continue screen timer runs out on ''GameMode.StoryMode''.

<sub>* These methods are used mostly internally. Make sure you know what you are doing before calling them!</sub>



\\
==== Core Control ====
<code c#>UFE.SetPlayer1(CharacterInfo player1)</code>
> Sets the player 1 character (CharacterInfo class).


<code c#>UFE.GetPlayer1()</code>
> Returns the player 1 selected character (CharacterInfo class).


<code c#>UFE.SetPlayer2(CharacterInfo player2)</code>
> Sets the player 2 character (CharacterInfo class).


<code c#>UFE.GetPlayer2()</code>
> Returns the player 2 selected character (CharacterInfo class).


<code c#>UFE.SetCPU(int player, bool cpuEnabled)</code>
> Set if ''player'' (1 or 2) is controlled by the [[global:aioptions|A.I. engine]] or a human player. Make sure you set this method //before// the battle begins.


<code c#>UFE.SetLanguage(string language)</code>
> Set the language to one of the listed [[global:languages|languages]].


<code c#>UFE.SetStage(string stageName)</code>
> Set the selected stage to one of the listed [[global:stages|stages]].


<code c#>UFE.GetStage()</code>
> Set the selected stage (StageOptions class).


<code c#>UFE.GetFont(FontId fontId)</code>
> (//Deprecated//) Returns the font (FontOptions class) based on the provided id (FontId enum) (as defined under [[global:fonts|global editor's fonts]]).


<code c#>UFE.GetCurrentMoveSet(CharacterInfo character)</code>
> Returns the current selected move set (MoveSetData class) from the provided character.


<code c#>UFE.SetLifePoints(float newValue, CharacterInfo character)</code>
> Set player's life points.


<code c#>UFE.FireAlert(string alertMessage, CharacterInfo character)</code>
> Fire a new game alert. If you are using ''GUIScript.cs'', the character provided will represent the side it will come out.


<code c#>UFE.GetMusic()</code>
> Is the music on or off.


<code c#>UFE.SetMusic(bool on)</code>
> Sets music on/off.


<code c#>UFE.LoopMusic(bool loop)</code>
> Sets music looping mode on/off.

<code c#>UFE.GetSoundFX()</code>
> Is the sound fx on/off.


<code c#>UFE.SetSoundFX(bool on)</code>
> Sets sound fx on/off.


<code c#>UFE.GetVolume()</code>
> Gets audio volume.


<code c#>UFE.SetVolume(float volume)</code>
> Sets audio volume.


<code c#>UFE.GetInputReference(ButtonPress button, InputReferences[] inputReferences)</code>
> Get Unity Input Manager's button reference based on an UFE assigned Key.


<code c#>UFE.PlaySound(AudioClip sound)</code>
> Play a sound FX once (sound fx must be toggled on)


<code c#>UFE.PauseGame(bool pause)</code>
> Pause Game.


<code c#>UFE.IsPaused()</code>
> Is the game paused?


----
===== Public Variables =====
All public variables defined on the editors can be found and manipulated live using the following classes:

  * Global data: ''UFE.config''
  * Character data: ''UFE.config.player1Character'' or ''UFE.config.player2Character''
  * Move data: ''UFE.config.player1Character.moves'' or ''UFE.config.player2Character.moves''


With the project open, use IntelliSense to reach the desired variable.

----

[[:start|< Back to Universal Fighting Engine - Introduction]]