STDGNAME.PRO: the screen where the partners are renamed. More...

#include "shared/name_entry.h"

Include dependency graph for partner_name.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	MenuWindow
	Where a window of the partner menu goes, and its text. More...

struct	MenuSprite
	A sprite of the partner menu, that opens by scaling. More...

struct	MenuSlot

struct	MenuAnim
	A partner's animation in the partner menu. More...

struct	PartnerMenuTask
	The partner menu. More...

struct	ScreenChildren

struct	ScreenTask
	The screen's controller. More...

struct	ScreenFuncs

Macros
#define	OVL_NAME(name) STDGNAME_##name
	The name of this overlay's copy of a function or type of src/shared/.

#define	NAME_ENTRY_HAS_UNUSED98 1
	The overlay's NameEntry and the name entry's files (name_entry.h)

#define	NAME_ENTRY_HAS_HIDE 0

#define	NAME_ENTRY_SPRITES STDGNAME_KEY_SPRITES

#define	NAME_ENTRY_FILE_KEYBOARD STDGNAME_FILE_KEYBOARD

#define	STDGNAME_FILE_SPRITES 0x288
	The screen's files: the discs number them differently.

#define	STDGNAME_FILE_IMAGES 0x289

#define	STDGNAME_FILE_KEYBOARD 0x771

#define	STDGNAME_FILE_KEY_SPRITES 0x770

#define	STDGNAME_SPRITES (STDGNAME_FILE_SPRITES << 16)
	sprite bank

#define	STDGNAME_KEY_SPRITES (STDGNAME_FILE_KEY_SPRITES << 16)
	the keyboard's and partners' sprites

Functions
void	STDGNAME_updateScene (Task task, ScreenTask *screen)
	scene.c

void	STDGNAME_startFader (ScreenFade *task, s32 fadeIn, s32 duration)

void	STDGNAME_drawFader (ScreenFade *task)

void	STDGNAME_updateFader (ScreenFade *task)

ScreenFade *	STDGNAME_createFader (void)

void	STDGNAME_startTween (PanelAnim *fade, s32 fadeIn)
	name_entry.c

s32	STDGNAME_updateTween (PanelAnim *fade)

void	STDGNAME_createNameWindows (NameEntry task, NameEntryWindows windows)

void	STDGNAME_showNameWindows (NameEntry task, NameEntryWindows windows, s32 show)

void	STDGNAME_drawKeyboard (NameEntry *task)

void	STDGNAME_updateKeyboard (NameEntry task, NameEntryWindows windows)

void	STDGNAME_updateNameEntry (NameEntry task, NameEntryWindows windows)

void	STDGNAME_setNameVram (NameEntry *task, s32 x, s32 y)

void	STDGNAME_setName (NameEntry task, char name)

void	STDGNAME_getName (NameEntry task, char out)

void	STDGNAME_closeNameEntry (NameEntry *task)

NameEntry *	STDGNAME_createNameEntry (char *name, s32 partner)
	Creates the name entry (task) for a partner, starting from the name given; up to 8 characters (5 in language 0, in the European version)

void	STDGNAME_showMenuWindow (PartnerMenuTask task, TextWindow *window, s32 index, s32 show)
	menu.c

void	STDGNAME_drawMenu (PartnerMenuTask task, TextWindow *windows)
	Draws the partner menu, its parts opening by scaling: its three sprites (the one at the chosen partner in a cycling palette), each partner's animation in its slot and the slots' frames over a glow in a cycling palette.

s32	STDGNAME_runMenu (PartnerMenuTask task, TextWindow *windows)
	Up/down choose a partner; cross picks it to rename, triangle leaves the screen (choice -1, fading out).

void	STDGNAME_updateMenu (PartnerMenuTask task, TextWindow *windows)
	The partner menu's task: opens its panels, then each partner's slot and name one after the other, runs the menu and closes everything once a choice is made.

PartnerMenuTask *	STDGNAME_createMenu (ScreenTask *screen)
	Creates the partner menu (task) to pick the partner to rename.

void	STDGNAME_stepScreen (ScreenTask task, ScreenChildren children)
	screen.c

void	STDGNAME_drawBackground (ScreenTask *task)
	Draws the screen's background and its scrolling pattern.

void	STDGNAME_updateScreen (ScreenTask task, ScreenChildren children)
	The renaming screen's task: loads its files, then runs the screen and draws the background; goes back to the field when killed.

void	STDGNAME_fadeOutScreen (ScreenTask *task)
	Fades the screen out over 30 frames (task->fadeOut), to leave it.

ScreenTask *	STDGNAME_createScreen (void)
	Creates the renaming screen (task)

void	STDGNAME_loadFiles (void)
	Loads the screen's textures and requests the keyboard and the strings; the chosen partner goes back to the first.

s32	STDGNAME_filesLoading (void)
	Whether the keyboard or the strings are still loading.

void	STDGNAME_startFade (PanelAnim *fade, s32 fadeIn)

s32	STDGNAME_updateFade (PanelAnim *fade)

Variables
NameKeyboard	STDGNAME_keyboard
	STDGNAME's data (data/stdgname.c)

TextStyle	STDGNAME_nameStyle

s32	STDGNAME_nameAnims [][7]

BigKey	STDGNAME_bigKeys []

s32	STDGNAME_keyArrowCluts []

KeyTabs	STDGNAME_keyPages []

KeyPage	STDGNAME_keyChars []

KeyTabs	STDGNAME_keyPagesJp []
	the keyboard of language 0, three pages (only the European version uses it)

KeyPage	STDGNAME_keyCharsJp []

MenuSprite	STDGNAME_menuSprites []
	The partner menu: its sprites, the partners' slots (one under the other, 43 pixels apart), its text windows and each partner's animation (7 frames, -1 ends one)

MenuSlot	STDGNAME_menuSlots []

MenuWindow	STDGNAME_menuWindows []

s32	STDGNAME_menuAnims [][7]

ScreenFuncs	STDGNAME_funcs
	style: the text style of the partners' names in the menu (STDGNAME_showMenuWindow)

TextStyle	STDGNAME_menuStyle

Detailed Description

STDGNAME.PRO: the screen where the partners are renamed.

Its modules are in src/menus/partner_name/, and the functions below are by module, in the order they link.

Definition in file partner_name.h.

Macro Definition Documentation

◆ OVL_NAME

#define OVL_NAME ( name ) STDGNAME_##name

The name of this overlay's copy of a function or type of src/shared/.

Definition at line 9 of file partner_name.h.

◆ NAME_ENTRY_HAS_UNUSED98

#define NAME_ENTRY_HAS_UNUSED98 1

The overlay's NameEntry and the name entry's files (name_entry.h)

Definition at line 12 of file partner_name.h.

◆ NAME_ENTRY_HAS_HIDE

#define NAME_ENTRY_HAS_HIDE 0

Definition at line 13 of file partner_name.h.

◆ NAME_ENTRY_SPRITES

#define NAME_ENTRY_SPRITES STDGNAME_KEY_SPRITES

Definition at line 14 of file partner_name.h.

◆ NAME_ENTRY_FILE_KEYBOARD

#define NAME_ENTRY_FILE_KEYBOARD STDGNAME_FILE_KEYBOARD

Definition at line 15 of file partner_name.h.

◆ STDGNAME_FILE_SPRITES

#define STDGNAME_FILE_SPRITES 0x288

The screen's files: the discs number them differently.

Definition at line 25 of file partner_name.h.

◆ STDGNAME_FILE_IMAGES

#define STDGNAME_FILE_IMAGES 0x289

Definition at line 26 of file partner_name.h.

◆ STDGNAME_FILE_KEYBOARD

#define STDGNAME_FILE_KEYBOARD 0x771

Definition at line 27 of file partner_name.h.

◆ STDGNAME_FILE_KEY_SPRITES

#define STDGNAME_FILE_KEY_SPRITES 0x770

Definition at line 28 of file partner_name.h.

◆ STDGNAME_SPRITES

#define STDGNAME_SPRITES (STDGNAME_FILE_SPRITES << 16)

sprite bank

Definition at line 30 of file partner_name.h.

◆ STDGNAME_KEY_SPRITES

#define STDGNAME_KEY_SPRITES (STDGNAME_FILE_KEY_SPRITES << 16)

the keyboard's and partners' sprites

Definition at line 31 of file partner_name.h.

Function Documentation

◆ STDGNAME_updateScene()

void STDGNAME_updateScene	(	Task *	task,
		ScreenTask **	screen
	)

scene.c

Definition at line 7 of file scene.c.

Referenced by STDGNAME_start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_startFader()

void STDGNAME_startFader	(	ScreenFade *	task,
		s32	fadeIn,
		s32	duration
	)

◆ STDGNAME_drawFader()

void STDGNAME_drawFader ( ScreenFade * task )

◆ STDGNAME_updateFader()

void STDGNAME_updateFader ( ScreenFade * task )

◆ STDGNAME_createFader()

ScreenFade * STDGNAME_createFader ( void )

Referenced by STDGNAME_fadeOutScreen().

Here is the caller graph for this function:

◆ STDGNAME_startTween()

void STDGNAME_startTween	(	PanelAnim *	fade,
		s32	fadeIn
	)

name_entry.c

◆ STDGNAME_updateTween()

s32 STDGNAME_updateTween ( PanelAnim * fade )

◆ STDGNAME_createNameWindows()

void STDGNAME_createNameWindows	(	NameEntry *	task,
		NameEntryWindows *	windows
	)

◆ STDGNAME_showNameWindows()

void STDGNAME_showNameWindows	(	NameEntry *	task,
		NameEntryWindows *	windows,
		s32	show
	)

◆ STDGNAME_drawKeyboard()

void STDGNAME_drawKeyboard ( NameEntry * task )

◆ STDGNAME_updateKeyboard()

void STDGNAME_updateKeyboard	(	NameEntry *	task,
		NameEntryWindows *	windows
	)

◆ STDGNAME_updateNameEntry()

void STDGNAME_updateNameEntry	(	NameEntry *	task,
		NameEntryWindows *	windows
	)

Referenced by STDGNAME_createNameEntry().

Here is the caller graph for this function:

◆ STDGNAME_setNameVram()

void STDGNAME_setNameVram	(	NameEntry *	task,
		s32	x,
		s32	y
	)

Referenced by STDGNAME_createNameEntry().

Here is the caller graph for this function:

◆ STDGNAME_setName()

void STDGNAME_setName	(	NameEntry *	task,
		char *	name
	)

Referenced by STDGNAME_createNameEntry().

Here is the caller graph for this function:

◆ STDGNAME_getName()

void STDGNAME_getName	(	NameEntry *	task,
		char *	out
	)

Referenced by STDGNAME_createNameEntry().

Here is the caller graph for this function:

◆ STDGNAME_closeNameEntry()

void STDGNAME_closeNameEntry ( NameEntry * task )

Referenced by STDGNAME_createNameEntry().

Here is the caller graph for this function:

◆ STDGNAME_createNameEntry()

NameEntry * STDGNAME_createNameEntry	(	char *	name,
		s32	partner
	)

Creates the name entry (task) for a partner, starting from the name given; up to 8 characters (5 in language 0, in the European version)

Definition at line 22 of file name_entry.c.

Referenced by STDGNAME_stepScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_showMenuWindow()

void STDGNAME_showMenuWindow	(	PartnerMenuTask *	task,
		TextWindow **	window,
		s32	index,
		s32	show
	)

menu.c

< DGNMET: STDGNAME's

Definition at line 7 of file menu.c.

Referenced by STDGNAME_updateMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_drawMenu()

void STDGNAME_drawMenu	(	PartnerMenuTask *	task,
		TextWindow **	windows
	)

Draws the partner menu, its parts opening by scaling: its three sprites (the one at the chosen partner in a cycling palette), each partner's animation in its slot and the slots' frames over a glow in a cycling palette.

< GTE regards 4096 as 1.0

< sprite bank

< GTE regards 4096 as 1.0

< sprite bank

< GTE regards 4096 as 1.0

< sprite bank

Definition at line 35 of file menu.c.

Referenced by STDGNAME_updateMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_runMenu()

s32 STDGNAME_runMenu	(	PartnerMenuTask *	task,
		TextWindow **	windows
	)

Up/down choose a partner; cross picks it to rename, triangle leaves the screen (choice -1, fading out).

1 once either is pressed

< SYSTEM06

< SYSTEM07

< SYSTEM01

Definition at line 112 of file menu.c.

Referenced by STDGNAME_updateMenu().

Here is the caller graph for this function:

◆ STDGNAME_updateMenu()

void STDGNAME_updateMenu	(	PartnerMenuTask *	task,
		TextWindow **	windows
	)

The partner menu's task: opens its panels, then each partner's slot and name one after the other, runs the menu and closes everything once a choice is made.

Definition at line 141 of file menu.c.

Referenced by STDGNAME_createMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_createMenu()

PartnerMenuTask * STDGNAME_createMenu ( ScreenTask * screen )

Creates the partner menu (task) to pick the partner to rename.

Definition at line 223 of file menu.c.

Referenced by STDGNAME_stepScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_stepScreen()

void STDGNAME_stepScreen	(	ScreenTask *	task,
		ScreenChildren *	children
	)

screen.c

Definition at line 9 of file screen.c.

Referenced by STDGNAME_updateScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_drawBackground()

void STDGNAME_drawBackground ( ScreenTask * task )

Draws the screen's background and its scrolling pattern.

< sprite bank

Definition at line 59 of file screen.c.

Referenced by STDGNAME_updateScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_updateScreen()

void STDGNAME_updateScreen	(	ScreenTask *	task,
		ScreenChildren *	children
	)

The renaming screen's task: loads its files, then runs the screen and draws the background; goes back to the field when killed.

Definition at line 78 of file screen.c.

Referenced by STDGNAME_createScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_fadeOutScreen()

void STDGNAME_fadeOutScreen ( ScreenTask * task )

Fades the screen out over 30 frames (task->fadeOut), to leave it.

Definition at line 112 of file screen.c.

Referenced by STDGNAME_createScreen().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_createScreen()

ScreenTask * STDGNAME_createScreen ( void )

Creates the renaming screen (task)

Definition at line 121 of file screen.c.

Referenced by STDGNAME_updateScene().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ STDGNAME_loadFiles()

void STDGNAME_loadFiles ( void )

Loads the screen's textures and requests the keyboard and the strings; the chosen partner goes back to the first.

< DGNMET: STDGNAME's

< NAMEDT: the keyboard's

Definition at line 131 of file screen.c.

Here is the call graph for this function:

◆ STDGNAME_filesLoading()

s32 STDGNAME_filesLoading ( void )

Whether the keyboard or the strings are still loading.

< DGNMET: STDGNAME's

< NAMEDT: the keyboard's

Definition at line 144 of file screen.c.

◆ STDGNAME_startFade()

void STDGNAME_startFade	(	PanelAnim *	fade,
		s32	fadeIn
	)

◆ STDGNAME_updateFade()

s32 STDGNAME_updateFade ( PanelAnim * fade )

Variable Documentation

◆ STDGNAME_keyboard

NameKeyboard STDGNAME_keyboard

extern

STDGNAME's data (data/stdgname.c)

Definition at line 1190 of file stdgname.c.

◆ STDGNAME_nameStyle

TextStyle STDGNAME_nameStyle

extern

Definition at line 592 of file stdgname.c.

◆ STDGNAME_nameAnims

s32 STDGNAME_nameAnims[][7]

extern

Definition at line 598 of file stdgname.c.

◆ STDGNAME_bigKeys

BigKey STDGNAME_bigKeys[]

extern

Definition at line 605 of file stdgname.c.

◆ STDGNAME_keyArrowCluts

s32 STDGNAME_keyArrowCluts[]

extern

Definition at line 609 of file stdgname.c.

◆ STDGNAME_keyPages

KeyTabs STDGNAME_keyPages[]

extern

Definition at line 576 of file stdgname.c.

◆ STDGNAME_keyChars

KeyPage STDGNAME_keyChars[]

extern

Definition at line 580 of file stdgname.c.

◆ STDGNAME_keyPagesJp

KeyTabs STDGNAME_keyPagesJp[]

extern

the keyboard of language 0, three pages (only the European version uses it)

Definition at line 541 of file stdgname.c.

◆ STDGNAME_keyCharsJp

KeyPage STDGNAME_keyCharsJp[]

extern

Definition at line 546 of file stdgname.c.

◆ STDGNAME_menuSprites

MenuSprite STDGNAME_menuSprites[]

extern

The partner menu: its sprites, the partners' slots (one under the other, 43 pixels apart), its text windows and each partner's animation (7 frames, -1 ends one)

Definition at line 616 of file stdgname.c.

Referenced by STDGNAME_drawMenu().

◆ STDGNAME_menuSlots

MenuSlot STDGNAME_menuSlots[]

extern

Definition at line 627 of file stdgname.c.

Referenced by STDGNAME_drawMenu().

◆ STDGNAME_menuWindows

MenuWindow STDGNAME_menuWindows[]

extern

Definition at line 631 of file stdgname.c.

Referenced by STDGNAME_showMenuWindow().

◆ STDGNAME_menuAnims

s32 STDGNAME_menuAnims[][7]

extern

Definition at line 638 of file stdgname.c.

Referenced by STDGNAME_drawMenu().

◆ STDGNAME_funcs

ScreenFuncs STDGNAME_funcs

extern

style: the text style of the partners' names in the menu (STDGNAME_showMenuWindow)

Definition at line 646 of file stdgname.c.

Referenced by STDGNAME_drawMenu(), STDGNAME_loadFiles(), STDGNAME_runMenu(), STDGNAME_showMenuWindow(), STDGNAME_stepScreen(), STDGNAME_updateMenu(), and STDGNAME_updateScreen().

◆ STDGNAME_menuStyle

TextStyle STDGNAME_menuStyle

extern

Definition at line 1184 of file stdgname.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ OVL_NAME

◆ NAME_ENTRY_HAS_UNUSED98

◆ NAME_ENTRY_HAS_HIDE

◆ NAME_ENTRY_SPRITES

◆ NAME_ENTRY_FILE_KEYBOARD

◆ STDGNAME_FILE_SPRITES

◆ STDGNAME_FILE_IMAGES

◆ STDGNAME_FILE_KEYBOARD

◆ STDGNAME_FILE_KEY_SPRITES

◆ STDGNAME_SPRITES

◆ STDGNAME_KEY_SPRITES

Function Documentation

◆ STDGNAME_updateScene()

◆ STDGNAME_startFader()

◆ STDGNAME_drawFader()

◆ STDGNAME_updateFader()

◆ STDGNAME_createFader()

◆ STDGNAME_startTween()

◆ STDGNAME_updateTween()

◆ STDGNAME_createNameWindows()

◆ STDGNAME_showNameWindows()

◆ STDGNAME_drawKeyboard()

◆ STDGNAME_updateKeyboard()

◆ STDGNAME_updateNameEntry()

◆ STDGNAME_setNameVram()

◆ STDGNAME_setName()

◆ STDGNAME_getName()

◆ STDGNAME_closeNameEntry()

◆ STDGNAME_createNameEntry()

◆ STDGNAME_showMenuWindow()

◆ STDGNAME_drawMenu()

◆ STDGNAME_runMenu()

◆ STDGNAME_updateMenu()

◆ STDGNAME_createMenu()

◆ STDGNAME_stepScreen()

◆ STDGNAME_drawBackground()

◆ STDGNAME_updateScreen()

◆ STDGNAME_fadeOutScreen()

◆ STDGNAME_createScreen()

◆ STDGNAME_loadFiles()

◆ STDGNAME_filesLoading()

◆ STDGNAME_startFade()

◆ STDGNAME_updateFade()

Variable Documentation

◆ STDGNAME_keyboard

◆ STDGNAME_nameStyle

◆ STDGNAME_nameAnims

◆ STDGNAME_bigKeys

◆ STDGNAME_keyArrowCluts

◆ STDGNAME_keyPages

◆ STDGNAME_keyChars

◆ STDGNAME_keyPagesJp

◆ STDGNAME_keyCharsJp

◆ STDGNAME_menuSprites

◆ STDGNAME_menuSlots

◆ STDGNAME_menuWindows

◆ STDGNAME_menuAnims

◆ STDGNAME_funcs

◆ STDGNAME_menuStyle