Difference between revisions of "Modules/game pawn"

From MSX Game Library

< Modules

Line 13: Line 13:
  
 
=== Define pawn's sprites ===
 
=== Define pawn's sprites ===
The visual of a pawn is displayed by one or more sprite layers. The 'Game_Sprite' structure allows to define the parameters of each layer.
+
The visual of a pawn is displayed 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.
  
==== Examples ====
+
'''Examples:'''
  
 
Simple color sprite (1 layer): ‎<syntaxhighlight lang="C">
 
Simple color sprite (1 layer): ‎<syntaxhighlight lang="C">
Line 41: Line 41:
 
};
 
};
 
‎</syntaxhighlight>
 
‎</syntaxhighlight>
 +
 +
=== Define pawn's animations ===
 +
 +
 +
'''Examples:'''

Revision as of 13:54, 14 February 2022

The game_pawn module handle character animation, rendering, collision and physics.

This module offer several structures the user can use to configure a pawn (a player, an enemy or any moving object) for rendering (multi-layers and flip/flap) and movement.

Dependencies

Settings

GAMEPAWN_USE_PHYSICS: Include collision and physics handling functions.

Usage

Define pawn's sprites

The visual of a pawn is displayed by one or more sprite layers. The Game_Sprite 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.

Examples:

Simple color sprite (1 layer): ‎
const Game_Sprite g_SpriteLayers[] =
{
	{ 0, 0, 0,  COLOR_WHITE, 0 }, // Sprite position offset: 0,0. Pattern offset: 0. Color: White. No special flag
};
‎
Two color sprite (2 layer): ‎
const Game_Sprite g_SpriteLayers[] =
{
	{ 0, 0, 0,  COLOR_WHITE, 0 }, // Sprite position offset: 0,0. Pattern offset: 0. Color: White. No special flag
	{ 0, -8, 4,  COLOR_GRAY, 0 }, // Sprite position offset: 0,-8. Pattern offset: 4. Color: Gray. No special flag
};
‎
3 layers sprite with auto-switch (to generate more color by flickering) ‎
const Game_Sprite g_SpriteLayers[] =
{
	{ 0, 0, 0,  COLOR_BLACK, PAWN_SPRITE_EVEN }, // Sprite used only on 'even' frame number
	{ 0, 0, 12, COLOR_BLACK, PAWN_SPRITE_ODD }, // Sprite used only on 'odd' frame number
	{ 0, 0, 4,  COLOR_WHITE, 0 },
	{ 0, 0, 8,  COLOR_LIGHT_RED, 0 },
};
‎

Define pawn's animations

Examples: