Rift: API Reference
Browse by task
Section titled “Browse by task”Spawn and remove NPCs
Section titled “Spawn and remove NPCs”spawnNpcDefinitionNpcTile4DirectionspeakrespawningRespawnGroupRespawnsDespawnSpeedDistancesPathfindingisVisibleTohasVisibilityFilter
Put items on the ground and pick them up
Section titled “Put items on the ground and pick them up”Change world objects
Section titled “Change world objects”WorldObjectDefinitionWorldObjectspawnreplaceWithon_object_optionworldObjectWorldObjectSettings
Respond to clicks and options
Section titled “Respond to clicks and options”on_npc_optionon_object_optionon_world_item_optionon_player_optionon_self_optionon_world_clickisPlayerisUserControlledisOnline
Open interfaces and reveal a slot
Section titled “Open interfaces and reveal a slot”UserInterfaceUINameOverlayToplevelsTs2Interfaceson_ui_component_clickon_component_optionComponentMenusServerScriptsTs2ScriptsTs2WireIds
Bags and inventories
Section titled “Bags and inventories”Move and teleport
Section titled “Move and teleport”Areas, shards and scenes
Section titled “Areas, shards and scenes”AreaRefdefine_areaon_enter_areaon_leave_areaSceneShardisIncurrentShardshardshardIdSpacesScenePlacesNodeScripts
Find what is nearby
Section titled “Find what is nearby”WorldWorldSpatialIndexplayersWithinnpcsWithinentitiesWithinprojectionsWithinCollisionFlagCollisionStrategyNormalCollisionStrategyBlockedCollisionStrategyIndoorsCollisionStrategyOutdoorsCollisionStrategyLineOfSight
Chat and messages
Section titled “Chat and messages”Camera, sounds and hitsplats
Section titled “Camera, sounds and hitsplats”Skills and experience
Section titled “Skills and experience”Logins, saves and players
Section titled “Logins, saves and players”on_loginon_new_accountActorsavekickinGroupon_place_recoveredplaceRecoveredKeyIdleTimeoutsEveryoneworldNumber
Your own events
Section titled “Your own events”on_eventAdvancedEntityKind
World start, the day’s clock and realm records
Section titled “World start, the day’s clock and realm records”Moderation
Section titled “Moderation”Packages
Section titled “Packages”rift.assetsrift.chatrift.componentsrift.entitiesrift.inputsrift.itemsrift.moderationrift.scriptingrift.uirift.utilrift.worldrift.cmd.cliAdvancedrift.configAdvancedrift.ecsAdvancedrift.packagesAdvancedrift.packetsAdvancedrift.sequencesAdvancedrift.socialAdvanced
A to Z
Section titled “A to Z”AccountActiveDuringActorAddFriendInputAddIgnoreInputAddWorldItemSpecificPacketAdvancedAddWorldObjectPacketAdvancedAffinedClanMemberAdvancedAnchorAdvancedAnglesAnimateNpcPacketAdvancedAnimatePlayerPacketAdvancedAnimateWorldObjectPacketAdvancedAnimateWorldObjectZoneWidePacketAdvancedAnimatingAnimationCyclesAdvancedAnimationDefinitionAnonymousSystemAdvancedAnonymousSystemBaseAdvancedAnonymousSystemWithOptionalAdvancedAppearanceAppletFocusInputAreaBoundsAreaRectAreaRefAreaSystemAdvancedArgumentAdvancedArmourBarAssetAssetSearchAdvancedAssetSearchMatchAdvancedAssetSearchMatchAmbiguousAdvancedAssetSearchMatchFoundAdvancedAssetSearchMatchNumberAdvancedAssetSearchMatchUnknownAdvancedAssetSearchResultAdvancedAssetSearchResultFoundAdvancedAssetSearchResultRefusedAdvancedAttackOptionAttackSettingsAudioAuraBanClanChannelMemberInputBannedClanMemberAdvancedBeginPacketGroupPacketAdvancedBodyPartDefinitionBugReportInputCameraCameraEaseFunctionAdvancedCameraLookAtCyclesPacketAdvancedCameraLookAtEasedPacketAdvancedCameraLookAtEasedTrackPacketAdvancedCameraLookAtPacketAdvancedCameraMoveToArcPacketAdvancedCameraMoveToCyclesPacketAdvancedCameraMoveToPacketAdvancedCameraPositionChangeInputCameraResetPacketAdvancedCameraRotateByPacketAdvancedCameraRotateToPacketAdvancedCameraSettingsCameraShakePacketAdvancedCameraSmoothResetPacketAdvancedCameraUnlockPacketAdvancedCamTargetAdvancedCamTargetNpcAdvancedCamTargetPlayerAdvancedCamTargetWorldEntityAdvancedChargeBarChatChannelsOffChatColourChatCrownChatEffectChatIconChatMessageTypeClanChannelChangeAdvancedClanChannelChangeAddUserAdvancedClanChannelChangeDeleteUserAdvancedClanChannelChangeSettingsAdvancedClanChannelChangeUpdateUserAdvancedClanChannelDeltaEventAddUserAdvancedClanChannelDeltaEventDeleteUserAdvancedClanChannelDeltaEventUpdateBaseSettingsAdvancedClanChannelDeltaEventUpdateUserDetailsAdvancedClanChannelDeltaEventUpdateUserDetailsV2AdvancedClanChannelDeltaPacketAdvancedClanChannelFullPacketAdvancedClanChannelFullUpdateAdvancedClanChannelFullUpdateJoinAdvancedClanChannelFullUpdateLeaveAdvancedClanChannelMemberAdvancedClanChannelMessagePacketAdvancedClanChannelStateAdvancedClanChannelSystemMessagePacketAdvancedClanChannelUserAdvancedClanChatSubmitMessageInputClanLineAdvancedClanSettingAdvancedClanSettingIntSettingAdvancedClanSettingLongSettingAdvancedClanSettingsChangeAdvancedClanSettingsChangeAddBannedAdvancedClanSettingsChangeAddMemberAdvancedClanSettingsChangeBaseSettingsAdvancedClanSettingsChangeDeleteBannedAdvancedClanSettingsChangeDeleteMemberAdvancedClanSettingsChangeRenameAdvancedClanSettingsChangeSetMemberMutedAdvancedClanSettingsChangeSetMemberRankAdvancedClanSettingsChangeSetOwnerAdvancedClanSettingsDeltaPacketAdvancedClanSettingsDeltaUpdateAdvancedClanSettingsDeltaUpdateAddBannedAdvancedClanSettingsDeltaUpdateAddMemberV1AdvancedClanSettingsDeltaUpdateAddMemberV2AdvancedClanSettingsDeltaUpdateBaseSettingsAdvancedClanSettingsDeltaUpdateDeleteBannedAdvancedClanSettingsDeltaUpdateDeleteMemberAdvancedClanSettingsDeltaUpdateSetClanNameAdvancedClanSettingsDeltaUpdateSetClanOwnerAdvancedClanSettingsDeltaUpdateSetIntSettingAdvancedClanSettingsDeltaUpdateSetLongSettingAdvancedClanSettingsDeltaUpdateSetMemberExtraInfoAdvancedClanSettingsDeltaUpdateSetMemberMutedAdvancedClanSettingsDeltaUpdateSetMemberRankAdvancedClanSettingsDeltaUpdateSetStringSettingAdvancedClanSettingsDeltaUpdateSetVarbitSettingAdvancedClanSettingsFullPacketAdvancedClanSettingsFullUpdateAdvancedClanSettingsFullUpdateJoinAdvancedClanSettingsFullUpdateLeaveAdvancedClanSettingsMemberAdvancedClanSettingsStateAdvancedClanSettingStringSettingAdvancedClanSlotAdvancedClanSystemLineAdvancedClanWireAdvancedClearInterfaceInventoryPacketAdvancedClientScriptCallClientScriptsClientSideUsergroupCloseInterfacePacketAdvancedCloseModalInputCollisionFlagCollisionStrategyCollisionStrategyBlockedCollisionStrategyIndoorsCollisionStrategyLineOfSightCollisionStrategyNormalCollisionStrategyOutdoorsCollisionViewCommandAdvancedCommandRegistryComponentComponentAdvancedComponentIdAdvancedComponentMenuComponentMenusComponentNameComponentsAdvancedComponentSetAdvancedComponentsFiveAdvancedComponentsFourAdvancedComponentsNoneAdvancedComponentsOneAdvancedComponentsSevenAdvancedComponentsSixAdvancedComponentsThreeAdvancedComponentsTwoAdvancedConfigColumnAdvancedConfigDatabaseAdvancedConfigDatabaseResultAdvancedConfigNamesAdvancedConfigRecordAdvancedConfigRefusalAdvancedConfigRowNodeAdvancedConfigTableAdvancedConfigTableRecordFieldsAdvancedConfigTablesAdvancedConfigTypeAdvancedConfigTypeBoolAdvancedConfigTypeIntTypeAdvancedConfigTypeListOfAdvancedConfigTypeMapOfAdvancedConfigTypeOtherAdvancedConfigTypeRecordAdvancedConfigTypeTextAdvancedConnectionTelemetryInputContextMenuControlledCopiedSpaceCrmViewClickInputCrossShardMinimapClickInputCrossShardTileClickInputCrossShardUseInterfaceComponentOnWorldItemInputCrossShardUseInterfaceComponentOnWorldObjectInputCrossShardWorldItemOption1InputCrossShardWorldItemOption2InputCrossShardWorldItemOption3InputCrossShardWorldItemOption4InputCrossShardWorldItemOption5InputCrossShardWorldItemOption6InputCrossShardWorldObjectOption1InputCrossShardWorldObjectOption2InputCrossShardWorldObjectOption3InputCrossShardWorldObjectOption4InputCrossShardWorldObjectOption5InputCustomiseWorldItemPacketAdvancedday_cycleDayCycleAdvancedDayPhaseDbRowDefinitionDbTableDefinitiondefine_areaDefinitionServiceAdvancedDespawnDetectModifiedClientInputDeveloperCommandDefinitionDeveloperCommandInputDialogContinueInputDialogNumberInputDialogNumberLongInputDialogObjectInputDialogPlayerNameInputDialogTextInputDirectedByDirectionDirectorDirtyAdvancedDirtyIntArrayAdvancedDirtyMutableListAdvancedDisableClanVarPacketAdvancedDisconnectGraceDisconnectingDisconnectReasonDistancesEnableClanVarPacketAdvancedEngineengine_configEngineConfigAdvancedEngineGenerationAdvancedEntityEntityBucketAdvancedEntityBucketOfAdvancedEntityBucketRestAdvancedEntityKindEntityListEnumDefinitionEquipmentEquipmentSlotEveryoneFacingFaultKindAdvancedFaultRecordAdvancedFaultsAdvancedFaultSinkAdvancedFaultSinkNoneAdvancedFaultSiteAdvancedFootprintFriendChatChannelEntryAdvancedFriendChatChannelFullPacketAdvancedFriendChatChannelUpdateAdvancedFriendChatChannelUpdateJoinAdvancedFriendChatChannelUpdateLeaveAdvancedFriendChatChannelUserAdvancedFriendChatChannelUserAddedAdvancedFriendChatChannelUserRemovedAdvancedFriendChatChannelUserUpdatePacketAdvancedFriendChatMessagePacketAdvancedFriendChatSubmitMessageInputFriendEntryAdvancedFriendEntryOfflineAdvancedFriendEntryOnlineAdvancedFriendListLoadedPacketAdvancedFrozenPosegame_loopGameLoopAdvancedGameLoopMovementAdvancedGameLoopSlotAdvancedGameMessagePacketAdvancedGlobalSceneGraphicGraphicDefinitionGraphicSlotHeadingHeadingModeHealthBarHealthBarDefinitionHideNpcOptionsPacketAdvancedHideWorldItemOptionsPacketAdvancedHideWorldObjectOptionsPacketAdvancedHintArrowAdvancedHintArrowNpcAdvancedHintArrowPlayerAdvancedHintArrowResetAdvancedHintArrowTileAdvancedHintArrowTilePositionAdvancedHintArrowWorldEntityAdvancedHiscoreEntryAdvancedHiscoreReplyPacketAdvancedHiscoreRequestInputHiscoreResponseAdvancedHiscoreResponseFailedAdvancedHiscoreResponseSuccessfulAdvancedHitpointsHitSplatHitsplatDefinitionHitSplatsIdentityIdleClockIdleInputIdleTimeoutsIfResyncV2SubInterfaceAdvancedIgnoredPlayerAdvancedIgnoredPlayerAddedIgnoredEntryAdvancedIgnoredPlayerRemovedIgnoredEntryAdvancedImpersonatingInstanceMapInterfaceButtonClickInputInterfaceComponentClickInputInterfaceContextMenuOptionClickInputInterfaceDefinitionInterfaceDragItemBetweenSlotsInputInventoriesAdvancedInventoryInventoryDefinitionInventorySizesInventorySlotUpdateAdvancedInvisibleItemItemBindingsAdvancedItemContainerItemContainerResultItemContainerStackBehaviourItemDefinitionItemMenuItemsAdvancedItemTransactionJingleDefinitionJingleEndInputJinglesAdvancedJoinLeaveFriendChatInputKeyboardKeyPressInputKickClanChannelMemberInputKickFriendChatMemberInputLeaveOculusInputLegacyMouseClickInputLockLevelLogoutDelayLogoutPacketAdvancedLogoutWithReasonPacketAdvancedLoopProfilerAdvancedMadeAsMapBuildCompleteInputMenuOptionMenuScopeMergeWorldObjectWithActorPacketAdvancedMinimapClickInputModalMouseClickInputMouseMoveEntryMouseMoveInputMouseScrollInputMoveInterfacePacketAdvancedMovementAnimationsMoveTraceMovingMusicAdvancedMusicDefinitionMuteClanChannelMemberInputNativeMouseClickInputNativeMouseMoveEntryNativeMouseMoveInputNewlyMintedAdvancednodeNodeRefNodeScriptNodeScriptsNoTimeoutInputNotPersistedAdvancedNpcNpcBodyNpcDefinitionNpcInfoLargePacketAdvancedNpcInfoSmallPacketAdvancedNpcOption1InputNpcOption2InputNpcOption3InputNpcOption4InputNpcOption5InputNpcOption6InputNpcsAdvancedNpcTargetInputOculusSyncPacketAdvancedon_all_modals_closedon_body_possessedAdvancedon_body_releasedAdvancedon_client_body_createdAdvancedon_commandon_component_optionon_createon_enter_areaon_eventAdvancedon_houron_idle_logout_dueon_inputAdvancedon_inventory_optionon_leave_areaon_level_upon_loadon_logging_outon_loginon_logout_requestedon_minimap_clickon_modal_openedon_music_endedon_new_accounton_npc_optionon_object_optionon_participant_releasedon_phaseon_place_recoveredon_player_optionon_public_chaton_realm_stopon_self_despawnon_self_enteredon_self_eventon_self_hiton_self_item_usedon_self_lefton_self_optionon_self_participant_releasedon_self_spawnon_sequenceon_sequence_endon_ui_component_clickon_ui_component_dragon_ui_continueon_ui_item_submiton_ui_name_submiton_ui_number_submiton_ui_text_submiton_world_clickon_world_item_optionon_world_starton_xp_gainOpenInterfacePacketAdvancedOpenModeOpenRootInterfacePacketAdvancedOpenUrlPacketAdvancedOpFlagsAdvancedOptionAdvancedOptionalComponentsAdvancedOptionalComponentsFiveAdvancedOptionalComponentsFourAdvancedOptionalComponentsNoneAdvancedOptionalComponentsOneAdvancedOptionalComponentsSevenAdvancedOptionalComponentsSixAdvancedOptionalComponentsThreeAdvancedOptionalComponentsTwoAdvancedOutgoingGamePacketAdvancedOverheadBarOverheadsAdvancedOverheadSlotOverheadSpriteDefinitionOverlayOwnedPackageImportsAdvancedParticipantsPathfindingPermissionsPersistAdvancedPersistCodecAdvancedPersistCodecNoneAdvancedPersistentAdvancedPersistentValueAdvancedPersistShapeAdvancedPersistShapeElementsAdvancedPersistShapeEntriesAdvancedPersistShapeJsonAdvancedPersistShapeRecordAdvancedPersistShapeValueAdvancedPhysicsPingReplyInputPlaceableAdvancedPlaceableParamAdvancedPlaceablePlacedAdvancedPlaceablesAdvancedPlayerInfoPacketAdvancedPlayerOption1InputPlayerOption2InputPlayerOption3InputPlayerOption4InputPlayerOption5InputPlayerOption6InputPlayerOption7InputPlayerOption8InputPlayerSyncViewAdvancedPlayerTargetInputPlayGraphicPacketAdvancedPlayJinglePacketAdvancedPlayMusicPacketAdvancedPlayMusicWithSecondaryPacketAdvancedPlayNpcGraphicPacketAdvancedPlayProjectilePacketAdvancedPlaySoundPacketAdvancedPlayWorldGraphicPacketAdvancedPlayWorldGraphicZoneWidePacketAdvancedPlayWorldSoundPacketAdvancedPointPositionPrayingPrintMessageAdvancedPrivateMessageInputPrivateMessagePacketAdvancedPrivateMessageSentPacketAdvancedProjectileProjectileSettingsProjectionDefinitionPropertyDefinitionPublicChatSubmitMessageInputRebuildLoginV2PacketAdvancedRebuildMapRebuildNormalV2PacketAdvancedRebuildRegionV2PacketAdvancedRebuildWorldEntityV4PacketAdvancedRecordCollectionRecordsReadRecordUnrestoredReflectionCheckAdvancedReflectionCheckGetFieldModifiersAdvancedReflectionCheckGetFieldValueAdvancedReflectionCheckGetMethodModifiersAdvancedReflectionCheckInvokeMethodAdvancedReflectionCheckPacketAdvancedReflectionCheckReplyInputReflectionCheckSetFieldValueAdvancedRemoveFriendInputRemoveIgnoreInputRemoveWorldItemSpecificPacketAdvancedRemoveWorldObjectPacketAdvancedRenderPriorityRenderPrioritySourceRenderRangeRequestClanChannelDataInputRequestClanSettingsDataInputResetAnimationsPacketAdvancedResetInteractionModePacketAdvancedResetTradingPostPacketAdvancedResetVarPlayersPacketAdvancedRespawnGroupRespawnsResumedAdvancedResyncInterfacePacketAdvancedRiftPackageAdvancedRiftPluginAdvancedRoleRs7StatusInputRunClientScriptPacketAdvancedRunningSaveNowSceneScenePlaceScenePlacesScriptNameselfSendAbuseReportInputSendPingPacketAdvancedsequenceSequenceAdvancedSequenceBuilderAdvancedSequenceBuilderStepBuilderAdvancedSequencesAdvancedSequenceSpecAdvancedSequenceStepAdvancedServerScriptRunServerScriptsServerTablesAdvancedServerTickEndPacketAdvancedSessionCapSetAccountFlagsPacketAdvancedSetActiveWorldPacketAdvancedSetCameraModePacketAdvancedSetCameraTargetPacketAdvancedSetChatFiltersInputSetChatFiltersPacketAdvancedSetClanVarPacketAdvancedSetFriendChatRankInputSetHeatmapEnabledPacketAdvancedSetHintArrowPacketAdvancedSetInteractionModePacketAdvancedSetInterfaceActiveNpcHeadPacketAdvancedSetInterfaceAnglePacketAdvancedSetInterfaceAnimationPacketAdvancedSetInterfaceColourPacketAdvancedSetInterfaceEventsPacketAdvancedSetInterfaceHiddenPacketAdvancedSetInterfaceModelPacketAdvancedSetInterfaceNpcHeadPacketAdvancedSetInterfaceObjectPacketAdvancedSetInterfacePlayerHeadPacketAdvancedSetInterfacePlayerModelBodyTypePacketAdvancedSetInterfacePlayerModelColourPacketAdvancedSetInterfacePlayerModelItemPacketAdvancedSetInterfacePlayerModelSelfPacketAdvancedSetInterfacePositionPacketAdvancedSetInterfaceRotateSpeedPacketAdvancedSetInterfaceScrollPositionPacketAdvancedSetInterfaceTextPacketAdvancedSetMapFlagPacketAdvancedSetNpcOverheadIconPacketAdvancedSetNpcUpdateOriginPacketAdvancedSetPlayerOptionPacketAdvancedSetPrivateChatFilterPacketAdvancedSetRebootTimerPacketAdvancedSetSiteSettingsPacketAdvancedSetWorldEntityDirectionInputSetWorldItemCountSpecificPacketAdvancedSetWorldItemOptionsPacketAdvancedSetZBufferPacketAdvancedShapedCodecAdvancedShardShardedSceneShardSpaceShieldBarSkillSkulledSlotContentSoundEffectDefinitionSoundsAdvancedSpaceCopySpacesSpaceSelectionSpaceZoneSpeakingSpeedStateAdvancedStateCatalogAdvancedStateKeyAdvancedStatSlotsStepStepDirectionStepTypeStockMarketSlotUpdateAdvancedStockMarketSlotUpdateResetAdvancedStockMarketSlotUpdateSetAdvancedStopInventoryTransmitPacketAdvancedStopMusicPacketAdvancedStructDefinitionSwapMusicPacketAdvancedSyncedSyncedAdvancedSyncedBitsAdvancedSyncVarPlayersPacketAdvancedSystemAdvancedTagDefinitionTeleportInputTickAdvancedTile3Tile4TileClickInputToggleMinimapPacketAdvancedToplevelToplevelsTradingPostOfferAdvancedTransferWorldPacketAdvancedTransientAdvancedTransitionAdvancedTransitionAfterAdvancedTransitionManualAdvancedTransitionOnAdvancedTransmogrificationTransparencyTriggerOnDialogAbortPacketAdvancedTs2ComponentTs2InterfacesTs2ScriptsTs2WireIdsUINameUncustomiseWorldItemPacketAdvancedUnknownStringPacketAdvancedUpdateClientUidPacketAdvancedUpdateFriendListPacketAdvancedUpdateIgnoreListPacketAdvancedUpdateInventoryFullPacketAdvancedUpdateInventoryPartialPacketAdvancedUpdatePlayerModelInputUpdateRunEnergyPacketAdvancedUpdateRunWeightPacketAdvancedUpdateSkillPacketAdvancedUpdateStockMarketSlotPacketAdvancedUpdateTradingPostOffersPacketAdvancedUsageErrorAdvancedUseInterfaceComponentOnInterfaceInputUseInterfaceComponentOnNpcInputUseInterfaceComponentOnPlayerInputUseInterfaceComponentOnWorldEntityInputUseInterfaceComponentOnWorldItemInputUseInterfaceComponentOnWorldObjectInputUserInterfaceValueTypeAdvancedVarbitDefinitionVarClanDataAdvancedVarClanDataIntDataAdvancedVarClanDataLongDataAdvancedVarClanDataStringDataAdvancedVarDefinitionVarPlayerLargePacketAdvancedVarPlayerSmallPacketAdvancedViewportVisibilityPredicateVisibleToVisibleWhenWalkRequestWindowStatusInputWorldWorldAreaWorldCoordinateInputWorldEntityInfoPacketAdvancedWorldEntityOption1InputWorldEntityOption2InputWorldEntityOption3InputWorldEntityOption4InputWorldEntityOption5InputWorldEntityOption6InputWorldGraphicWorldGraphicSettingsWorldItemWorldItemOption1InputWorldItemOption2InputWorldItemOption3InputWorldItemOption4InputWorldItemOption5InputWorldItemOption6InputWorldItemSettingsWorldMapClickInputWorldObjectWorldObjectDefinitionWorldObjectOption1InputWorldObjectOption2InputWorldObjectOption3InputWorldObjectOption4InputWorldObjectOption5InputWorldObjectOption6InputWorldObjectResetWorldObjectsAdvancedWorldObjectSettingsWorldObjectShapeWorldProjectionWorldProjectionPilotWorldProjectionSettingsWorldRecordsWorldSoundWorldSoundSettingsWorldSpatialIndexXpCurveZoneFullUpdatePacketAdvancedZonePartialEnclosedUpdatePacketAdvancedZonePartialFollowsUpdatePacketAdvancedZoomLimits