Class SharedWorld

Shared singleton of the GTA world

Inheritance

Object

SharedWorld

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Slipe.Shared.GameWorld

Assembly: SlipeShared.dll

Syntax

public class SharedWorld

Constructors

SharedWorld()

Instantiate a new world

Declaration

public SharedWorld()

Fields

instance

Declaration

protected static SharedWorld instance

Field Value

Type	Description
SharedWorld

Properties

AircraftMaxHeight

Gets and sets the maximum height at which aircraft can fly without their engines turning off.

Declaration

public float AircraftMaxHeight { get; set; }

Property Value

Type	Description
Single

AircraftMaxVelocity

Gets and sets the maximum velocity at which aircrafts could fly. Using this server-side will return the server-side value, not necessarily the same that is set client-side.

Declaration

public float AircraftMaxVelocity { get; set; }

Property Value

Type	Description
Single

CloudsEnabled

Get and sets if clouds are enabled or disabled.

Declaration

public bool CloudsEnabled { get; set; }

Property Value

Type	Description
Boolean

FarClipDistance

Get and set the render distance

Declaration

public float FarClipDistance { get; set; }

Property Value

Type	Description
Single

FogDistance

Get and set the current fog render distance.

Declaration

public float FogDistance { get; set; }

Property Value

Type	Description
Single

GameSpeed

Get and set the current game speed value.

Declaration

public float GameSpeed { get; set; }

Property Value

Type	Description
Single

Gravity

Get and set the gravity in the world. Default is 0.008

Declaration

public float Gravity { get; set; }

Property Value

Type	Description
Single

HeatHaze

Gets and sets the heat haze properties of the world

Declaration

public HeatHaze HeatHaze { get; set; }

Property Value

Type	Description
HeatHaze

Instance

Retrieve the instance of the current world

Declaration

public static SharedWorld Instance { get; }

Property Value

Type	Description
SharedWorld

InteriorSounds

This proeprty disables or enables the ambient sounds played by GTA in most interiors, like restaurants, casinos, clubs, houses, etc.

Declaration

public bool InteriorSounds { set; }

Property Value

Type	Description
Boolean

JetpackMaxHeight

Gets and sets the maximum height at which your jetpack can fly without failing to go higher.

Declaration

public float JetpackMaxHeight { get; set; }

Property Value

Type	Description
Single

LockedTrafficLights

Gets and sets whether the traffic lights are currently locked or not. If the lights are locked, it means they won't change unless you alter the TrafficLightState

Declaration

public bool LockedTrafficLights { get; set; }

Property Value

Type	Description
Boolean

MinuteDuration

Tells you how long an ingame minute takes in real-world milliseconds. The default GTA value is 1000.

Declaration

public int MinuteDuration { get; set; }

Property Value

Type	Description
Int32

Moonsize

Gets and sets the size of the moon. Default is 3

Declaration

public int Moonsize { get; set; }

Property Value

Type	Description
Int32

OcclusionsEnabled

Occlusions are used by GTA to enhance performance by hiding objects that are (normally) obscured by certain large buildings. However when removeWorldModel is used they may also have the undesired effect of making parts of the map disappear. Disabling occlusions will fix that.

Declaration

public bool OcclusionsEnabled { get; set; }

Property Value

Type	Description
Boolean

RainLevel

Gets and sets the rain level to any weather available in GTA The level value is clamped between 0.0 and 10.0 to avoid gameplay issues.

Declaration

public float RainLevel { get; set; }

Property Value

Type	Description
Single

SkyGradient

Get and set the gradient of the sky from top to bottom

Declaration

public Tuple<Color, Color> SkyGradient { get; set; }

Property Value

Type	Description
Tuple<Color, Color>

SunColor

Get and set the color of the sun

Declaration

public Tuple<Color, Color> SunColor { get; set; }

Property Value

Type	Description
Tuple<Color, Color>

SunSize

Get and set the size of the sun

Declaration

public int SunSize { get; set; }

Property Value

Type	Description
Int32

Time

Get and set the time in the world

Declaration

public GameTime Time { get; set; }

Property Value

Type	Description
GameTime

TrafficLightState

Get and set the different states of traffic lights in the world

Declaration

public TrafficLightState TrafficLightState { get; set; }

Property Value

Type	Description
TrafficLightState

WaterColor

Changes the water color of the GTA world.

Declaration

public Color WaterColor { get; set; }

Property Value

Type	Description
Color

WaveHeight

Get or sets the wave height to the desired value, the default is 0.

Declaration

public float WaveHeight { get; set; }

Property Value

Type	Description
Single

Weather

Get and set the current weather The weather is set blended if the weather struct passed is also blended

Declaration

public Weather Weather { get; set; }

Property Value

Type	Description
Weather

WindVelocity

Get and set the wind velocity. The wind shakes the vegetation and makes particles fly in a direction. The intensity and direction of the effect deppends of the wind velocity in each axis.

Declaration

public Vector3 WindVelocity { get; set; }

Property Value

Type	Description
Vector3

Methods

GetGarage(GarageLocation)

Get a specific garage class instance from a garage ID

Declaration

public SharedGarage GetGarage(GarageLocation garage)

Parameters

Type	Name	Description
GarageLocation	garage

Returns

Type	Description
SharedGarage

GetZoneName(Vector3, Boolean)

Get the name of the zone of a position

Declaration

public string GetZoneName(Vector3 position, bool citiesOnly = false)

Parameters

Type	Name	Description
Vector3	position
Boolean	citiesOnly

Returns

Type	Description
String

RemoveWorldModel(Int32, Single, Vector3, Int32)

Remove all world models in a certain sphere

Declaration

public bool RemoveWorldModel(int modelID, float radius, Vector3 position, int interior = 0)

Parameters

Type	Name	Description
Int32	modelID
Single	radius
Vector3	position
Int32	interior

Returns

Type	Description
Boolean

ResetFarClipDistance()

This function resets the far clip distance to its default state.

Declaration

public bool ResetFarClipDistance()

Returns

Type	Description
Boolean

ResetFogDistance()

This function resets the fog render distance to its default state.

Declaration

public bool ResetFogDistance()

Returns

Type	Description
Boolean

ResetHeatHaze()

Reset the heat haze

Declaration

public bool ResetHeatHaze()

Returns

Type	Description
Boolean

ResetMoonSize()

This function is used to reset the size of the moon to its normal size.

Declaration

public bool ResetMoonSize()

Returns

Type	Description
Boolean

ResetRainLevel()

This function resets the rain level of the current weather to its default.

Declaration

public bool ResetRainLevel()

Returns

Type	Description
Boolean

ResetSkyGradient()

Reset the sky gradient to the normal value

Declaration

public bool ResetSkyGradient()

Returns

Type	Description
Boolean

ResetSunColor()

Reset the color of the sun to normal

Declaration

public bool ResetSunColor()

Returns

Type	Description
Boolean

ResetSunSize()

Reset the size of the sun to normal

Declaration

public bool ResetSunSize()

Returns

Type	Description
Boolean

ResetWaterColor()

This function reset the water color of the GTA world to default.

Declaration

public bool ResetWaterColor()

Returns

Type	Description
Boolean

ResetWaterLevel()

This function resets the water of the GTA world back to its default level. Water elements are not affected.

Declaration

public bool ResetWaterLevel()

Returns

Type	Description
Boolean

ResetWindVelocity()

Resets the wind velocity to default

Declaration

public bool ResetWindVelocity()

Returns

Type	Description
Boolean

RestoreAllWorldModels()

Restore the removal of all world models

Declaration

public bool RestoreAllWorldModels()

Returns

Type	Description
Boolean

RestoreWorldModel(Int32, Single, Vector3, Int32)

Restore all world models in a certain sphere

Declaration

public bool RestoreWorldModel(int modelID, float radius, Vector3 position, int interior = -1)

Parameters

Type	Name	Description
Int32	modelID
Single	radius
Vector3	position
Int32	interior

Returns

Type	Description
Boolean

SetWaterLevel(Single, Boolean, Boolean)

Sets the height of all the water in the game world.

Declaration

public bool SetWaterLevel(float level, bool includeWaterFeatures = true, bool includeWaterElements = true)

Parameters

Type	Name	Description
Single	level
Boolean	includeWaterFeatures
Boolean	includeWaterElements

Returns

Type	Description
Boolean