GroundParticle Struct Reference

One weather particle: OAM attributes followed by its world position. More...

#include <system/object_effect.h>

Data Fields
u8	unk00 [4]
	Cleared with the attributes; never read by the effects.
u8	attr3 [2]
	OAM attribute 3, cleared with the others.
s32	posX
	World position, in 16.16 pixels.
s32	posY
	The ground's height there.
s32	posZ
	World position, in 16.16 pixels.
s32	delay
	Motes: height risen; sparkles: phase within a burst.
u16	timer
	Frames left; zero frees the particle.
u16	y: 8
	The OAM entry's attributes 0 to 2: the start routines write them whole as semi-transparent, size 1, priority 1 and palette 13.
u16	affine: 2
	Not named by the effects.
u16	blendMode: 2
	1, semi-transparent; not named by the effects.
u16	mosaic: 1
	Not named by the effects.
u16	fullColor: 1
	Not named by the effects.
u16	shape: 2
	From the ground particle frame; motes, sparkles: 0.
u16	x: 9
	Screen pixels.
u16	affineIndex: 5
	Sparkles: 8 on alternate frames, else 0.
u16	size: 2
	From the ground particle frame; motes, sparkles: 1.
u16	tile: 10
	The work's tileBase plus the frame's tile.
u16	priority: 2
	1.
u16	palette: 4
	13; not named by the effects.

Detailed Description

One weather particle: OAM attributes followed by its world position.

Definition at line 29 of file object_effect.h.

Field Documentation

unk00

u8 GroundParticle::unk00[4]

Cleared with the attributes; never read by the effects.

Definition at line 30 of file object_effect.h.

y

u16 GroundParticle::y

The OAM entry's attributes 0 to 2: the start routines write them whole as semi-transparent, size 1, priority 1 and palette 13.

Screen pixels.

Definition at line 34 of file object_effect.h.

Referenced by FieldEffect_UpdateSparkles(), FieldFx_UpdateGroundParticles(), and FieldMotes_Update().

affine

u16 GroundParticle::affine

Not named by the effects.

Definition at line 35 of file object_effect.h.

blendMode

u16 GroundParticle::blendMode

1, semi-transparent; not named by the effects.

Definition at line 36 of file object_effect.h.

mosaic

u16 GroundParticle::mosaic

Not named by the effects.

Definition at line 37 of file object_effect.h.

fullColor

u16 GroundParticle::fullColor

Not named by the effects.

Definition at line 38 of file object_effect.h.

shape

u16 GroundParticle::shape

From the ground particle frame; motes, sparkles: 0.

Definition at line 39 of file object_effect.h.

Referenced by FieldEffect_UpdateSparkles(), FieldFx_UpdateGroundParticles(), and FieldMotes_Update().

x

u16 GroundParticle::x

Screen pixels.

Definition at line 40 of file object_effect.h.

Referenced by FieldEffect_UpdateSparkles(), FieldFx_UpdateGroundParticles(), and FieldMotes_Update().

affineIndex

u16 GroundParticle::affineIndex

Sparkles: 8 on alternate frames, else 0.

Definition at line 41 of file object_effect.h.

Referenced by FieldEffect_UpdateSparkles().

size

u16 GroundParticle::size

From the ground particle frame; motes, sparkles: 1.

Definition at line 42 of file object_effect.h.

Referenced by FieldEffect_InitSparkles(), FieldEffect_UpdateSparkles(), FieldFx_UpdateGroundParticles(), FieldMotes_Start(), and FieldMotes_Update().

tile

u16 GroundParticle::tile

The work's tileBase plus the frame's tile.

Definition at line 43 of file object_effect.h.

Referenced by FieldEffect_UpdateSparkles(), FieldFx_UpdateGroundParticles(), and FieldMotes_Update().

priority

u16 GroundParticle::priority

1.

Definition at line 44 of file object_effect.h.

Referenced by FieldFx_UpdateGroundParticles().

palette

u16 GroundParticle::palette

13; not named by the effects.

Definition at line 45 of file object_effect.h.

attr3

u8 GroundParticle::attr3[2]

OAM attribute 3, cleared with the others.

Definition at line 47 of file object_effect.h.

posX

s32 GroundParticle::posX

World position, in 16.16 pixels.

Definition at line 48 of file object_effect.h.

Referenced by FieldEffect_InitSparkles(), FieldEffect_UpdateSparkles(), FieldFx_StartGroundParticles(), FieldFx_UpdateGroundParticles(), FieldMotes_Start(), and FieldMotes_Update().

posY

s32 GroundParticle::posY

The ground's height there.

Definition at line 49 of file object_effect.h.

Referenced by FieldEffect_InitSparkles(), FieldEffect_UpdateSparkles(), FieldFx_StartGroundParticles(), FieldFx_UpdateGroundParticles(), FieldMotes_Start(), and FieldMotes_Update().

posZ

s32 GroundParticle::posZ

World position, in 16.16 pixels.

Definition at line 50 of file object_effect.h.

Referenced by FieldEffect_InitSparkles(), FieldEffect_UpdateSparkles(), FieldFx_StartGroundParticles(), FieldFx_UpdateGroundParticles(), FieldMotes_Start(), and FieldMotes_Update().

delay

s32 GroundParticle::delay

Motes: height risen; sparkles: phase within a burst.

Definition at line 51 of file object_effect.h.

Referenced by FieldEffect_UpdateSparkles(), and FieldMotes_Update().

timer

u16 GroundParticle::timer

Frames left; zero frees the particle.

Definition at line 52 of file object_effect.h.

Referenced by FieldEffect_InitSparkles(), FieldEffect_UpdateSparkles(), FieldFx_StartGroundParticles(), FieldFx_UpdateGroundParticles(), FieldMotes_Start(), and FieldMotes_Update().