Game PropertiesRAGE Plugin Hook Documentation

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

The Game type exposes the following members.

Properties

  NameDescription
Public propertyStatic memberAlwaysReceiveKeyEvents
Gets or sets a value indicating whether this plugin will still receive key events even if input focus is set to an active form.
Public propertyStatic memberBuildNumber
Gets the build number of the game.
Public propertyStatic memberConsole
Gets the console.
Public propertyStatic memberDisableAutomaticRespawn
Gets or sets a value indicating whether automatic respawns are disabled, allowing plugins to implement custom respawn systems.
Public propertyStatic memberFadeScreenOutOnDeath
Gets or sets a value indicating whether the game will fade out the screen when the player dies.
Public propertyStatic memberFrameCount
Gets the total number of frames that's been rendered this session.
Public propertyStatic memberFrameRate
Gets the current frame rate.
Public propertyStatic memberFrameTime
Gets the time it currently takes to render a frame, in milliseconds.
Public propertyStatic memberGameTime
Gets the game time in milliseconds. Unlike TickCount this value is scaled based on the game time dilation.
Public propertyStatic memberIsAltKeyDownRightNow
Gets a value indicating whether either alt key is down.
Public propertyStatic memberIsControlKeyDownRightNow
Gets a value indicating whether either control key is down.
Public propertyStatic memberIsControllerConnected
Gets a value indicating whether a gamepad is connected.
Public propertyStatic memberIsFullMapRevealForced
Sets a value indicating whether the entire map is currently forced to be revealed.
Public propertyStatic memberIsLoading
Gets a value indicating whether the game is currently displaying the loading screen.
Public propertyStatic memberIsMissionActive
Gets or sets a value indicating whether a mission is currently active.
Public propertyStatic memberIsPaused

Gets or sets whether the game is paused.

The game cannot be paused in certain cases, eg. when the console is open.

Public propertyStatic memberIsScreenFadedIn
Gets a value indicating whether the screen is currently faded in.
Public propertyStatic memberIsScreenFadedOut
Gets a value indicating whether the screen is currently faded out.
Public propertyStatic memberIsScreenFadingIn
Gets a value indicating whether the screen is currently fading in.
Public propertyStatic memberIsScreenFadingOut
Gets a value indicating whether the screen is currently fading out.
Public propertyStatic memberIsShiftKeyDownRightNow
Gets a value indicating whether either shift key is down.
Public propertyStatic memberLocalPlayer
Gets the local Player instance.
Public propertyStatic memberMaxWantedLevel
Gets or sets the maximum wanted level.
Public propertyStatic memberProductVersion
Gets the product version of the game.
Public propertyStatic memberResolution

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.

Public propertyStatic memberShowPoliceBlipsOnRadar
Sets a value indicating whether blips representing police units should be shown on the radar when the local player is wanted.
Public propertyStatic memberTickCount
Public propertyStatic memberTimeScale
Gets or sets the time scale multiplier.
Top
See Also

Reference