DestroyPlayerMount
destroyPlayerMount
AVAILABLE FROM UPDATE 0.1.6
Available since G1R:MP 0.1.6. Use the matching client and server (Protocol 38).
Requests safe removal of a player's mount owned by the calling server resource.
Syntax
destroyPlayerMount(playerId)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
playerId |
int |
yes | Positive connection player ID used with createPlayerMount; not a mount actor ID. |
Returns
true when removal is accepted, including a no-op when no active lease remains; false for a zero target or an active mount owned by a different resource. Acceptance is not a native detachment/destruction completion acknowledgement.
Examples
-- From the same server resource that requested creation:
local requested = destroyPlayerMount(playerId)
Notes
- Available since 0.1.6. Server-side only; no uppercase alias is registered.
- Call from the resource that created the active mount. This ends its session; it is not merely a request to dismount while retaining the animal.
- The native client waits for safe human detachment/restoration before cleaning up the exact owned spawn request. Do not assume removal completes synchronously.
- Only the riding-skill contribution owned by the mount session is removed; a pre-existing permanent riding skill is not cleared.
- Do not immediately recreate in a tight loop: server lease revocation and native cleanup are asynchronous. There is no mount-removed callback in this API.
- See Mounts for ownership, automatic cleanup, limitations and verification status.