Game MethodsRAGE Plugin Hook Documentation

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

The Game type exposes the following members.

Methods

  NameDescription
Public methodStatic memberAddConsoleCommands
Adds console commands defined in the calling assembly.
Public methodStatic memberAddConsoleCommands(MethodInfo)
Adds console commands from the specified methods.
Public methodStatic memberAddConsoleCommands(Type)
Adds console commands from the specified types.
Public methodStatic memberAllocateMemory
Allocates a block of memory of the specified size using VirtualAlloc.
Public methodStatic memberCreateTextureFromFile
Creates a new texture from the specified file.
Public methodStatic memberDisableControlAction
Public methodStatic memberDisplayHelp(String)
Displays the specified text in the help box.
Public methodStatic memberDisplayHelp(String, Boolean)
Displays the specified text in the help box.
Public methodStatic memberDisplayHelp(String, Int32)
Displays the specified text in the help box.
Public methodStatic memberDisplayNotification(String)
Adds a new notification above the map.
Public methodStatic memberDisplayNotification(String, String, String, String, String)
Adds a new notification above the map.
Public methodStatic memberDisplaySubtitle(String)

Displays the specified text in a subtitle.

The display duration will be automatically calculated based on the reading speed of the average human.

Public methodStatic memberDisplaySubtitle(String, Int32)
Displays the specified text in a subtitle for the specified duration.
Public methodStatic memberFadeScreenIn(Int32)
Fades the screen in over the specified amount of time.
Public methodStatic memberFadeScreenIn(Int32, Boolean)
Fades the screen in over the specified amount of time.
Public methodStatic memberFadeScreenOut(Int32)
Fades the screen out over the specified amount of time.
Public methodStatic memberFadeScreenOut(Int32, Boolean)
Fades the screen out over the specified amount of time.
Public methodStatic memberFindAllOccurrencesOfPattern(String)
Finds all occurrences of the specified pattern of bytes in the game's memory.
Public methodStatic memberFindAllOccurrencesOfPattern(String, IntPtr)
Finds all occurrences of the specified pattern of bytes in the game's memory.
Public methodStatic memberCode exampleFindPattern(String)
Finds the specified pattern of bytes in the game's memory.
Public methodStatic memberCode exampleFindPattern(String, IntPtr)
Finds the specified pattern of bytes in the game's memory.
Public methodStatic memberFreeMemory
Frees the memory previously allocated by AllocateMemory(Int64), using VirtualFree.
Public methodStatic memberGetAchievementProgress
Gets the progress of the specified achievement.
Public methodStatic memberGetClipboardText
Gets the text in the clipboard.
Public methodStatic memberGetHashKey
Computes the hash of the given text using Jenkin's one-at-a-time algorithm.
Public methodStatic memberGetKeyboardState
Gets the current state of the keyboard.
Public methodStatic memberCode exampleGetLocalizedString
Gets the localized string from the specified localization string id.
Public methodStatic memberGetMouseState
Gets the current state of the mouse.
Public methodStatic memberGetMouseWheelDelta
Gets the amount the mouse wheel has scrolled.
Public methodStatic memberGetNativeAddress
Gets the address of the native function with the specified name.
Public methodStatic memberGetScriptGlobalVariableAddress
Gets the address of the script global variable with the specified id.
Public methodStatic memberHandleRespawn
Marks the current respawning of the local player as completed, allowing normal game functions, like HUD, opening the menu, etc.
Public methodStatic memberHasAchievementBeenPassed
Determines whether the specified achievement has been passed.
Public methodStatic memberHideHelp
Hides the current help box.
Public methodStatic memberIsControlJustPressed
Public methodStatic memberIsControlJustReleased
Public methodStatic memberIsControllerButtonDown
Public methodStatic memberIsControllerButtonDownRightNow
Public methodStatic memberIsControlPressed
Public methodStatic memberIsKeyDown
Public methodStatic memberIsKeyDownRightNow
Public methodStatic memberLockMinimapAngle
Locks the minimap to the specified angle.
Public methodStatic memberLockMinimapPosition(Vector2)
Locks the minimap to the specified world position.
Public methodStatic memberLockMinimapPosition(Vector3)
Locks the minimap to the specified world position.
Public methodStatic memberLockMinimapPosition(Single, Single)
Locks the minimap to the specified world position.
Public methodStatic memberLogExtremelyVerbose
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].
Public methodStatic memberLogExtremelyVerboseDebug

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.

Public methodStatic memberLogTrivial
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].
Public methodStatic memberCode exampleLogTrivialDebug

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.

Public methodStatic memberLogVerbose
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].
Public methodStatic memberLogVerboseDebug

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.

Public methodStatic memberLogVeryVerbose
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].
Public methodStatic memberLogVeryVerboseDebug

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.

Public methodStatic memberReloadActivePlugin
Reloads the active plugin.
Public methodStatic memberRemoveNotification
Removes the specified notification.
Public methodStatic memberSetClipboardText
Sets the text in the clipboard.
Public methodStatic memberSetRadarZoomLevelThisFrame
Sets the zoom level of the radar this frame.
Public methodStatic memberCode exampleSetRelationshipBetweenRelationshipGroups
Sets the relationship between the specified relationship groups.
Public methodStatic memberStartNewScript(String)
Starts a new instance of the game script with the specified name with a stack size of 1424.
Public methodStatic memberStartNewScript(String, Int32)
Starts a new instance of the game script with the specified name and stack size.
Public methodStatic memberTerminateActivePlugin
Terminates the active plugin.
Public methodStatic memberTerminateAllScripts
Terminates all scripts.
Public methodStatic memberTerminateAllScriptsWithName
Terminates all scripts with the specified name.
Public methodStatic memberUnloadActivePlugin
Unloads the active plugin.
Public methodStatic memberUnlockMinimapAngle
Unlocks the angle of the minimap.
Public methodStatic memberUnlockMinimapPosition
Unlocks the position of the minimap.
Top
See Also

Reference