[This is preliminary documentation and is subject to change.]
The World type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| AddSpeedZone |
Adds a new speed zone limiting the maximum driving speed of AI-driven vehicles in an area.
| |
| CleanWorld |
Cleans the world.
| |
| ConvertScreenPositionToTrace |
Gets a trace start position and trace direction from the specified screen position.
| |
| ConvertWorldPositionToScreenPosition |
Converts the specified position from world space to screen space.
| |
| EnumerateObjects |
Gets an enumerable collection of the Objects currently in the game world.
| |
| EnumeratePeds |
Gets an enumerable collection of the Peds currently in the game world.
| |
| EnumerateVehicles |
Gets an enumerable collection of the Vehicles currently in the game world.
| |
| GetAllBlips |
Gets all Blips currently in the game world.
| |
| GetAllEntities |
Gets all entities currently in the game world.
| |
| GetAllFires |
Gets all fires currently in the game world.
| |
| GetAllGroups |
Gets all currently existing Groups.
| |
| GetAllObjects |
Gets all Objects currently in the game world.
| |
| GetAllPathNodeIds |
Gets the IDs of all path nodes currently loaded.
| |
| GetAllPeds |
Gets all Peds currently in the game world.
| |
| GetAllVehicles |
Gets all Vehicles currently in the game world.
| |
| GetAllWeapons |
Gets all Weapons currently in the game world.
| |
| GetBlipByHandle |
Gets an existing Blip from the specified handle.
| |
| GetClosestEntity(Entity, Vector3) |
Gets the closest entity to the specified position, within the specified radius.
| |
| GetClosestEntity(Vector3, Single, GetEntitiesFlags) | ||
| GetEntities(GetEntitiesFlags) | ||
| GetEntities(Vector3, Single, GetEntitiesFlags) | ||
| GetEntityByHandleEntityType |
Gets an existing Entity from the specified handle.
| |
| GetGroundZ |
Gets the Z value of the ground surface at the specified position.
| |
| GetGroupByHandle |
Gets an existing Group from the specified handle.
| |
| GetNextPositionOnStreet | ||
| GetRandomPositionOnStreet |
Gets a random street position.
| |
| GetStreetHash |
Gets the hash of the name of the street at the given position.
| |
| GetStreetName(UInt32) |
Gets the name of the street given its hash.
| |
| GetStreetName(Vector3) |
Gets the name of the street at the given position.
| |
| GetWaypointBlip |
Gets the waypoint blip set by the player.
| |
| IsPathNodeIdValid |
Determines whether the specified value is a valid path node identifier.
| |
| LoadNorthYankton |
Loads North Yankton into the game world.
| |
| RemoveSpeedZone |
Removes a speed zone given its handle.
| |
| SpawnExplosion |
Spawns an explosion at the specified position.
| |
| TeleportLocalPlayer | Teleports the local player to the specified position. | |
| TraceBox | ||
| TraceCapsule(Vector3, Vector3, Single, TraceFlags, Entity) | ||
| TraceCapsule(Vector3, Vector3, Single, TraceFlags, PredicateEntity) | ||
| TraceExtent(Vector3, Vector3, Single, TraceFlags, Entity) | Obsolete. | |
| TraceExtent(Vector3, Vector3, Single, TraceFlags, PredicateEntity) | Obsolete. | |
| TraceLine(Vector3, Vector3, TraceFlags, Entity) | ||
| TraceLine(Vector3, Vector3, TraceFlags, PredicateEntity) | ||
| TraceLine(Vector3, Vector3, Single, TraceFlags, PredicateEntity) | Obsolete. | |
| TransitionToWeather |
Starts transitioning the current weather to the specified weather, over the specified duration.
| |
| UnloadNorthYankton |
Unloads North Yankton from the game world.
|
See Also