Docs / Code addons / World and interaction hooks

World and interaction hooks

Door, access, vehicle, damage, local weapon prediction, host weapon authorization and hits, Physgun, voice, Toolgun and owned-object events.

Hooks and payloads

HookPayload and public membersTiming and effect
DoorActionRequestedLitherarpDoorActionRequest
Target, TargetObject, TargetKind, Action, nullable Actor, Deny		Cancelable after native validation, before a supported door open, close or knock.
DoorActionCommittedLitherarpDoorActionCommittedEvent
Target, TargetKind, Action, nullable Actor		Post-event after the host starts a transition or commits a knock.
AccessLockChangeRequestedLitherarpAccessLockChangeRequest
Access, TargetObject, TargetKind, nullable Actor, CurrentLocked, RequestedLocked, Cause; SetLocked, Deny		Cancelable actor-driven map-door or vehicle lock change after native authorization.
AccessLockChangedLitherarpAccessLockChangedEvent
Access, TargetKind, nullable Actor, PreviousLocked, IsLocked, Cause		Post-event after an observed lock state change, including non-cancelable startup_job_restricted and ownership_cleanup causes.
VehicleSeatEntryRequestedLitherarpVehicleSeatEntryRequest
Player, BasePlayer, Seat, Vehicle, Deny		Cancelable after native host validation, before occupant registration.
VehicleSeatEnteredLitherarpVehicleSeatEnteredEvent
Player, BasePlayer, Seat, Vehicle		Post-event after occupant registration and collision suppression.
VehicleSeatExitRequestedLitherarpVehicleSeatExitRequest
Player, BasePlayer, Seat, Vehicle, IsHostAuthoritative, Deny		Host-only cancelable request for a voluntary exit, after caller ownership, exact tracked seat, real occupancy, vehicle, roleplay state and door-state validation, before the host changes seat state. Denial preserves the seat and suppresses VehicleSeatExited. IsHostAuthoritative is retained for source compatibility and is always true.
VehicleSeatExitedLitherarpVehicleSeatExitedEvent
Player, BasePlayer, Seat, Vehicle		Host post-event once the tracker confirms a normal or forced exit and the seat is free. Forced exits do not raise the cancelable request.
WorldEntityDamageRequestedLitherarpWorldEntityDamageRequest
Target, nullable Attacker, RequestedDamage, Damage, Position, Origin, Tags, DamageTags; SetDamage, SetAttacker, SetPosition, SetOrigin, SetTags, AddTag, RemoveTag, Deny		Cancelable damage for core non-player IDamageable entities after their immunity filters. Mutators reject invalid objects, vectors, amounts and tags.
WorldEntityDamagedLitherarpWorldEntityDamagedEvent
Target, nullable Attacker, Damage, nullable RemainingHealth, IsLethal, Tags		Post-event after core non-player damage or breakable-glass shatter.
WorldEntityDestructionRequestedLitherarpWorldEntityDestructionRequest
Target, nullable Attacker, Reason, Deny		Cancelable before a core destructible is invalidated by damage or printer heat.
WorldEntityDestroyingLitherarpWorldEntityDestroyingEvent
Target, nullable Attacker, Reason		Notification immediately before approved destruction cleanup.
WeaponFireInputRequestedLitherarpWeaponFireRequest
Player, nullable RoleplayPlayer, Weapon, IsHostAuthoritative, Deny		Cancelable local input hook before owner prediction. IsHostAuthoritative is always false. A denial stops the compliant local action but is not host acceptance proof.
WeaponFireRequestedLitherarpWeaponFireRequest
Player, nullable RoleplayPlayer, Weapon, IsHostAuthoritative, Deny		Host-only cancelable decision after caller, pawn and weapon ownership, active-weapon, request sequence, rate, cadence and authoritative-ammo gates. IsHostAuthoritative is always true. Denial blocks authoritative ammunition, effects, hits and damage.
WeaponFireAuthorizedLitherarpWeaponFireAuthorizedEvent
Player, nullable RoleplayPlayer, Weapon, RequestId, TraceCredits		Host post-event after admission and ammunition reservation. This is the proof that the host accepted the correlated fire request. TraceCredits is clamped from 1 through 32.
WeaponFiredLitherarpWeaponFiredEvent
Player, nullable RoleplayPlayer, Weapon, AmmoBefore, AmmoAfter, IsHostAuthoritative		Local predicted completion for supported firearms, shotguns and grenades. IsHostAuthoritative is always false, and the event may occur even when the host later refuses the request.
WeaponTraceCompletedLitherarpWeaponTraceCompletedEvent
Player, nullable RoleplayPlayer, Weapon, Hit, nullable Target, Position, Direction, IsHostAuthoritative		One local predicted result per trace, including shotgun misses. IsHostAuthoritative is always false. This event does not prove that the host accepted the correlated hit.
WeaponReloadInputRequestedLitherarpWeaponReloadRequest
Player, nullable RoleplayPlayer, Weapon, ClipBefore, ReserveBefore, IsHostAuthoritative, Deny		Cancelable local reload input. IsHostAuthoritative is always false. A remote owner waits for the host decision before the reload task starts.
WeaponReloadRequestedLitherarpWeaponReloadRequest
Player, nullable RoleplayPlayer, Weapon, ClipBefore, ReserveBefore, IsHostAuthoritative, Deny		Host-only cancelable decision after caller, ownership, active-weapon, request sequence, rate and reload-availability checks. IsHostAuthoritative is always true. Denial prevents the authoritative reload session and reserve transfer.
WeaponReloadAuthorizedLitherarpWeaponReloadAuthorizedEvent
Player, nullable RoleplayPlayer, Weapon, RequestId, ClipBefore, ReserveBefore		Host post-event after a reload session is accepted. This is the host acceptance proof; reserve transfers must carry the session request id.
WeaponReloadStartedLitherarpWeaponReloadStartedEvent
Player, nullable RoleplayPlayer, Weapon, ClipBefore, ReserveBefore, IsHostAuthoritative		Local lifecycle event after an accepted reload task starts. The authority flag is true on the listen host and false on a remote owner.
WeaponReloadFinishedLitherarpWeaponReloadFinishedEvent
Player, nullable RoleplayPlayer, Weapon, ClipBefore, ClipAfter, ReserveAfter, Completed, IsHostAuthoritative		Local lifecycle event when a started reload completes or is canceled. Completed distinguishes the outcomes; host state is reconciled separately.
WeaponHitRequestedLitherarpWeaponHitRequest
nullable Attacker, BasePlayer, Weapon, Target, RequestedDamage, Damage, Position, Tags; SetDamage, Deny		Cancelable host-retraced hit after the correlated fire request consumes one TraceCredits unit, before target damage delivery.
WeaponHitCommittedLitherarpWeaponHitCommittedEvent
nullable Attacker, BasePlayer, Weapon, Target, Damage, Position, Tags		Host post-event after validated retraced damage delivery.
PhysgunActionRequestedLitherarpPhysgunActionRequest
Player, Physgun, Target, Action, Force; SetForce, Deny		Cancelable before a supported host Physgun mutation.
PhysgunActionCommittedLitherarpPhysgunActionCommittedEvent
Player, Physgun, Target, Action, Force		Post-event after the Physgun mutation.
PhysgunGrabRequestedLitherarpPhysgunGrabRequest
Player, Physgun, rigidbody Target, IsPulling, Deny		Cancelable once after core target and distance validation, before the host creates the control joint.
PhysgunGrabStartedLitherarpPhysgunGrabStartedEvent
Player, Physgun, Target, IsPulling		Post-event once when the host begins a grab. It is not a per-frame update.
PhysgunGrabEndedLitherarpPhysgunGrabEndedEvent
Player, Physgun, Target, WasPulling		Post-event once when a tracked grab ends.
VoiceRouteRequestedLitherarpVoiceRouteRequest
Speaker, Listener, Channel, DefaultAllowed, IsHardDenied, IsAllowed, HasOverride; Allow, Deny		High-frequency host routing decision. Hard mute and privacy denials cannot be overridden. The first explicit decision wins.
PropSpawnRequestedLitherarpPropSpawnRequest
Player, Ident, Deny		Cancelable spawn-menu prop or entity creation after limits and filters.
PropSpawnedLitherarpPropSpawnedEvent
Player, Ident, Object		Post-event after spawn-menu creation.
ToolgunActionRequestedLitherarpToolgunActionRequest
Player, Toolgun, ModeId, Action, Context, Deny		Universal Toolgun policy after owner and action-specific target, trace and payload validation, immediately before mutation. The context never exposes keypad PINs or complete blueprint documents.
ToolgunActionCommittedLitherarpToolgunActionCommittedEvent
Player, Toolgun, ModeId, Action, Context, readonly Results, nullable first Result		Post-event only after a native action succeeds or a registered custom action calls Commit after successful mutation.
OwnedObjectRegisteredLitherarpOwnedObjectRegisteredEvent
Owner, Object, PrefabSource		Post-event when the owned-object funnel stamps an object from spawn, Toolgun, duplicator, production, shop or vehicle flows.
DrugProductionReadyLitherarpDrugProductionReadyEvent
Kind, OwnerSteamId, Object		Post-event when an ownerless weed or meth production timer reaches ready state.

World enums

TypeValues
LitherarpDoorTargetKindMapDoor, VehicleDoor, VehicleHatch, HingedPanel, ElevatorDoor.
LitherarpDoorActionOpen, Close, Knock.
LitherarpAccessTargetKindMapDoor, Vehicle.
LitherarpPhysgunActionFreeze, Unfreeze, UnfreezeAll, Launch.
LitherarpVoiceChannelProximity, Phone.

Authority notes

Door, access, host weapon-hit, world damage, Physgun, voice, native Toolgun mutation and ownership hooks sit in LitheraRP core funnels. They do not intercept an arbitrary third-party component that calls GameObject.Destroy or mutates its own state directly.

Voluntary seat exit is decided on the host before seat state changes. Forced exits skip the cancelable request and remain observable through the host-confirmed VehicleSeatExited post-event.

Weapon authority

Use WeaponFireInputRequested and WeaponReloadInputRequested only for local input or presentation policy. Use WeaponFireRequested and WeaponReloadRequested for authoritative rules. Only the matching WeaponFireAuthorized or WeaponReloadAuthorized post-event proves host acceptance.

BoundaryVerified contract
Caller and sequenceThe host requires the RPC caller to own both pawn and weapon, and the weapon must be active. Request ids use positive wrap-aware ordering. Replays, older ids and forward jumps over 1,000,000 are rejected. Fire keeps at most 64 decisions and expires them.
Cadence and ammunitionFire admission combines the RPC limiter with a token bucket of capacity two, refilled at the weapon interval. Authoritative ammunition is reserved only after the addon hook accepts. ClipContents syncs from the host, and the listen host does not consume the same round twice.
Shotguns and effectsA fire grants 1 through 32 TraceCredits; a shotgun uses its clamped pellet count. Each request relays at most one primary muzzle or audio effect. Remote confirmed impacts are produced only after the host retrace accepts them.
GrenadesCooking remains local prediction. The host authorizes and reserves the authoritative consequence at projectile spawn or explode-in-hand, not when cooking starts.
ReloadA remote reload waits for the host response. Reserve transfers are tied to the accepted session, bounded by its capacity and lifetime, deduplicated by transfer id, and reconciled from host clip state. The host relays the reload effect once per session.

A host veto blocks authoritative ammunition use, projectiles, relays to other peers, confirmed impacts, hits and damage. It cannot erase recoil, sound or delay that a modified client already predicted only for itself.

PreviousEconomy and city hooks