Crate altv

Source
Expand description

Server-side alt:V API for Rust

How to use?

Re-exports§

pub use exports::anyhow;
pub use exports::serde;
pub use exports::erased_serde;
pub use exports::serde_bytes;
pub use exports::enumflags2;

Modules§

base_object
events
alt:V events
meta
Metadata
mvalue
MValue, stands for Multi Value, this is needed so you can tell alt:V how to understand Rust types in more general way to send or receive something from clients (players), or communicate with other alt:V resources.
prelude
reloading_docs
Reloading

Macros§

log
log_error
log_warn

Structs§

AmmoFlags
AttachToEntityBoneIndex
AttachToEntityBoneName
BaseObjectWrapper
ByteBuf
Wrapper around Vec<u8> to serialize and deserialize efficiently.
Decoration
MValueHashMap
PedModelInfo
PlayAnimation
PlayerDateTime
PlayerHeadBlendData
Quaternion
Resource
ResourceConfig
See alt:V docs: link
Rgba
ServerConfig
See alt:V docs: link
Timer
Vector2
Vector3
VehicleModelInfo
WeaponModelInfo

Enums§

AmmoSpecialType
AmmoType
AnimationFlags
See https://vhub.wiki/enums/ANIMATION_FLAGS
AnyBaseObject
AnyEntity
AnyWorldObject
BaseObjectFilter
BaseObjectType
Benefit
BlipType
ClosestEntitiesOrder
CloudAuthResult
ColShapeType
ConfigNode
ExplosionType
MarkerType
PlayerBodyPart
PlayerConnectDeniedReason
VehicleModelType
VoiceConnectionState

Constants§

DEFAULT_DIMENSION
DRIVER_SEAT
Examples
GLOBAL_DIMENSION

Traits§

BaseObjectPoolFuncs
ColShapy
Config
ConfigRootNodeStore
Entity
IntoVoidResult
WorldObject

Functions§

add_client_config_key
col_shape_tick_rate
get_ammo_hash_for_weapon_hash
get_closest_entities
Examples
get_entities_in_dimension
For examples see get_closest_entities
get_entities_in_range
For examples see get_closest_entities
has_benefit
hash
joaat hash function
hash_server_password
loaded_vehicle_models
log
log_warn
max_streaming_objects
max_streaming_peds
max_streaming_vehicles
migration_distance
migration_thread_count
migration_tick_rate
net_time
set_col_shape_tick_rate
set_interval
Examples
set_max_streaming_objects
set_max_streaming_peds
set_max_streaming_vehicles
set_migration_distance
set_migration_thread_count
set_migration_tick_rate
set_password
set_streamer_thread_count
set_streaming_distance
set_streaming_tick_rate
set_sync_receive_thread_count
set_sync_send_thread_count
set_timeout
Examples
set_voice_external
set_voice_external_public
stop_server
streamer_thread_count
streaming_distance
streaming_tick_rate
sync_receive_thread_count
sync_send_thread_count
toggle_world_profiler
voice_connection_state

Type Aliases§

BaseObjectId
Blip
Implementation
BlipContainer
Checkpoint
Implementation
CheckpointContainer
ColShape
Implementation
ColShapeContainer
Hash
Marker
Implementation
MarkerContainer
Object
Implementation
ObjectContainer
Ped
Implementation
PedContainer
Player
Implementation
PlayerContainer
SomeResult
SyncId
Vehicle
Implementation
VehicleContainer
VirtualEntity
Implementation
VirtualEntityContainer
VirtualEntityGroup
Implementation
VirtualEntityGroupContainer
VoiceChannel
Implementation
VoiceChannelContainer
VoidResult

Attribute Macros§

before_unload
Defines before_unload callback of your alt:V Rust resource. It will be called when resource is unloaded when reload feature is enabled, for example using stop <resource name> command in the server console.
main
Defines entry point of your alt:V Rust resource.