rentProperty
Description
Triggered when a player attempts to rent a property.
Payload Structure
lua
Parameters
- source (number): The server ID of the player attempting the rental
- player (table): Complete player data object provided by the framework (ESX/QBCore)
- propertyId (string/number): Unique identifier for the property being rented
- rentAs (string): The rental context - typically 'player' for personal rental or 'gang' for organization rental
- rentDays (number): The duration of the rental period in days
Usage Example
lua
Return Values
- true or nil: Allow the property rental to continue
- false: Cancel the property rental and prevent the transaction