C_GameRules

namespaceavailable in: camelot

Status in wowlua

31 functions: 0 implemented, 10 recorded, 19 guessed, 2 not implemented. 7 events, 2 of them fired by the emulator on its own.

Functions

function	what it does	status
`AccountHasSDEnabled`	Whether the account has the SD (standard definition) graphics option turned on. · by wowlua `(): boolean`	recorded
`AutoConnectToGameModeRealm`	Connects to a realm of the given game mode. · by wowlua `(gameModeRecordID: number)`	guessed
`DoesGameModeHavePromo`	Whether the game mode has a promotion to show. · by wowlua `(gameModeRecordID: number): boolean`	guessed
`GetActiveGameMode`	Returns the active game mode. · by wowlua `(): GameMode`	recorded
`GetCurrentEventRealmQueues`	Returns the event realm queues the player is in. · by wowlua `(): EventRealmQueues`	guessed
`GetCurrentGameModeDisplayInfo`	Returns the display information of the current game mode, or nothing. · by wowlua `(): GameModeDisplayInfo?`	guessed
`GetCurrentGameModeRecordID`	Returns the record ID of the current game mode. · by wowlua `(): number`	guessed
`GetDisplayedGameModeRecordIDAtIndex`	Returns the record ID of the displayed game mode at the given index. · by wowlua `(displayIndex: number): number`	guessed
`GetForeverExperiencePreset`	Returns the chosen experience preset, or nothing. · by wowlua `(): ForeverExperiencePreset?`	recorded
`GetGameModeDisplayInfoByRecordID`	Returns the display information of a game mode, or nothing. · by wowlua `(gameModeRecordID: number): GameModeDisplayInfo?`	guessed
`GetGameModeGlueScreenName`	Returns the name of the login screen for the current game mode. · by wowlua `(): string`	guessed
`GetGameModePromoGlobalString`	Returns the name of the global string with a game mode's promotion text. · by wowlua `(gameModeRecordID: number): string`	guessed
`GetGameRuleAsFloat`	Returns the numeric value specified in the Game Rule, multiplied by 0.1 for every decimal place requested `(gameRule: GameRule, decimalPlaces: number): number`	recorded
`GetGameRuleAsFrameStrata`	Returns the value specified in the Game Rule converted to a frame strata `(gameRule: GameRule): string`	guessed
`GetNumDisplayedGameModes`	Returns the number of game modes shown for selection. · by wowlua `(): number`	guessed
`IsCharacterlessLoginActive`	Whether the player is logged in without a character. · by wowlua `(): boolean`	guessed
`IsClassAllowedForGameMode`	Whether the class can be played in the current game mode. · by wowlua `(classID: number): boolean`	guessed
`IsGameModeEnabled`	Whether the game mode is enabled. · by wowlua `(gameModeRecordID: number): boolean`	guessed
`IsGameRuleActive`	Whether the game rule is active. · by wowlua `(gameRule: GameRule): boolean`	recorded
`IsHardcoreActive`	Whether the realm is a Hardcore realm. · by wowlua `(): boolean`	recorded
`IsMultiActionBarVisibilityForced`	Whether the game mode forces the extra action bars to be shown. · by wowlua `(): boolean`	recorded
`IsPersonalResourceDisplayEnabled`	Checks the game rule as well as nameplateShowSelf `(): boolean`	guessed
`IsPlunderstorm`	Whether the current game mode is Plunderstorm. · by wowlua `(): boolean`	recorded
`IsSDHDToggleEnabled`	Whether the SD/HD graphics toggle is available. · by wowlua `(): boolean`	recorded
`IsSelfFoundAllowed`	Whether Self-Found mode can be chosen. · by wowlua `(): boolean`	guessed
`IsStandard`	Whether the current game mode is the standard one. · by wowlua `(): boolean`	recorded
`IsWoWHack`	Whether the current game mode is the WoW Hack game mode. · by wowlua `(): boolean`	guessed
`SetForeverExperiencePreset`	Sets the experience preset. · by wowlua `not in Blizzard's documentation`	guessed
`SetForeverExperiencePresetPostLogin`	No description yet. `(preset: ForeverExperiencePreset)`	not implemented
`SetForeverExperiencePresetPreLogin`	No description yet. `(preset: ForeverExperiencePreset)`	not implemented
`SetSDHDToggleValue`	Switches between SD and HD graphics. · by wowlua `(setToSD: boolean, usageLocation: SdToggleUsageLocationUI)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`ACTIVE_GAME_MODE_UPDATED`	`gameMode: GameMode`	not implemented
`AVAILABLE_GAME_MODES_UPDATED`	`no payload`	not implemented
`EVENT_REALM_QUEUES_UPDATED`	`eventRealmQueues: EventRealmQueues`	not implemented
`GAME_MODE_DISPLAY_INFO_UPDATED`	`no payload`	implemented
`GAME_MODE_DISPLAY_MODE_TOGGLE_DISABLED`	`gameModeRecordID: number, disabled: boolean`	not implemented
`GAME_RULES_CHANGED`	`no payload`	implemented
`SETTINGS_HEADER_TEXT_UPDATE`	`no payload`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ACTIVE_GAME_MODE_UPDATED").

Structures

GameModeDisplayInfo · logo, logoHeight, logoVerticalOffset, logoShrunkenHeight, logoUsesDarkBackdrop, characterCreateExtraHeight, characterCreateOuterBorder

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (GameRules system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.