Crops

Collaboration diagram for Crops:

Modules
	Crop Flags
	Flags which affect an individual CROP_PLOT.
	Crop Definition Flags
	Flags which affect all crops that share a CROP_DEF universally.

Data Structures
struct	CROP_PLOT
struct	CROP_DEF
	Definition of a crop to be stored with the TILEMAP on which the crop may be grown. More...

Macros
#define	DSEKAI_CROPS_MAX   40
	Maximum count of DSEKAI_STATE::crops.
#define	DSEKAI_CROPS_ONSCREEN   (GRAPHICS_SPRITES_ONSCREEN / 3)
#define	CROP_NAME_MAX   8
	Maximum size of CROP_DEF::name.
#define	CROP_STATIC_SPRITE_PLOT   "i_plot"
#define	CROP_STATIC_SPRITE_SEED   "i_seed"
#define	CROP_STAGE_MAX   3
	Maximum potential crop growth stage, corresponds to CROP_FLAG_STAGE_MASK.
#define	CROP_ERROR_DEF_NOT_FOUND   -1
	Return value indicating CROP_DEF was not found for provided GID.
#define	CROP_ERROR_PLOT_NOT_FOUND   -2
	Return value indicating CROP_PLOT was not found for provided TILEMAP::name and TILEMAP_COORDS.
#define	CROP_ERROR_PRODUCE_NOT_FOUND   -3

Functions
void	crop_grow (struct CROP_PLOT *plot)
	Check the crop's current cycle/flags and grow to the next stage if able to.
void	crop_grow_all (struct DSEKAI_STATE *state)
	Call crop_grow() on all crops active in the engine state.
struct CROP_PLOT *	crop_find_plot (uint8_t x, uint8_t y, struct DSEKAI_STATE *state)
int8_t	crop_plant (uint8_t crop_gid, struct CROP_PLOT *plot, struct DSEKAI_STATE *state) SECTION_CROP
	Given a CROP_DEF::gid, plant on a plot at the given coordinates on the currently loaded TILEMAP.
int8_t	crop_harvest (MOBILE_GID harvester_gid, struct CROP_PLOT *plot, struct DSEKAI_STATE *state) SECTION_CROP
	Harvest the given CROP_PLOT, giving the produce to the specified dsekai_items_owners.
int8_t	crop_get_def_idx (uint8_t gid, struct DSEKAI_STATE *state)
	Given a CROP_DEF::gid, find the index in TILEMAP::crop_defs.

Variables
RESOURCE_NAME	CROP_DEF::sprite_name
	Sprite sheet for this crop as it's growing.
int16_t	CROP_DEF::sprite_cache_id
char	CROP_DEF::name [CROP_NAME_MAX]
uint8_t	CROP_DEF::gid
	System identifier for this crop. Unique among all CROP_DEF.
uint8_t	CROP_DEF::flags
	See Crop Definition Flags for more information.
uint16_t	CROP_DEF::cycle
	Nominal number of ms until crop reaches next growth stage.
int16_t	CROP_DEF::produce_gid
	ITEM::gid of the item to be given when this crop is harvested.

Detailed Description

Macro Definition Documentation

CROP_NAME_MAX

#define CROP_NAME_MAX   8

Maximum size of CROP_DEF::name.

Note

This may be overridden by passing a -D argument to the compiler.

Attention

Changing this value may break compatibility with tilemaps or saves! Please use caution.

DSEKAI_CROPS_MAX

#define DSEKAI_CROPS_MAX   40

Maximum count of DSEKAI_STATE::crops.

Note

This may be overridden by passing a -D argument to the compiler.

Attention

Changing this value may break compatibility with tilemaps or saves! Please use caution.

Function Documentation

crop_harvest()

int8_t crop_harvest	(	MOBILE_GID	harvester_gid,
		struct CROP_PLOT *	plot,
		struct DSEKAI_STATE *	state
	)

Harvest the given CROP_PLOT, giving the produce to the specified dsekai_items_owners.

Parameters

harvester_gid

MOBILE_GID of the MOBILE to give the harvest to.