BaseMod::GameDataApi Class Reference

Inheritance diagram for BaseMod::GameDataApi:

Public Member Functions
	GameDataApi (const BaseMod_GameDataApi *ref)
ggxxacpr::Player	GetPlayer (int playerIndex)
	Gets player data.
ggxxacpr::PlayerInput *	GetPlayerInputStructArr ()
	Gets a pointer to the player input struct array. See GGXXACPR_PlayerInput.
ggxxacpr::Camera	GetCamera ()
	Gets camera data.
bool	IsInGame ()
	returns a non-zero value if the game is on the battle screen.
ggxxacpr::JobMode	GetJobMode ()
	Returns the current job mode, see enum GGXXACPR_JobMode. This variable determines what scene the game is set to such as "TitleScreen", "Battle", "MissionMenu".
ggxxacpr::GameModeFeatureFlags	GetGameModeFeatureFlags ()
	Returns the current game mode feature flags.
ggxxacpr::MenuItem	GetMainMenuSelection ()
	Returns the item selected from the main menu.
void *	GetD3D9Device ()
	Returns the D3D9 device pointer.
ggxxacpr::GameVersion	GetGameVersion ()
	Gets the current game version.
uint32_t	GetViewWidth ()
	Returns the current view width.
uint32_t	GetViewHeight ()
	Returns the current view height.
ggxxacpr::Entity	GetRootEntity ()
	Returns a pointer to the root entity.
uint32_t	GetGlobalThrowFlags ()
	Gets raw throw detection info.
int32_t	GetPauseState ()
	Returns the pause state.
int32_t	GetPauseDisplayState ()
	Returns the pause display state.
ggxxacpr::LocaleState *	GetLocaleState ()
	Gets a pointer to the game's locale state. see GGXXACPR_LocaleState.
Public Member Functions inherited from BaseMod::ApiWrapper< BaseMod_GameDataApi >
bool	VersionError ()
bool	IsValid ()
const BaseMod_GameDataApi *	GetCApi ()

Data Fields
CharDataApi	CharacterData
	API for accessing static character data.

Additional Inherited Members
Protected Attributes inherited from BaseMod::ApiWrapper< BaseMod_GameDataApi >
const BaseMod_GameDataApi *	_ref

Constructor & Destructor Documentation

GameDataApi() [1/2]

BaseMod::GameDataApi::GameDataApi ( )

inline

                  :
        ApiWrapper(),
        CharacterData() { }

GameDataApi() [2/2]

BaseMod::GameDataApi::GameDataApi ( const BaseMod_GameDataApi * ref )

inline

                                                :
        ApiWrapper(ref),
        CharacterData(ref->CharacterData) { }

Member Function Documentation

GetCamera()

ggxxacpr::Camera BaseMod::GameDataApi::GetCamera ( )

inline

Gets camera data.

                               {
        return _ref->GetCamera();
    }

GetD3D9Device()

void * BaseMod::GameDataApi::GetD3D9Device ( )

inline

Returns the D3D9 device pointer.

Include d3d9.h and cast to IDirect3DDevice9 to use. This is a borrowed pointer. Do not call Release().

{ return _ref->GetD3D9Device(); }

GetGameModeFeatureFlags()

ggxxacpr::GameModeFeatureFlags BaseMod::GameDataApi::GetGameModeFeatureFlags ( )

inline

Returns the current game mode feature flags.

{ return static_cast<ggxxacpr::GameModeFeatureFlags>(_ref->GetGameModeFeatureFlags()); }

GetGameVersion()

ggxxacpr::GameVersion BaseMod::GameDataApi::GetGameVersion ( )

inline

Gets the current game version.

AC or AC+R as selected from the "Main Menu > help & options > Game Settings > "Version" setting.

{ return static_cast<ggxxacpr::GameVersion>(_ref->GetGameVersion()); }

GetGlobalThrowFlags()

uint32_t BaseMod::GameDataApi::GetGlobalThrowFlags ( )

inline

Gets raw throw detection info.

{ return _ref->GetGlobalThrowFlags(); }

GetJobMode()

ggxxacpr::JobMode BaseMod::GameDataApi::GetJobMode ( )

inline

Returns the current job mode, see enum GGXXACPR_JobMode. This variable determines what scene the game is set to such as "TitleScreen", "Battle", "MissionMenu".

{ return static_cast<ggxxacpr::JobMode>(_ref->GetJobMode()); }

GetLocaleState()

ggxxacpr::LocaleState * BaseMod::GameDataApi::GetLocaleState ( )

inline

Gets a pointer to the game's locale state. see GGXXACPR_LocaleState.

{ return _ref->GetLocaleState(); }

GetMainMenuSelection()

ggxxacpr::MenuItem BaseMod::GameDataApi::GetMainMenuSelection ( )

inline

Returns the item selected from the main menu.

This value defaults to MAIN_MENU_ITEM_ARCADE and is set when selecting an option on the main menu.

{ return static_cast<ggxxacpr::MenuItem>(_ref->GetMainMenuSelection()); }

GetPauseDisplayState()

int32_t BaseMod::GameDataApi::GetPauseDisplayState ( )

inline

Returns the pause display state.

The pause menu should be drawn if this function returns a non-zero value.

{ return *_ref->GetPauseDisplayState(); }

GetPauseState()

int32_t BaseMod::GameDataApi::GetPauseState ( )

inline

Returns the pause state.

The game is paused if this value is non zero. In training mode, this variable transitions from 0 to 1 to 2 when pausing.

{ return *_ref->GetPauseState(); }

GetPlayer()

ggxxacpr::Player BaseMod::GameDataApi::GetPlayer ( int playerIndex )

inline

Gets player data.

Player entities are not initialized until the first time the battle screen loads. Invalid ggxxacpr::Player views may be returned by this function. Check their validity with ggxxacpr::Player::IsValid().

Parameters

playerIndex

0 for P1, 1 for P2

Returns

A view on the player data.

                                              {
        return _ref->GetPlayer(playerIndex);
    }

GetPlayerInputStructArr()

ggxxacpr::PlayerInput * BaseMod::GameDataApi::GetPlayerInputStructArr ( )

inline

Gets a pointer to the player input struct array. See GGXXACPR_PlayerInput.

The array returned is size 2, first entry is player 1's input and second is player 2's.

Returns

A pointer to the player input struct array.

{ return _ref->GetPlayerInputStructArr(); }

GetRootEntity()

ggxxacpr::Entity BaseMod::GameDataApi::GetRootEntity ( )

inline

Returns a pointer to the root entity.

This entity is the root node of the entity linked list. Iterate through it using ggxxacpr::Entity::next and ggxxacpr::Entity::prev.

{ return ggxxacpr::Entity(_ref->GetRootEntity()); }

GetViewHeight()

uint32_t BaseMod::GameDataApi::GetViewHeight ( )

inline

Returns the current view height.

{ return _ref->GetViewHeight(); }

GetViewWidth()

uint32_t BaseMod::GameDataApi::GetViewWidth ( )

inline

Returns the current view width.

{ return _ref->GetViewWidth(); }

IsInGame()

bool BaseMod::GameDataApi::IsInGame ( )

inline

returns a non-zero value if the game is on the battle screen.

{ return _ref->IsInGame() > 0; }

---

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

• baseMod.hpp