surfaces.h File Reference

Go to the source code of this file.

Enumerations
enum	SurfaceWalkEffect { SURFACE_WALK_FX_STANDARD , SURFACE_WALK_FX_SPARKLE }

Functions
void	player_surface_spawn_fx (void)
void	surface_set_walk_effect (s32 effect)
	Select the type of surface effect spawned by the player while moving The effect is reset between maps, so include this in the Main script for every map you wish to change.

Enumeration Type Documentation

SurfaceWalkEffect

enum SurfaceWalkEffect

Enumerator
SURFACE_WALK_FX_STANDARD
SURFACE_WALK_FX_SPARKLE

Definition at line 6 of file surfaces.h.

                       {
    SURFACE_WALK_FX_STANDARD,   // puffs of dust follow the player
    SURFACE_WALK_FX_SPARKLE,    // trail of sparkles follow the player, only used in hos_02 in vanilla
};

Function Documentation

player_surface_spawn_fx()

void player_surface_spawn_fx

(

void

)

Definition at line 42 of file surfaces.c.

                                   {
    s32 surfaceType = SURFACE_TYPE_DEFAULT;
 
    if (gPlayerStatus.actionState == ACTION_STATE_JUMP) {
        surfaceType = PrevSurfaceType;
    }
 
    PrevSurfaceType = get_collider_flags((u16)gCollisionStatus.curFloor) & COLLIDER_FLAGS_SURFACE_TYPE_MASK;
 
    if (gPlayerStatus.actionState != ACTION_STATE_JUMP) {
        surfaceType = PrevSurfaceType;
    }
 
    if (gPlayerStatus.actionState == ACTION_STATE_LAND && gPlayerStatus.flags & PS_FLAG_ACTION_STATE_CHANGED) {
        LandedTimeInAir = PrevTimeInAir;
    }
 
    PrevTimeInAir = gPlayerStatus.timeInAir;
 
    switch (surfaceType) {
        case SURFACE_TYPE_FLOWERS:
            player_surface_spawn_flower_fx();
            break;
        case SURFACE_TYPE_CLOUD:
            player_surface_spawn_cloud_fx();
            break;
        case SURFACE_TYPE_SNOW:
            player_surface_spawn_snow_fx();
            break;
        case SURFACE_TYPE_HEDGES:
            player_surface_spawn_hedges_fx();
            break;
        case SURFACE_TYPE_WATER:
            player_surface_spawn_water_fx();
            break;
        default:
            player_surface_spawn_basic_fx();
            break;
    }
}

surface_set_walk_effect()

void surface_set_walk_effect

(

s32

effect

)

Select the type of surface effect spawned by the player while moving The effect is reset between maps, so include this in the Main script for every map you wish to change.

Parameters

type	enum value from SurfaceWalkEffect

Definition at line 18 of file surfaces.c.

                                         {
    SurfaceWalkEffectType = effect;
}

Referenced by load_map_by_IDs().