Class World

Inheritance
Object
SharedWorld
World
Inherited Members
Namespace: Slipe.Client.GameWorld
Assembly: SlipeClient.dll
Syntax
public class World : SharedWorld

Constructors

| Improve this Doc View Source

World()

Instantiate a new world

Declaration
public World()

Properties

| Improve this Doc View Source

BirdsEnabled

Flyable birds in the world

Declaration
public bool BirdsEnabled { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

Instance

Declaration
public static World Instance { get; }
Property Value
Type Description
World
| Improve this Doc View Source

InteriorSounds

This property checks to see if the music played by default in clubs is disabled or not.

Declaration
public bool InteriorSounds { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

PedsLodDistance

Get and set the max value peds are rendered at

Declaration
public float PedsLodDistance { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

PedTargetingMarkersEnabled

Get and set if the targeting markers on all peds are enabled

Declaration
public bool PedTargetingMarkersEnabled { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

TrainsAndPlanesLodDistance

Get and set the Lod distances for trains and planes

Declaration
public float TrainsAndPlanesLodDistance { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

VehiclesLodDistance

Get and set the Lod distances for regular vehicles

Declaration
public float VehiclesLodDistance { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

WaterDrawnLast

This property changes the water rendering order.

Declaration
public bool WaterDrawnLast { get; set; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

GetGarage(GarageLocation)

Get a specific garage class instance from a garage ID

Declaration
public Garage GetGarage(GarageLocation garage)
Parameters
Type Name Description
GarageLocation garage
Returns
Type Description
Garage
| Improve this Doc View Source

GetGroundPosition(Vector3)

This function gets the position of the highest ground below a point.

Declaration
public float GetGroundPosition(Vector3 position)
Parameters
Type Name Description
Vector3 position
Returns
Type Description
Single
| Improve this Doc View Source

GetSurfaceProperty(SurfaceMaterialType, SurfaceMaterialProperty)

This method retrieves the value of a surface property.

Declaration
public dynamic GetSurfaceProperty(SurfaceMaterialType type, SurfaceMaterialProperty property)
Parameters
Type Name Description
SurfaceMaterialType type
SurfaceMaterialProperty property
Returns
Type Description
Object

A dynamic range of values, for a full list checkout: https://wiki.multitheftauto.com/wiki/EngineGetSurfaceProperties
| Improve this Doc View Source

GetWaterLevelAtPosition(Vector3, Boolean)

This function allows you to retrieve the water level from a certain location.

Declaration
public float GetWaterLevelAtPosition(Vector3 position, bool checkWaves = false)
Parameters
Type Name Description
Vector3 position
Boolean checkWaves
Returns
Type Description
Single
| Improve this Doc View Source

IsAmbientSoundEnabled(AmbientSound)

Check if a certain ambient sound is enabled

Declaration
public bool IsAmbientSoundEnabled(AmbientSound soundType)
Parameters
Type Name Description
AmbientSound soundType
Returns
Type Description
Boolean
| Improve this Doc View Source

IsRoomFurnitureEnabled(RoomFurniture)

Check whether furniture is enabled in a room

Declaration
public bool IsRoomFurnitureEnabled(RoomFurniture room)
Parameters
Type Name Description
RoomFurniture room
Returns
Type Description
Boolean
| Improve this Doc View Source

IsSoundEnabled(WorldSoundGroup, Int32)

This function allows you to check if certain world sound effects have not been disabled by setWorldSoundEnabled

Declaration
public bool IsSoundEnabled(WorldSoundGroup group, int index = -1)
Parameters
Type Name Description
WorldSoundGroup group
Int32 index
Returns
Type Description
Boolean
| Improve this Doc View Source

IsSpecialPropertyEnabled(WorldSpecialProperty)

Check if a certain special property is enabled

Declaration
public bool IsSpecialPropertyEnabled(WorldSpecialProperty property)
Parameters
Type Name Description
WorldSpecialProperty property
Returns
Type Description
Boolean
| Improve this Doc View Source

ResetAmbientSounds()

Resets all ambient sounds

Declaration
public bool ResetAmbientSounds()
Returns
Type Description
Boolean
| Improve this Doc View Source

ResetPedsLodDistance()

Reset the peds Lod distance

Declaration
public bool ResetPedsLodDistance()
Returns
Type Description
Boolean
| Improve this Doc View Source

ResetSurfaceProperty(SurfaceMaterialType)

Resets the surface properties of a material to the default values

Declaration
public void ResetSurfaceProperty(SurfaceMaterialType type)
Parameters
Type Name Description
SurfaceMaterialType type
| Improve this Doc View Source

ResetVehiclesLodDistance()

Reset the Lod distance of vehicles

Declaration
public bool ResetVehiclesLodDistance()
Returns
Type Description
Boolean
| Improve this Doc View Source

ResetWorldSounds()

Reset all world sound changes

Declaration
public bool ResetWorldSounds()
Returns
Type Description
Boolean
| Improve this Doc View Source

SetAmbientSoundEnabled(AmbientSound, Boolean)

Enables ambient sounds

Declaration
public bool SetAmbientSoundEnabled(AmbientSound soundType, bool enable = true)
Parameters
Type Name Description
AmbientSound soundType
Boolean enable
Returns
Type Description
Boolean
| Improve this Doc View Source

SetRoomFurnitureEnabled(RoomFurniture, Boolean)

This function toggles furniture generation in interiors with the specified room ID.

Declaration
public bool SetRoomFurnitureEnabled(RoomFurniture room, bool enabled)
Parameters
Type Name Description
RoomFurniture room
Boolean enabled
Returns
Type Description
Boolean
| Improve this Doc View Source

SetSoundEnabled(WorldSoundGroup, Boolean, Int32, Boolean)

Set a world sound group or specified element enabled or disabled

Declaration
public bool SetSoundEnabled(WorldSoundGroup group, bool enable, int index = -1, bool immediate = false)
Parameters
Type Name Description
WorldSoundGroup group
Boolean enable
Int32 index
Boolean immediate
Returns
Type Description
Boolean
| Improve this Doc View Source

SetSpecialPropertyEnabled(WorldSpecialProperty, Boolean)

Enables or disables a special world property.

Declaration
public bool SetSpecialPropertyEnabled(WorldSpecialProperty property, bool enable)
Parameters
Type Name Description
WorldSpecialProperty property
Boolean enable
Returns
Type Description
Boolean
| Improve this Doc View Source

SetSurfaceProperty(SurfaceMaterialType, SurfaceMaterialProperty, Object)

This method sets the value of a surface property

Declaration
public void SetSurfaceProperty(SurfaceMaterialType type, SurfaceMaterialProperty property, dynamic value)
Parameters
Type Name Description
SurfaceMaterialType type
SurfaceMaterialProperty property
Object value

A range of possible values. Checkout: https://wiki.multitheftauto.com/wiki/EngineSetSurfaceProperties