FieldTask Struct Reference

The field's main task (FIELDSTG_updateField, FIELD_TASK_FIELD); its children follow. More...

#include <field/field_mode.h>

Collaboration diagram for FieldTask:

Data Fields
s32	id
s32	key1
s32	key2
s32	state
s32	substate
s32	step
s32	counter
s32	paused
s32	childCount
void *	children
void(*	setState )(struct FieldTask *task, s32 state)
void(*	setSubstate )(struct FieldTask *task, s32 substate)
void(*	setStep )(struct FieldTask *task, s32 step)
void(*	setCounter )(struct FieldTask *task, s32 counter)
void(*	nextState )(struct FieldTask *task)
void(*	nextSubstate )(struct FieldTask *task)
void(*	nextStep )(struct FieldTask *task)
void(*	tickCounter )(struct FieldTask *task)
void(*	update )()
void(*	destroy )(struct FieldTask *task)
s32	fade
	FIELDSTG_drawCover's level.
s32	width
	of the clip rectangle
s32	height
s32	nextMode
	the mode it leaves for (FIELDSTG_leaveFieldAfter)
s32	nextModeArg
void *	highBuffer
	a buffer at the end of the heap
s32	leaveDelay
	the frames left before it closes the field
s32	centerOnPlayer
	the closing clip shrinks onto the player
s32	warpKind
	the effect and cutscene of a warp (FIELDSTG_startWarp)
Vec2	warpPos
	where the warp's effect plays
SlotDest *	warp
	where it leads

Detailed Description

The field's main task (FIELDSTG_updateField, FIELD_TASK_FIELD); its children follow.

Definition at line 698 of file field_mode.h.

Field Documentation

id

s32 FieldTask::id

Definition at line 699 of file field_mode.h.

key1

s32 FieldTask::key1

Definition at line 699 of file field_mode.h.

key2

s32 FieldTask::key2

Definition at line 699 of file field_mode.h.

state

s32 FieldTask::state

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_updateField().

substate

s32 FieldTask::substate

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_closeField(), FIELDSTG_playBattleTransition(), and FIELDSTG_updateField().

step

s32 FieldTask::step

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_closeField(), FIELDSTG_playBattleTransition(), FIELDSTG_updateField(), moveTransitionTile(), showField(), and warpAway().

counter

s32 FieldTask::counter

Definition at line 699 of file field_mode.h.

Referenced by moveTransitionTile(), and warpAway().

paused

s32 FieldTask::paused

Definition at line 699 of file field_mode.h.

childCount

s32 FieldTask::childCount

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_playBattleTransition().

children

void* FieldTask::children

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_openInn(), and FIELDSTG_startListedEvent().

setState

void(* FieldTask::setState) (struct FieldTask *task, s32 state)

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_leaveFieldAfter(), and FIELDSTG_startEncounter().

setSubstate

void(* FieldTask::setSubstate) (struct FieldTask *task, s32 substate)

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_openInn(), FIELDSTG_startWarp(), and FIELDSTG_updateField().

setStep

void(* FieldTask::setStep) (struct FieldTask *task, s32 step)

Definition at line 699 of file field_mode.h.

setCounter

void(* FieldTask::setCounter) (struct FieldTask *task, s32 counter)

Definition at line 699 of file field_mode.h.

nextState

void(* FieldTask::nextState) (struct FieldTask *task)

Definition at line 699 of file field_mode.h.

Referenced by showField().

nextSubstate

void(* FieldTask::nextSubstate) (struct FieldTask *task)

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_closeField(), FIELDSTG_playBattleTransition(), FIELDSTG_updateField(), openFieldMenu(), and startField().

nextStep

void(* FieldTask::nextStep) (struct FieldTask *task)

Definition at line 699 of file field_mode.h.

Referenced by FIELDSTG_updateField(), showField(), and warpAway().

tickCounter

void(* FieldTask::tickCounter) (struct FieldTask *task)

Definition at line 699 of file field_mode.h.

Referenced by moveTransitionTile().

update

void(* FieldTask::update) ()

Definition at line 699 of file field_mode.h.

destroy

void(* FieldTask::destroy) (struct FieldTask *task)

Definition at line 699 of file field_mode.h.

fade

s32 FieldTask::fade

FIELDSTG_drawCover's level.

Definition at line 700 of file field_mode.h.

Referenced by FIELDSTG_closeField().

width

s32 FieldTask::width

of the clip rectangle

Definition at line 701 of file field_mode.h.

Referenced by FIELDSTG_closeField().

height

s32 FieldTask::height

Definition at line 702 of file field_mode.h.

Referenced by FIELDSTG_closeField().

nextMode

s32 FieldTask::nextMode

the mode it leaves for (FIELDSTG_leaveFieldAfter)

Definition at line 703 of file field_mode.h.

Referenced by FIELDSTG_closeField(), FIELDSTG_leaveFieldAfter(), FIELDSTG_startEncounter(), and moveTransitionTile().

nextModeArg

s32 FieldTask::nextModeArg

Definition at line 704 of file field_mode.h.

Referenced by FIELDSTG_closeField(), FIELDSTG_leaveFieldAfter(), FIELDSTG_startEncounter(), and moveTransitionTile().

highBuffer

void* FieldTask::highBuffer

a buffer at the end of the heap

Definition at line 705 of file field_mode.h.

Referenced by showField(), and startField().

leaveDelay

s32 FieldTask::leaveDelay

the frames left before it closes the field

Definition at line 706 of file field_mode.h.

Referenced by FIELDSTG_leaveFieldAfter(), and FIELDSTG_updateField().

centerOnPlayer

s32 FieldTask::centerOnPlayer

the closing clip shrinks onto the player

Definition at line 707 of file field_mode.h.

Referenced by FIELDSTG_closeField().

warpKind

s32 FieldTask::warpKind

the effect and cutscene of a warp (FIELDSTG_startWarp)

Definition at line 708 of file field_mode.h.

Referenced by FIELDSTG_startWarp(), and warpAway().

warpPos

Vec2 FieldTask::warpPos

where the warp's effect plays

Definition at line 709 of file field_mode.h.

Referenced by FIELDSTG_startWarp(), and warpAway().

warp

SlotDest* FieldTask::warp

where it leads

Definition at line 710 of file field_mode.h.

Referenced by FIELDSTG_startWarp(), and warpAway().

---

The documentation for this struct was generated from the following file:

• include/field/field_mode.h