object_internal.h File Reference

What every part of object.c shares: its includes and the macros and types more than one part uses. More...

Go to the source code of this file.

Data Structures
union	PolarOffsetPosition
	The polar-offset routine walks three array elements. More...

Macros
#define	EXIT_NONE   999
	Field_RunScene's result when the scene was not left (scene.c, run_scene.c).
#define	REGION_FIXED(value)
	A scene region's bounds, in pixels, as 16.16 fixed point.
#define	ABILITY_ID(c)
	the Psynergy
#define	ACT_UNIT(c)
	who uses it
#define	ACT_PACKED   0x2000
	use it without paying PP
#define	UNIT_NONE   15
#define	ALLY_MAX   7
	the last party member
#define	EXIT_RETREAT   999
	the exit Retreat takes
#define	FLAG_PSYNERGY_EFFECT   0x140
	play the usual effect
#define	FLAG_PSYNERGY_TARGET   0x141
	aim the effect at the target
#define	PSYNERGY_EV(phase)
	The flags of a Psynergy event (kind 5) in the given phase.
#define	PSYNERGY_EV_ANY   PSYNERGY_EV(7)
	any phase
#define	PSYNERGY_MESSAGE(who, act, m)
	Shows message m with the user's and the Psynergy's names, and waits.

Enumerations
enum	{ SCENE_BLANK = 0x1fb , SCENE_REEL_GAME = 0x1fc , SCENE_LUCKY_DICE = 0x1fd , SCENE_BATTLE = 0x1fe }
	Scene ids above the field maps, which Game_ResetForNewGame runs without a map. More...

Functions
	STATIC_ASSERT (sizeof(union PolarOffsetPosition)==12)

Detailed Description

What every part of object.c shares: its includes and the macros and types more than one part uses.

object.c includes it before the parts, and each part includes it too, so that a part read on its own resolves. It places no bytes.

Definition in file object_internal.h.

Macro Definition Documentation

EXIT_NONE

#define EXIT_NONE   999

Field_RunScene's result when the scene was not left (scene.c, run_scene.c).

Definition at line 100 of file object_internal.h.

Referenced by Field_RunScene(), and Scene_TakeExit().

REGION_FIXED

#define REGION_FIXED

(

value

)

Value:

((s32)((u32)(s32)(value) << 16))

A scene region's bounds, in pixels, as 16.16 fixed point.

Definition at line 121 of file object_internal.h.

Referenced by Field_CheckExitRegions(), and Scene_ApplyEntrance().

ABILITY_ID

#define ABILITY_ID

(

c

)

Value:

((c) & 0x3ff)

the Psynergy

Definition at line 124 of file object_internal.h.

Referenced by Field_UsePsynergy().

ACT_UNIT

#define ACT_UNIT

(

c

)

Value:

(((c) >> 10) & 15)

who uses it

Definition at line 125 of file object_internal.h.

Referenced by Field_UsePsynergy().

ACT_PACKED

#define ACT_PACKED   0x2000

use it without paying PP

Definition at line 126 of file object_internal.h.

Referenced by Battle_ResetEffectCounter(), and Field_UsePsynergy().

UNIT_NONE

#define UNIT_NONE   15

Definition at line 127 of file object_internal.h.

Referenced by Field_UsePsynergy().

ALLY_MAX

#define ALLY_MAX   7

the last party member

Definition at line 128 of file object_internal.h.

EXIT_RETREAT

#define EXIT_RETREAT   999

the exit Retreat takes

Definition at line 130 of file object_internal.h.

Referenced by Field_UseItem(), and Field_UsePsynergy().

FLAG_PSYNERGY_EFFECT

#define FLAG_PSYNERGY_EFFECT   0x140

play the usual effect

Definition at line 132 of file object_internal.h.

Referenced by Field_UsePsynergy().

FLAG_PSYNERGY_TARGET

#define FLAG_PSYNERGY_TARGET   0x141

aim the effect at the target

Definition at line 133 of file object_internal.h.

Referenced by Field_UsePsynergy().

PSYNERGY_EV

#define PSYNERGY_EV

(

phase

)

Value:

((phase) << 28 | EVENT_PSYNERGY)

The flags of a Psynergy event (kind 5) in the given phase.

Definition at line 136 of file object_internal.h.

Referenced by Field_RunPsynergyEvents(), and Field_UsePsynergy().

PSYNERGY_EV_ANY

#define PSYNERGY_EV_ANY   PSYNERGY_EV(7)

any phase

Definition at line 137 of file object_internal.h.

Referenced by BattleFx_FindMatchingEvent(), and BattleFx_HasMatchingEvent5().

PSYNERGY_MESSAGE

#define PSYNERGY_MESSAGE	(		who,
			act,
			m )

Value:

(UiWork_PushValueSlotFar((who), 1), UiWork_PushValueSlotFar((act), 4),       \
 UiText_ShowPositionedMessageAndWaitFar((m), 1))

Shows message m with the user's and the Psynergy's names, and waits.

Definition at line 140 of file object_internal.h.

Referenced by Field_UsePsynergy().

Enumeration Type Documentation

anonymous enum

anonymous enum

Scene ids above the field maps, which Game_ResetForNewGame runs without a map.

Enumerator
SCENE_BLANK
SCENE_REEL_GAME
SCENE_LUCKY_DICE
SCENE_BATTLE

Definition at line 104 of file object_internal.h.

Function Documentation

STATIC_ASSERT()

STATIC_ASSERT

(

sizeof(union PolarOffsetPosition)

= =12

)