WorldGetGroundZ Method

RAGE Plugin Hook Documentation

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

Gets the Z value of the ground surface at the specified position.

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

public static Nullable<float> GetGroundZ(
	Vector3 position,
	bool treatWaterAsGround,
	bool anyMeans


Type: RageVector3
The position to get the ground at.
Type: SystemBoolean
if set to true water will be treated as ground as well; otherwise, over water, the sea bottom will be treated as ground.
Type: SystemBoolean
if set to true, the method may execute over many ticks (0 ticks, to several thousand milliseconds), but will be able to find most positions, even if several kilometers from the player.

Return Value

Type: NullableSingle
If successful, returns the Z value of the ground surface; otherwise, returns null.

Getting the ground Z value relies on world collision. World collision is normally only loaded around the player, so this method will work within a few hundred meters of the player.

If the specified position is at a location without world collision (eg. several kilometers from the player), the method will fail and return null, unless anyMeans is set to true.

Furthermore, the method will also fail if the specified position is below the ground surface, unless anyMeans is set to true.

If anyMeans is set to true; this method may take several ticks (yielding the fiber) to execute, depending on the position and world collision. For example, if the specified position is far away from the player, the method will first have to load world collision at the position, wait for it to load, then find the Z value at the position.

See Also