CreatePlayerMount
createPlayerMount
AVAILABLE FROM UPDATE 0.1.6
Upcoming 0.1.6: not yet publicly released and not included in public 0.1.5. This page documents the implemented API planned for that update.
Requests a native rideable scavenger assigned to a specific connected player.
Syntax
createPlayerMount(playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | Positive connection player ID. Call after authentication, spawn and receipt of a movement snapshot, with a mount-capable client. |
Returns
true when the server accepts and sends the creation request; false when it cannot grant/send it, including an existing lease, unavailable/ineligible player or missing mount support. This is not a native spawn completion acknowledgement or a mount object ID.
Examples
-- After your server-side permission and player-readiness checks:
local requested = createPlayerMount(playerId)
-- true is request acceptance, not a native spawn acknowledgement.
Notes
- Upcoming 0.1.6, not included in public 0.1.5. Server-side only; use this exact lowercase-leading Lua name. No uppercase alias is registered.
- One active mount per player. The caller resource owns its lifecycle and removal. Use destroyPlayerMount from that same resource.
- The native animal spawns near its owner. Model/coordinates are not parameters. Use ordinary native interactions for mounting and dismounting; other native restrictions remain.
- No fixed two-minute lifetime. Disconnect, resource stop, lost observations, life/eligibility changes and explicit removal still clean up the session.
- Assignment is to the current connection, not persistent account ownership. No transfer/getter/completion event is introduced. Do not spam retries.
- See Mounts for late join, remote presentation, received-hit handling, safety timeouts and remaining in-game validation. This does not grant gamemode administrator permission; authorize callers in your script.