Game Class

RAGE Plugin Hook Documentation

[This is preliminary documentation and is subject to change.]

Static class for various game settings and functions.

Inheritance Hierarchy

SystemObject
RageGame

Namespace: Rage
Assembly: RagePluginHook (in RagePluginHook.dll) Version: 0.0.0.0 (0.56.1131.11510)

Syntax

C++

Copy

public static class Game

Public NotInheritable Class Game

public ref class Game abstract sealed

The Game type exposes the following members.

Properties

	Name	Description
	AlwaysReceiveKeyEvents	Gets or sets a value indicating whether this plugin will still receive key events even if input focus is set to an active form.
	BuildNumber	Gets the build number of the game.
	Console	Gets the console.
	DisableAutomaticRespawn	Gets or sets a value indicating whether automatic respawns are disabled, allowing plugins to implement custom respawn systems.
	FadeScreenOutOnDeath	Gets or sets a value indicating whether the game will fade out the screen when the player dies.
	FrameCount	Gets the total number of frames that's been rendered this session.
	FrameRate	Gets the current frame rate.
	FrameTime	Gets the time it currently takes to render a frame, in milliseconds.
	GameTime	Gets the game time in milliseconds. Unlike TickCount this value is scaled based on the game time dilation.
	IsAltKeyDownRightNow	Gets a value indicating whether either alt key is down.
	IsControlKeyDownRightNow	Gets a value indicating whether either control key is down.
	IsControllerConnected	Gets a value indicating whether a gamepad is connected.
	IsFullMapRevealForced	Sets a value indicating whether the entire map is currently forced to be revealed.
	IsLoading	Gets a value indicating whether the game is currently displaying the loading screen.
	IsMissionActive	Gets or sets a value indicating whether a mission is currently active.
	IsPaused	Gets or sets whether the game is paused. The game cannot be paused in certain cases, eg. when the console is open.
	IsScreenFadedIn	Gets a value indicating whether the screen is currently faded in.
	IsScreenFadedOut	Gets a value indicating whether the screen is currently faded out.
	IsScreenFadingIn	Gets a value indicating whether the screen is currently fading in.
	IsScreenFadingOut	Gets a value indicating whether the screen is currently fading out.
	IsShiftKeyDownRightNow	Gets a value indicating whether either shift key is down.
	LocalPlayer	Gets the local Player instance.
	MaxWantedLevel	Gets or sets the maximum wanted level.
	ProductVersion	Gets the product version of the game.
	Resolution	Gets the current game resolution. This is the resolution of the game window, not the actual screen resolution. When the game is running in full screen mode, this will be the same as the screen resolution.
	ShowPoliceBlipsOnRadar	Sets a value indicating whether blips representing police units should be shown on the radar when the local player is wanted.
	TickCount
	TimeScale	Gets or sets the time scale multiplier.

Top

Methods

	Name	Description
	AddConsoleCommands	Adds console commands defined in the calling assembly.
	AddConsoleCommands(MethodInfo)	Adds console commands from the specified methods.
	AddConsoleCommands(Type)	Adds console commands from the specified types.
	AllocateMemory	Allocates a block of memory of the specified size using VirtualAlloc.
	CreateTextureFromFile	Creates a new texture from the specified file.
	DisableControlAction
	DisplayHelp(String)	Displays the specified text in the help box.
	DisplayHelp(String, Boolean)	Displays the specified text in the help box.
	DisplayHelp(String, Int32)	Displays the specified text in the help box.
	DisplayNotification(String)	Adds a new notification above the map.
	DisplayNotification(String, String, String, String, String)	Adds a new notification above the map.
	DisplaySubtitle(String)	Displays the specified text in a subtitle. The display duration will be automatically calculated based on the reading speed of the average human.
	DisplaySubtitle(String, Int32)	Displays the specified text in a subtitle for the specified duration.
	FadeScreenIn(Int32)	Fades the screen in over the specified amount of time.
	FadeScreenIn(Int32, Boolean)	Fades the screen in over the specified amount of time.
	FadeScreenOut(Int32)	Fades the screen out over the specified amount of time.
	FadeScreenOut(Int32, Boolean)	Fades the screen out over the specified amount of time.
	FindAllOccurrencesOfPattern(String)	Finds all occurrences of the specified pattern of bytes in the game's memory.
	FindAllOccurrencesOfPattern(String, IntPtr)	Finds all occurrences of the specified pattern of bytes in the game's memory.
	FindPattern(String)	Finds the specified pattern of bytes in the game's memory.
	FindPattern(String, IntPtr)	Finds the specified pattern of bytes in the game's memory.
	FreeMemory	Frees the memory previously allocated by AllocateMemory(Int64), using VirtualFree.
	GetAchievementProgress	Gets the progress of the specified achievement.
	GetClipboardText	Gets the text in the clipboard.
	GetHashKey	Computes the hash of the given text using Jenkin's one-at-a-time algorithm.
	GetKeyboardState	Gets the current state of the keyboard.
	GetLocalizedString	Gets the localized string from the specified localization string id.
	GetMouseState	Gets the current state of the mouse.
	GetMouseWheelDelta	Gets the amount the mouse wheel has scrolled.
	GetNativeAddress	Gets the address of the native function with the specified name.
	GetRunningScripts	Gets the names of all currently running game scripts.
	GetScriptGlobalVariableAddress	Gets the address of the script global variable with the specified id.
	HandleRespawn	Marks the current respawning of the local player as completed, allowing normal game functions, like HUD, opening the menu, etc.
	HasAchievementBeenPassed	Determines whether the specified achievement has been passed.
	HideHelp	Hides the current help box.
	IsControlJustPressed
	IsControlJustReleased
	IsControllerButtonDown
	IsControllerButtonDownRightNow
	IsControlPressed
	IsKeyDown
	IsKeyDownRightNow
	LockMinimapAngle	Locks the minimap to the specified angle.
	LockMinimapPosition(Vector2)	Locks the minimap to the specified world position.
	LockMinimapPosition(Vector3)	Locks the minimap to the specified world position.
	LockMinimapPosition(Single, Single)	Locks the minimap to the specified world position.
	LogExtremelyVerbose	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::ExtremelyVerbose].
	LogExtremelyVerboseDebug	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::ExtremelyVerbose]. When the calling Assembly is not compiled in DEBUG mode, calls to this method will not be compiled.
	LogTrivial	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::Trivial].
	LogTrivialDebug	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::Trivial]. When the calling Assembly is not compiled in DEBUG mode, calls to this method will not be compiled.
	LogVerbose	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::Verbose].
	LogVerboseDebug	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::Verbose]. When the calling Assembly is not compiled in DEBUG mode, calls to this method will not be compiled.
	LogVeryVerbose	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::VeryVerbose].
	LogVeryVerboseDebug	Logs the specified text to the RAGE Plugin Hook log file, if the current logging verbosity setting is equal to, or greater than [!:LoggingVerbosity::VeryVerbose]. When the calling Assembly is not compiled in DEBUG mode, calls to this method will not be compiled.
	ReloadActivePlugin	Reloads the active plugin.
	RemoveNotification	Removes the specified notification.
	SetClipboardText	Sets the text in the clipboard.
	SetRadarZoomLevelThisFrame	Sets the zoom level of the radar this frame.
	SetRelationshipBetweenRelationshipGroups	Sets the relationship between the specified relationship groups.
	StartNewScript(String)	Starts a new instance of the game script with the specified name with a stack size of 1424.
	StartNewScript(String, Int32)	Starts a new instance of the game script with the specified name and stack size.
	TerminateActivePlugin	Terminates the active plugin.
	TerminateAllScripts	Terminates all scripts.
	TerminateAllScriptsWithName	Terminates all scripts with the specified name.
	UnloadActivePlugin	Unloads the active plugin.
	UnlockMinimapAngle	Unlocks the angle of the minimap.
	UnlockMinimapPosition	Unlocks the position of the minimap.

Top

Events

	Name	Description
	FrameRender	Called on each tick to gather render calls. This is not called on each frame, but rather each game tick, and draw calls get queued for the frame renderer. This allows natives to be called from here; however, you may see flickering in the rendering because of this. To avoid this, you can use RawFrameRender which gets called on each frame, but won't allow native calls.
	RawFrameRender	Called on each frame. Natives cannot be called in here, and any attempt to may crash the game.

Top

Reference

Rage Namespace