Skip to content
Rift
Search
Ctrl
K
Cancel
Discord
Select theme
Dark
Light
Auto
Rift
The Rift ECS
Gameplay hooks
Lifecycle hooks
Save files and persistence
Hooks
on_all_modals_closed
on_body_possessed
Advanced
on_body_released
Advanced
on_client_body_created
Advanced
on_command
on_component_option
on_create
on_enter_area
on_event
Advanced
on_hour
on_idle_logout_due
on_input
Advanced
on_inventory_option
on_leave_area
on_level_up
on_load
on_logging_out
on_login
on_logout_requested
on_minimap_click
on_modal_opened
on_music_ended
on_new_account
on_npc_option
on_object_option
on_participant_released
on_phase
on_place_recovered
on_player_option
on_public_chat
on_realm_stop
on_self_despawn
on_self_entered
on_self_event
on_self_hit
on_self_item_used
on_self_left
on_self_option
on_self_participant_released
on_self_spawn
on_sequence
on_sequence_end
on_ui_component_click
on_ui_component_drag
on_ui_continue
on_ui_item_submit
on_ui_name_submit
on_ui_number_submit
on_ui_text_submit
on_world_click
on_world_item_option
on_world_start
on_xp_gain
Declarations
day_cycle
define_area
engine_config
game_loop
node
self
sequence
Rift: API Reference
Overview
rift.assets
Overview
rift.chat
Overview
rift.components
Overview
rift.entities
Overview
rift.inputs
Overview
rift.items
Overview
rift.moderation
Overview
rift.scripting
Overview
rift.ui
Overview
rift.util
Overview
rift.world
Overview
rift.cmd.cli
Advanced
Overview
rift.config
Advanced
Overview
rift.ecs
Advanced
Overview
rift.packages
Advanced
Overview
rift.packets
Advanced
Overview
AddWorldItemSpecificPacket
Advanced
AddWorldObjectPacket
Advanced
AffinedClanMember
Advanced
AnimateNpcPacket
Advanced
AnimatePlayerPacket
Advanced
AnimateWorldObjectPacket
Advanced
AnimateWorldObjectZoneWidePacket
Advanced
BannedClanMember
Advanced
BeginPacketGroupPacket
Advanced
CamTarget
Advanced
CamTargetNpc
Advanced
CamTargetPlayer
Advanced
CamTargetWorldEntity
Advanced
CameraEaseFunction
Advanced
CameraLookAtCyclesPacket
Advanced
CameraLookAtEasedPacket
Advanced
CameraLookAtEasedTrackPacket
Advanced
CameraLookAtPacket
Advanced
CameraMoveToArcPacket
Advanced
CameraMoveToCyclesPacket
Advanced
CameraMoveToPacket
Advanced
CameraResetPacket
Advanced
CameraRotateByPacket
Advanced
CameraRotateToPacket
Advanced
CameraShakePacket
Advanced
CameraSmoothResetPacket
Advanced
CameraUnlockPacket
Advanced
ClanChannelDeltaEventAddUser
Advanced
ClanChannelDeltaEventDeleteUser
Advanced
ClanChannelDeltaEventUpdateBaseSettings
Advanced
ClanChannelDeltaEventUpdateUserDetails
Advanced
ClanChannelDeltaEventUpdateUserDetailsV2
Advanced
ClanChannelDeltaPacket
Advanced
ClanChannelFullPacket
Advanced
ClanChannelFullUpdate
Advanced
ClanChannelFullUpdateJoin
Advanced
ClanChannelFullUpdateLeave
Advanced
ClanChannelMember
Advanced
ClanChannelMessagePacket
Advanced
ClanChannelSystemMessagePacket
Advanced
ClanSetting
Advanced
ClanSettingIntSetting
Advanced
ClanSettingLongSetting
Advanced
ClanSettingStringSetting
Advanced
ClanSettingsDeltaPacket
Advanced
ClanSettingsDeltaUpdate
Advanced
ClanSettingsDeltaUpdateAddBanned
Advanced
ClanSettingsDeltaUpdateAddMemberV1
Advanced
ClanSettingsDeltaUpdateAddMemberV2
Advanced
ClanSettingsDeltaUpdateBaseSettings
Advanced
ClanSettingsDeltaUpdateDeleteBanned
Advanced
ClanSettingsDeltaUpdateDeleteMember
Advanced
ClanSettingsDeltaUpdateSetClanName
Advanced
ClanSettingsDeltaUpdateSetClanOwner
Advanced
ClanSettingsDeltaUpdateSetIntSetting
Advanced
ClanSettingsDeltaUpdateSetLongSetting
Advanced
ClanSettingsDeltaUpdateSetMemberExtraInfo
Advanced
ClanSettingsDeltaUpdateSetMemberMuted
Advanced
ClanSettingsDeltaUpdateSetMemberRank
Advanced
ClanSettingsDeltaUpdateSetStringSetting
Advanced
ClanSettingsDeltaUpdateSetVarbitSetting
Advanced
ClanSettingsFullPacket
Advanced
ClanSettingsFullUpdate
Advanced
ClanSettingsFullUpdateJoin
Advanced
ClanSettingsFullUpdateLeave
Advanced
ClearInterfaceInventoryPacket
Advanced
CloseInterfacePacket
Advanced
CustomiseWorldItemPacket
Advanced
DisableClanVarPacket
Advanced
EnableClanVarPacket
Advanced
FriendChatChannelEntry
Advanced
FriendChatChannelFullPacket
Advanced
FriendChatChannelUpdate
Advanced
FriendChatChannelUpdateJoin
Advanced
FriendChatChannelUpdateLeave
Advanced
FriendChatChannelUser
Advanced
FriendChatChannelUserAdded
Advanced
FriendChatChannelUserRemoved
Advanced
FriendChatChannelUserUpdatePacket
Advanced
FriendChatMessagePacket
Advanced
FriendEntry
Advanced
FriendEntryOffline
Advanced
FriendEntryOnline
Advanced
FriendListLoadedPacket
Advanced
GameMessagePacket
Advanced
HideNpcOptionsPacket
Advanced
HideWorldItemOptionsPacket
Advanced
HideWorldObjectOptionsPacket
Advanced
HintArrow
Advanced
HintArrowNpc
Advanced
HintArrowPlayer
Advanced
HintArrowReset
Advanced
HintArrowTile
Advanced
HintArrowTilePosition
Advanced
HintArrowWorldEntity
Advanced
HiscoreEntry
Advanced
HiscoreReplyPacket
Advanced
HiscoreResponse
Advanced
HiscoreResponseFailed
Advanced
HiscoreResponseSuccessful
Advanced
IfResyncV2SubInterface
Advanced
IgnoredPlayer
Advanced
IgnoredPlayerAddedIgnoredEntry
Advanced
IgnoredPlayerRemovedIgnoredEntry
Advanced
InventorySlotUpdate
Advanced
LogoutPacket
Advanced
LogoutWithReasonPacket
Advanced
MergeWorldObjectWithActorPacket
Advanced
MoveInterfacePacket
Advanced
NpcInfoLargePacket
Advanced
NpcInfoSmallPacket
Advanced
OculusSyncPacket
Advanced
OpFlags
Advanced
OpenInterfacePacket
Advanced
OpenRootInterfacePacket
Advanced
OpenUrlPacket
Advanced
OutgoingGamePacket
Advanced
PlayGraphicPacket
Advanced
PlayJinglePacket
Advanced
PlayMusicPacket
Advanced
PlayMusicWithSecondaryPacket
Advanced
PlayNpcGraphicPacket
Advanced
PlayProjectilePacket
Advanced
PlaySoundPacket
Advanced
PlayWorldGraphicPacket
Advanced
PlayWorldGraphicZoneWidePacket
Advanced
PlayWorldSoundPacket
Advanced
PlayerInfoPacket
Advanced
PrivateMessagePacket
Advanced
PrivateMessageSentPacket
Advanced
RebuildLoginV2Packet
Advanced
RebuildNormalV2Packet
Advanced
RebuildRegionV2Packet
Advanced
RebuildWorldEntityV4Packet
Advanced
ReflectionCheck
Advanced
ReflectionCheckGetFieldModifiers
Advanced
ReflectionCheckGetFieldValue
Advanced
ReflectionCheckGetMethodModifiers
Advanced
ReflectionCheckInvokeMethod
Advanced
ReflectionCheckPacket
Advanced
ReflectionCheckSetFieldValue
Advanced
RemoveWorldItemSpecificPacket
Advanced
RemoveWorldObjectPacket
Advanced
ResetAnimationsPacket
Advanced
ResetInteractionModePacket
Advanced
ResetTradingPostPacket
Advanced
ResetVarPlayersPacket
Advanced
ResyncInterfacePacket
Advanced
RunClientScriptPacket
Advanced
SendPingPacket
Advanced
ServerTickEndPacket
Advanced
SetAccountFlagsPacket
Advanced
SetActiveWorldPacket
Advanced
SetCameraModePacket
Advanced
SetCameraTargetPacket
Advanced
SetChatFiltersPacket
Advanced
SetClanVarPacket
Advanced
SetHeatmapEnabledPacket
Advanced
SetHintArrowPacket
Advanced
SetInteractionModePacket
Advanced
SetInterfaceActiveNpcHeadPacket
Advanced
SetInterfaceAnglePacket
Advanced
SetInterfaceAnimationPacket
Advanced
SetInterfaceColourPacket
Advanced
SetInterfaceEventsPacket
Advanced
SetInterfaceHiddenPacket
Advanced
SetInterfaceModelPacket
Advanced
SetInterfaceNpcHeadPacket
Advanced
SetInterfaceObjectPacket
Advanced
SetInterfacePlayerHeadPacket
Advanced
SetInterfacePlayerModelBodyTypePacket
Advanced
SetInterfacePlayerModelColourPacket
Advanced
SetInterfacePlayerModelItemPacket
Advanced
SetInterfacePlayerModelSelfPacket
Advanced
SetInterfacePositionPacket
Advanced
SetInterfaceRotateSpeedPacket
Advanced
SetInterfaceScrollPositionPacket
Advanced
SetInterfaceTextPacket
Advanced
SetMapFlagPacket
Advanced
SetNpcOverheadIconPacket
Advanced
SetNpcUpdateOriginPacket
Advanced
SetPlayerOptionPacket
Advanced
SetPrivateChatFilterPacket
Advanced
SetRebootTimerPacket
Advanced
SetSiteSettingsPacket
Advanced
SetWorldItemCountSpecificPacket
Advanced
SetWorldItemOptionsPacket
Advanced
SetZBufferPacket
Advanced
StockMarketSlotUpdate
Advanced
StockMarketSlotUpdateReset
Advanced
StockMarketSlotUpdateSet
Advanced
StopInventoryTransmitPacket
Advanced
StopMusicPacket
Advanced
SwapMusicPacket
Advanced
SyncVarPlayersPacket
Advanced
ToggleMinimapPacket
Advanced
TradingPostOffer
Advanced
TransferWorldPacket
Advanced
TriggerOnDialogAbortPacket
Advanced
UncustomiseWorldItemPacket
Advanced
UnknownStringPacket
Advanced
UpdateClientUidPacket
Advanced
UpdateFriendListPacket
Advanced
UpdateIgnoreListPacket
Advanced
UpdateInventoryFullPacket
Advanced
UpdateInventoryPartialPacket
Advanced
UpdateRunEnergyPacket
Advanced
UpdateRunWeightPacket
Advanced
UpdateSkillPacket
Advanced
UpdateStockMarketSlotPacket
Advanced
UpdateTradingPostOffersPacket
Advanced
VarClanData
Advanced
VarClanDataIntData
Advanced
VarClanDataLongData
Advanced
VarClanDataStringData
Advanced
VarPlayerLargePacket
Advanced
VarPlayerSmallPacket
Advanced
WorldEntityInfoPacket
Advanced
ZoneFullUpdatePacket
Advanced
ZonePartialEnclosedUpdatePacket
Advanced
ZonePartialFollowsUpdatePacket
Advanced
rift.sequences
Advanced
Overview
rift.social
Advanced
Overview
Scripting: Riftlang
Getting started with Riftlang
Guides
Riftlang for JS/TS programmers
Riftlang for Java programmers
Riftlang for Kotlin programmers
Riftlang tooling in 5 minutes
Language reference
Basic syntax
Types
Control flow
Null safety
Functions and lambdas
Classes and objects
Packages and imports
Keyword reference
UI: ts2
Getting started with ts2
Quick start
Essentials
Writing markup
Your first component
Passing props
Conditional rendering
Rendering lists
Layout and geometry
Data
Composing components
Responding to events
Referencing components with refs
Hover and menus
Keyboard, input and drag
Game state
Interface state
Watching and reacting
Timers
How updates happen
Talking to the game
Interfaces and slots
Server entry points
Engine hooks
Writing it well
Reference
Overview
Elements
Common props
<layer>
<rect>
<text>
<sprite>
<model>
<line>
<input>
<ui>
Hooks
Hooks
useServerState
useSkill
useSkillBase
useInventory
predictServerState
useState
sessionState
persistedState
useRef
createRef
useInterval
useDelay
stopTimer
onMounted
onUpdated
useWatch
useRerenderOn
useOnResize
useUniverse
Engine
useDerived
useServerStateOnce
resumePauseButton
param
defineEngineHooks
intArray
Event
Types
Collections
Globals
Standard library
Supported syntax
ts2.config.json
The ts2 command
Build outputs
Diagnostics
Rules of ts2
Extra topics
How updates reach the screen
Three kinds of list
Coming from a component framework
Learn
ECS Fundamentals
Discord
Select theme
Dark
Light
Auto
SwapMusicPacket
Advanced
class
SwapMusicPacket : OutgoingGamePacket()