Expand description
Server-side alt:V API for Rust
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§
Structs§
- Ammo
Flags - Attach
ToEntity Bone Index - Attach
ToEntity Bone Name - Base
Object Wrapper - ByteBuf
- Wrapper around
Vec<u8>
to serialize and deserialize efficiently. - Decoration
- MValue
Hash Map - PedModel
Info - Play
Animation - Player
Date Time - Player
Head Blend Data - Quaternion
- Resource
- Resource
Config - See alt:V docs: link
- Rgba
- Server
Config - See alt:V docs: link
- Timer
- Vector2
- Vector3
- Vehicle
Model Info - Weapon
Model Info
Enums§
- Ammo
Special Type - Ammo
Type - Animation
Flags - See https://vhub.wiki/enums/ANIMATION_FLAGS
- AnyBase
Object - AnyEntity
- AnyWorld
Object - Base
Object Filter - Base
Object Type - Benefit
- Blip
Type - Closest
Entities Order - Cloud
Auth Result - ColShape
Type - Config
Node - Explosion
Type - Marker
Type - Player
Body Part - Player
Connect Denied Reason - Vehicle
Model Type - Voice
Connection State
Constants§
Traits§
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§
- Base
Object Id - Blip
- Implementation
- Blip
Container - Checkpoint
- Implementation
- Checkpoint
Container - ColShape
- Implementation
- ColShape
Container - Hash
- Marker
- Implementation
- Marker
Container - Object
- Implementation
- Object
Container - Ped
- Implementation
- PedContainer
- Player
- Implementation
- Player
Container - Some
Result - SyncId
- Vehicle
- Implementation
- Vehicle
Container - Virtual
Entity - Implementation
- Virtual
Entity Container - Virtual
Entity Group - Implementation
- Virtual
Entity Group Container - Voice
Channel - Implementation
- Voice
Channel Container - Void
Result
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 usingstop <resource name>
command in the server console. - main
- Defines entry point of your alt:V Rust resource.