Modules/game pawn/Usage - Revision history

Aoineko at 23:20, 18 April 2024

2024-04-18T23:20:04Z

2024-04-18T23:19:39Z

2024-04-18T23:19:07Z

‎Initialize pawn

2024-04-18T23:18:46Z

2024-04-18T23:16:40Z

2024-04-18T21:38:19Z

2024-04-18T17:20:51Z

2024-04-18T17:20:10Z

2024-04-18T17:19:58Z

2024-04-18T17:03:48Z

‎Define pawn's sprites

@@ Line 3: / Line 3: @@
 '''Example:'''
 A two color sprite (2 layer): ‎<syntaxhighlight lang="C">
 const Game_Sprite g_SpriteLayers[] =
@@ Line 41: / Line 40: @@
 All pawn management is carried out via a Game_Pawn structure (each pawn must have its own structure).
 Once the sprite and animation data have been defined, the pawn must be initialized.
 ‎'''Examples:''' ‎‎<syntaxhighlight lang="c">GamePawn_Initialize(&g_PlayerPawn, g_SpriteLayers, numberof(g_SpriteLayers), 0, g_AnimActions); // Initialize pawn structure
 GamePawn_SetPosition(&g_PlayerPawn, 16, 16); // Set pawn position</syntaxhighlight>
@@ Line 50: / Line 50: @@
 * one that determines whether a given block of background is a blocker or not,
 * and the other which receives collision-related events (touching the screen edge, falling, etc.).
 '''Examples:''' ‎‎<syntaxhighlight lang="c">// Physics callback
 void PhysicsEvent(u8 event, u8 tile)

@@ Line 41: / Line 41: @@
 All pawn management is carried out via a Game_Pawn structure (each pawn must have its own structure).
 Once the sprite and animation data have been defined, the pawn must be initialized.
+‎'''Examples:''' ‎‎<syntaxhighlight lang="c">GamePawn_Initialize(&g_PlayerPawn, g_SpriteLayers, numberof(g_SpriteLayers), 0, g_AnimActions); // Initialize pawn structure
 GamePawn_SetPosition(&g_PlayerPawn, 16, 16); // Set pawn position</syntaxhighlight>
@@ Line 51: / Line 50: @@
 * one that determines whether a given block of background is a blocker or not,
 * and the other which receives collision-related events (touching the screen edge, falling, etc.).
 '''Examples:''' ‎‎<syntaxhighlight lang="c">// Physics callback
 void PhysicsEvent(u8 event, u8 tile)

@@ Line 44: / Line 44: @@
 ‎<syntaxhighlight lang="c">GamePawn_Initialize(&g_PlayerPawn, g_SpriteLayers, numberof(g_SpriteLayers), 0, g_AnimActions); // Initialize pawn structure
 GamePawn_SetPosition(&g_PlayerPawn, 16, 16); // Set pawn position</syntaxhighlight>
 === Initialize pawn ===

← Older revision		Revision as of 23:18, 18 April 2024
Line 75:		Line 75:
	/* ... */		/* ... */

−	GamePawn_InitializePhysics(&g_PlayerPawn, PhysicsEvent, PhysicsCollision, 16, 16); // ‎</syntaxhighlight>	+	GamePawn_InitializePhysics(&g_PlayerPawn, PhysicsEvent, PhysicsCollision, 16, 16); // ‎Initialize pawn physics</syntaxhighlight>

@@ Line 24: / Line 24: @@
 	{ 24,	4,	NULL },
 };‎</syntaxhighlight>
 === Define pawn's actions ===
@@ Line 37: / Line 36: @@
 	{ g_FramesPunch, numberof(g_FramesFall), FALSE, FALSE }, // Play once, can't be interrupted
 };‎</syntaxhighlight>

@@ Line 16: / Line 16: @@
 '''Example:'''
 Push animation with function to trigger ‎<syntaxhighlight lang="C">
-const Game_Frame g_FramePunch[] =
+const Game_Frame g_FramesPunch[] =
+{
 	{ 0,	4,	NULL}, // Display pattern 0 for 4 render cycles
@@ Line 32: / Line 32: @@
 const Game_Action g_AnimActions[] =
 { //  Frames        Number                  Loop?  Interrupt?
-	{ g_FramesIdle, numberof(g_FramesIdle), TRUE,  TRUE },
+	{ g_FramesIdle,  numberof(g_FramesIdle), TRUE,  TRUE },
-	{ g_FramesMove, numberof(g_FramesMove), TRUE,  TRUE },
+	{ g_FramesMove,  numberof(g_FramesMove), TRUE,  TRUE },
-	{ g_FramesJump, numberof(g_FramesJump), TRUE,  TRUE },
+	{ g_FramesJump,  numberof(g_FramesJump), TRUE,  TRUE },
-	{ g_FramePunch, numberof(g_FramesFall), FALSE, FALSE }, // Play once, can't be interrupted
+	{ g_FramesPunch, numberof(g_FramesFall), FALSE, FALSE }, // Play once, can't be interrupted
 };‎</syntaxhighlight>

@@ Line 1: / Line 1: @@
 === Define pawn's sprites ===
-The visual of a pawn is defined by one or more sprite layers. The <tt>Game_Sprite</tt> structure allows to define the parameters of each layer : The X/Y position of the layer relative to the Pawn, the pattern number offset from the pattern number defined in the animation, the sprite color and a special flag for display.
+The visual of a pawn is defined by one or more sprite layers. The <tt>Game_Sprite</tt> structure allows to define the parameters of each layer : The X/Y offset of the layer relative to the Pawn position, the pattern number offset from the pattern number defined in the animation, the sprite color and a special flag for display.
 '''Example:'''