This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
code [2016/01/20 21:04] Mistermind [Global Events] |
code [2023/02/28 17:30] (current) FreedTerror |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== UFE Coding (Advanced) ====== | ====== UFE Coding (Advanced) ====== | ||
Besides visual tools, UFE also comes with several easy to use classes, events and methods all done in C#.\\ | 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 '' | + | You can find usage examples under '' |
- | Explanation on how to use the code can be found down below. | + | |
Line 11: | Line 10: | ||
/* Subscribe to UFE events: | /* Subscribe to UFE events: | ||
* Possible Events: | * Possible Events: | ||
- | * OnLifePointsChange(float newLifePoints, | + | * OnLifePointsChange(float newLifePoints, |
- | * OnNewAlert(string | + | * OnNewAlert(string |
- | * OnHit(MoveInfo move, CharacterInfo hitter) | + | * OnHit(HitBox strokeHitBox, |
- | * OnMove(MoveInfo move, CharacterInfo | + | * OnBlock(HitBox strokeHitBox, |
- | * OnRoundEnds(CharacterInfo | + | * OnParry(HitBox strokeHitBox, |
+ | * OnMove(MoveInfo move, ControlsScript | ||
+ | * OnRoundEnds(ControlsScript | ||
* OnRoundBegins(int roundNumber) | * OnRoundBegins(int roundNumber) | ||
- | * OnGameEnds(CharacterInfo | + | * OnGameEnds(ControlsScript |
- | * OnGameBegins(CharacterInfo | + | * OnGameBegins(ControlsScript |
* | * | ||
* usage: | * usage: | ||
Line 26: | Line 27: | ||
* void YourFunctionHere(T param1, T param2){...} | * void YourFunctionHere(T param1, T param2){...} | ||
* | * | ||
- | * The following code bellow show more usage examples | + | * The following code shows more usage examples |
*/ | */ | ||
UFE.OnGameBegin += this.OnGameBegin; | UFE.OnGameBegin += this.OnGameBegin; | ||
Line 36: | Line 37: | ||
UFE.OnNewAlert += this.OnNewAlert; | UFE.OnNewAlert += this.OnNewAlert; | ||
UFE.OnHit += this.OnHit; | UFE.OnHit += this.OnHit; | ||
+ | UFE.OnBlock += this.OnBlock; | ||
+ | UFE.OnParry += this.OnParry; | ||
UFE.OnMove += this.OnMove; | UFE.OnMove += this.OnMove; | ||
UFE.OnTimer += this.OnTimer; | UFE.OnTimer += this.OnTimer; | ||
Line 46: | Line 49: | ||
} | } | ||
- | public void OnGameBegin(CharacterInfo | + | void OnDisable{ |
- | Debug.Log(player1.character.characterName + " - " player1.playerNum); | + | // Make sure to unsubscribe from events |
- | Debug.Log(player2.character.characterName + " - " player2.playerNum); | + | UFE.OnHit -= this.OnHit; |
+ | } | ||
+ | |||
+ | void OnDestroy{ | ||
+ | // Make sure to unsubscribe from events | ||
+ | UFE.OnHit -= this.OnHit; | ||
+ | } | ||
+ | |||
+ | public void OnGameBegin(ControlsScript | ||
+ | Debug.Log(player1.myInfo.characterName + " - " player1.playerNum); | ||
+ | Debug.Log(player2.myInfo.characterName + " - " player2.playerNum); | ||
UFE.PlayMusic(stage.music); | UFE.PlayMusic(stage.music); | ||
Line 58: | Line 71: | ||
Use these to listen to several in-game events. | Use these to listen to several in-game events. | ||
- | <code c#>void OnLifePointsChange(float | + | <code c#>void OnLifePointsChange(float |
> Triggered when the a character' | > Triggered when the a character' | ||
- | <code c#>void OnNewAlert(string | + | <code c#>void OnGaugeUpdate(int targetGauge, |
+ | > Triggered when the a character' | ||
+ | |||
+ | <code c#>void OnNewAlert(string | ||
> Triggered when the game fires a new alert (first hit, combo, round 1, etc.). | > Triggered when the game fires a new alert (first hit, combo, round 1, etc.). | ||
- | <code c#>void OnHit(HitBox strokeHitBox, | + | <code c#>void OnHit(HitBox strokeHitBox, |
> Triggered whenever a character gets hit. | > Triggered whenever a character gets hit. | ||
- | <code c#>void OnBlock(HitBox strokeHitBox, | + | <code c#>void OnBlock(HitBox strokeHitBox, |
> Triggered whenever a character blocks. | > Triggered whenever a character blocks. | ||
- | <code c#>void OnParry(HitBox strokeHitBox, | + | <code c#>void OnParry(HitBox strokeHitBox, |
> Triggered whenever a character parries. | > Triggered whenever a character parries. | ||
- | <code c#>void OnMove(MoveInfo move, CharacterInfo | + | <code c#>void OnMove(MoveInfo move, ControlsScript |
> Triggered whenever a new move is cast by a character. | > Triggered whenever a new move is cast by a character. | ||
- | <code c#> | + | <code c#> |
- | > Triggered | + | > Triggered |
+ | |||
+ | <code c#>void OnButton(ButtonPress button, ControlsScript player)</ | ||
+ | > Triggered whenever a button is pressed. | ||
+ | |||
+ | <code c#>void OnBodyVisibilityChange(MoveInfo move, ControlsScript player, BodyPartVisibilityChange bodyPartVisibilityChange, | ||
+ | > Triggered whenever [[move: | ||
+ | |||
+ | <code c#>void OnParticleEffects(MoveInfo move, ControlsScript player, MoveParticleEffect particleEffects)</ | ||
+ | > Triggered whenever [[move: | ||
<code c#>void OnRoundBegins(int roundNumber)</ | <code c#>void OnRoundBegins(int roundNumber)</ | ||
> Triggered when the round begins. | > Triggered when the round begins. | ||
- | <code c#>void OnGameBegins(CharacterInfo | + | <code c#>void OnGameBegins(ControlsScript |
> Triggered when the game begins. | > Triggered when the game begins. | ||
- | <code c#>void OnGameEnds(CharacterInfo | + | <code c#>void OnGameEnds(ControlsScript |
> Triggered when the game ends. Use '' | > Triggered when the game ends. Use '' | ||
+ | <code c#>void OnTimer(Fix64 time)</ | ||
+ | > Triggered whenever the timer ticks and returns the current timer value (Fix64). | ||
- | <code c#> | + | <code c#> |
- | > Triggered | + | > Triggered |
+ | <code c#>void OnInput(InputReferences[] inputReferences, | ||
+ | > Triggered whenever a player presses a button. | ||
---- | ---- | ||
Line 97: | Line 126: | ||
You can find examples on all these under the following folders: | You can find examples on all these under the following folders: | ||
- | '' | + | '' |
'' | '' | ||
Line 146: | Line 175: | ||
<code c#> | <code c#> | ||
> Fades from the current loaded screen to the [[global: | > Fades from the current loaded screen to the [[global: | ||
+ | |||
+ | <code c#> | ||
+ | > Sets the difficulty level for the [[ai: | ||
Line 300: | Line 332: | ||
- | <code c#>UFE.isPaused(bool pause)</ | + | <code c#>UFE.IsPaused()</ |
> Is the game paused? | > Is the game paused? | ||
Line 313: | Line 345: | ||
- | With the project open, use MonoDevelop' | + | With the project open, use IntelliSense |
---- | ---- | ||
[[: | [[: |