Skip to main content

@recative/definitions

Index

Classes

Enumerations

Functions

Interfaces

Type Aliases

Variables

Type Aliases

AssetSearchResult

AssetSearchResult: (IActPoint | IResourceItem) & { contentExtensionId: string }

ContentSpec

ContentSpec<T>: { contentExtensionId: string; extensionConfigurations: Record<string, string> } & T

Type parameters

  • T: {} = Record<string, unknown>

GoToEpisode

GoToEpisode: (seek: (assetOrder: number, assetTime: number) => void, episode: string, forceReload?: boolean, assetOrder?: number, assetTime?: number) => void

Type declaration

    • (seek: (assetOrder: number, assetTime: number) => void, episode: string, forceReload?: boolean, assetOrder?: number, assetTime?: number): void
    • Parameters

      • seek: (assetOrder: number, assetTime: number) => void
      • episode: string
      • optionalforceReload: boolean
      • optionalassetOrder: number
      • optionalassetTime: number

      Returns void

IDetailedResourceGroupForClient

IDetailedResourceGroupForClient: Omit<IResourceGroupForClient, files> & { files: IResourceFileForClient[] }

IDetailedResourceItemForClient

IResourceFileForClient

IResourceFileForClient: Pick<IResourceFile, ResourceFileKeysForClient>

IResourceGroupForClient

IResourceGroupForClient: Pick<IResourceGroup, ResourceGroupKeysForClient>

IResourceItem

IResourceItem: IResourceFile | IResourceGroup

IResourceItemForClient

ManagedCoreStateTriggerEvent

ManagedCoreStateTriggerEvent: CustomEvent<ManagedCoreStateTriggerEventDetail>

ManagerCoreStateTrigger

Type parameters

  • T = unknown

RawGoToEpisode

RawGoToEpisode: (seek: (assetOrder: number, assetTime: number) => void, episode: string, forceReload?: boolean, assetOrder?: number, assetTime?: number) => void

Type declaration

    • (seek: (assetOrder: number, assetTime: number) => void, episode: string, forceReload?: boolean, assetOrder?: number, assetTime?: number): void
    • Parameters

      • seek: (assetOrder: number, assetTime: number) => void
      • episode: string
      • optionalforceReload: boolean
      • optionalassetOrder: number
      • optionalassetTime: number

      Returns void

ResourceFileKeysForClient

ResourceFileKeysForClient: typeof RESOURCE_FILE_KEYS_FOR_CLIENT[number]

ResourceGroupKeysForClient

ResourceGroupKeysForClient: typeof RESOURCE_GROUP_KEYS_FOR_CLIENT[number]

UserImplementedFunctions

UserImplementedFunctions: Omit<RawUserImplementedFunctions, gotoEpisode> & { gotoEpisode: GoToEpisode }

Variables

constACT_POINT_CONTENT_EXTENSION_ID

ACT_POINT_CONTENT_EXTENSION_ID: @recative/content-extension-act-point = '@recative/content-extension-act-point'

constBGM_CORE_STATE_EXTENSION_ID

BGM_CORE_STATE_EXTENSION_ID: @recative/managed-core-state-extension-bgm = '@recative/managed-core-state-extension-bgm'

constColor

Color: { accent: accent; black: black; blue: blue; brown: brown; custom: custom; green: green; negative: negative; neutral: neutral; orange: orange; positive: positive; primary: primary; purple: purple; red: red; warning: warning; yellow: yellow } = ...

Type declaration

  • accent: accent
  • black: black
  • blue: blue
  • brown: brown
  • custom: custom
  • green: green
  • negative: negative
  • neutral: neutral
  • orange: orange
  • positive: positive
  • primary: primary
  • purple: purple
  • red: red
  • warning: warning
  • yellow: yellow

constMANAGED_RESOURCE_FILE_KEYS

MANAGED_RESOURCE_FILE_KEYS: Readonly<keyof IResourceFile[]> = ...

constPAUSE_CORE_STATE_EXTENSION_ID

PAUSE_CORE_STATE_EXTENSION_ID: @recative/managed-core-state-extension-pause = '@recative/managed-core-state-extension-pause'

constREDIRECT_URL_EXTENSION_ID

REDIRECT_URL_EXTENSION_ID: @recative/redirect = '@recative/redirect'

constRESOURCE_FILE_KEYS_FOR_CLIENT

RESOURCE_FILE_KEYS_FOR_CLIENT: Readonly<keyof IResourceFile[]> = ...

constRESOURCE_GROUP_KEYS_FOR_CLIENT

RESOURCE_GROUP_KEYS_FOR_CLIENT: Readonly<keyof Partial<IResourceGroup>[]> = ...

constSUBTITLE_MANAGED_CORE_STATE_EXTENSION_ID

SUBTITLE_MANAGED_CORE_STATE_EXTENSION_ID: @recative/managed-core-state-extension-subtitle = '@recative/managed-core-state-extension-subtitle'

constVIDEO_CONTENT_EXTENSION_ID

VIDEO_CONTENT_EXTENSION_ID: @recative/content-extension-video = '@recative/content-extension-video'

constallTags

allTags: (IResourceTag | IGroupTypeResourceTag)[] = ...

constapBundleCategoryTag

apBundleCategoryTag: ICategoryResourceTag = ...

constappClientResourceTag

appClientResourceTag: IClientTypeResourceTag = ...

constaudioCategoryTag

audioCategoryTag: ICategoryResourceTag = ...

constaudioRoleResourceTag

audioRoleResourceTag: IRoleResourceTag = ...

constblinkEngineResourceTag

blinkEngineResourceTag: IEngineResourceTag = ...

constcategoryTags

categoryTags: ICategoryResourceTag[] = ...

constclientResourceTags

clientResourceTags: IClientTypeResourceTag[] = ...

constdesktopClientResourceTag

desktopClientResourceTag: IClientTypeResourceTag = ...

constdeviceTypeResourceTags

deviceTypeResourceTags: IDeviceTypeResourceTag[] = ...

constemptyResourceTag

emptyResourceTag: IMetaStatusResourceTag = ...

constenResourceTag

enResourceTag: ILanguageResourceTag = ...

constengineResourceTags

engineResourceTags: IEngineResourceTag[] = ...

constflowEngineResourceTag

flowEngineResourceTag: IEngineResourceTag = ...

constframeSequenceGroupResourceTag

frameSequenceGroupResourceTag: IGroupTypeResourceTag = ...

constgeckoEngineResourceTag

geckoEngineResourceTag: IEngineResourceTag = ...

constgeneralGroupResourceTag

generalGroupResourceTag: IGroupTypeResourceTag = ...

constgoannaEngineResourceTag

goannaEngineResourceTag: IEngineResourceTag = ...

constgroupTags

groupTags: IGroupTypeResourceTag[] = ...

constimageCategoryTag

imageCategoryTag: ICategoryResourceTag = ...

constlabelColorMap

labelColorMap: Record<LabelType, typeof Color[keyof typeof Color]> = ...

constlanguageResourceTags

languageResourceTags: ILanguageResourceTag[] = ...

constlargeScreenResourceTag

largeScreenResourceTag: IScreenSizeResourceTag = ...

constmediumScreenResourceTag

mediumScreenResourceTag: IScreenSizeResourceTag = ...

constmetaStatusResourceTags

metaStatusResourceTags: IMetaStatusResourceTag[] = ...

constminiActPointResourceTag

miniActPointResourceTag: IClientTypeResourceTag = ...

constmouseResourceTag

mouseResourceTag: IDeviceTypeResourceTag = ...

constothersCategoryTag

othersCategoryTag: ICategoryResourceTag = ...

constothersEngineResourceTag

othersEngineResourceTag: IEngineResourceTag = ...

constpreloadPriorityLevelMap

preloadPriorityLevelMap: BidirectionalMap<PreloadLevel, number> = ...

Smaller means higher priority

constroleResourceTags

roleResourceTags: IRoleResourceTag[] = ...

constscreenSizeResourceTags

screenSizeResourceTags: IScreenSizeResourceTag[] = ...

constserenityEngineResourceTag

serenityEngineResourceTag: IEngineResourceTag = ...

constsmallScreenResourceTag

smallScreenResourceTag: IScreenSizeResourceTag = ...

constsubtitleCategoryTag

subtitleCategoryTag: ICategoryResourceTag = ...

constsubtitleResourceTag

subtitleResourceTag: IRoleResourceTag = ...

consttagIdMap

tagIdMap: Record<string, IResourceTag | IGroupTypeResourceTag> = {}

consttagsByType

tagsByType: Record<LabelType, IResourceTag[]> = ...

consttextureGroupResourceTag

textureGroupResourceTag: IGroupTypeResourceTag = ...

consttouchScreenResourceTag

touchScreenResourceTag: IDeviceTypeResourceTag = ...

consttriggersCategoryTag

triggersCategoryTag: ICategoryResourceTag = ...

consttypeNameMap

typeNameMap: Record<LabelType, string> = ...

constvideoCategoryTag

videoCategoryTag: ICategoryResourceTag = ...

constvideoGroupResourceTag

videoGroupResourceTag: IGroupTypeResourceTag = ...

constvideoRoleResourceTag

videoRoleResourceTag: IRoleResourceTag = ...

constwebClientResourceTag

webClientResourceTag: IClientTypeResourceTag = ...

constwebkitEngineResourceTag

webkitEngineResourceTag: IEngineResourceTag = ...

constzhHansResourceTag

zhHansResourceTag: ILanguageResourceTag = ...

constzhHantResourceTag

zhHantResourceTag: ILanguageResourceTag = ...