@advjs/monorepo / @advjs/client / AdvContext

Interface: AdvContext

Defined in: packages/client/types/context.ts:14

start with $ means it's a system functions

Properties

$bgm

$bgm: object

Defined in: packages/client/types/context.ts:26

isMuted

isMuted: Ref<boolean, boolean>

pauseBgm

pauseBgm: (bgmId) => void

Parameters

bgmId

string

Returns

void

pauseBgmBySrc

pauseBgmBySrc: (src) => void

pause bgm by src

Parameters

src

string

Returns

void

playBgm

playBgm: (bgmId) => void

播放指定的背景音乐

Parameters

bgmId

string

Returns

void

playBgmBySrc

playBgmBySrc: (src) => void

play bgm by src

Parameters

src

string

Returns

void

stopBgm

stopBgm: (bgmId) => void

Parameters

bgmId

string

Returns

void

stopBgmBySrc

stopBgmBySrc: (src) => void

stop bgm by src

Parameters

src

string

Returns

void

stopOtherBgmBySrc

stopOtherBgmBySrc: (src) => void

停止之外的所有背景音乐

Parameters

src

string

Returns

void

mute()

mute(): void

mute

Returns

void

play()

play(): void

Returns

void

stop()

stop(): void

stop all bgms

Returns

void

toggleMute()

toggleMute(): void

切换静音状态

Returns

void

unmute()

unmute(): void

解除静音

Returns

void

---

$characters

$characters: object

Defined in: packages/client/types/context.ts:25

get()

get(characterId): AdvCharacter | undefined

Parameters

characterId

string

Returns

AdvCharacter | undefined

---

$logic

$logic: object

Defined in: packages/client/types/context.ts:23

handleAdvNode

handleAdvNode: (node) => Promise<true | undefined>

handle adv node

Parameters

node

Item | AdvFlowNode

Returns

Promise<true | undefined>

handleCode

handleCode: (node) => Promise<true | undefined>

handle code block

Parameters

node

Code

Returns

Promise<true | undefined>

nav

nav: object

nav.go

go: (target) => void

go to scene

Parameters

target

string

Returns

void

nav.next

next: () => Promise<void>

下一部分

Returns

Promise<void>

read

read: (text) => Promise<void>

理解文本

Parameters

text

string

Returns

Promise<void>

loadAst()

loadAst(ast): void

Parameters

ast

Root

Returns

void

---

$nav

$nav: object

Defined in: packages/client/types/context.ts:22

go

go: (target) => Promise<AdvFlowNode | undefined>

go to target node

Parameters

target?

string | AdvFlowNode | { chapterId: string; nodeId: string; }

Returns

Promise<AdvFlowNode | undefined>

loadChapter

loadChapter: (id?) => Promise<{ loaded: boolean; nodesMap: ChapterNodesMap; } | undefined>

load chapter

Parameters

id?

string

Returns

Promise<{ loaded: boolean; nodesMap: ChapterNodesMap; } | undefined>

next

next: () => Promise<AdvFlowNode | undefined>

下一部分

Returns

Promise<AdvFlowNode | undefined>

start

start: (params) => Promise<void>

start

Parameters

params

chapterId?

string

nodeId

string

Returns

Promise<void>

---

$nodes

$nodes: object

Defined in: packages/client/types/context.ts:27

get

get: (params) => AdvFlowNode | undefined

获取节点

Parameters

params

chapterId

string

nodeId

string

Returns

AdvFlowNode | undefined

---

$t

$t: ComposerTranslation<any, string, RemoveIndexSignature<{[key: string]: LocaleMessageValue<VueMessageType>; }>, never, any, any>

Defined in: packages/client/types/context.ts:21

---

$tachies

$tachies: object

Defined in: packages/client/types/context.ts:24

enter

enter: (name, status) => void

enter tachie

Parameters

name

string

status?

string = 'default'

Returns

void

exit

exit: (name) => void

exit tachie

Parameters

name

string

Returns

void

handle

handle: (node) => Promise<boolean>

Parameters

node

Tachie | AdvTachieNode

Returns

Promise<boolean>

update

update: (curNode) => void

Parameters

curNode

Dialog

Returns

void

---

config

config: ComputedRef<AdvConfig<AdvThemeConfig>>

Defined in: packages/client/types/context.ts:16

---

functions

functions: Record<string, () => void>

Defined in: packages/client/types/context.ts:19

---

gameConfig

gameConfig: ComputedRef<AdvGameConfig>

Defined in: packages/client/types/context.ts:17

---

init

init: () => Promise<void>

Defined in: packages/client/types/context.ts:29

Returns

Promise<void>

---

pixiGame?

optional pixiGame?: PixiGame

Defined in: packages/client/types/context.ts:34

---

runtime

runtime: object

Defined in: packages/client/types/context.ts:33

运行时变量

chaptersMap

chaptersMap: ChaptersMap

章节节点映射

charactersMap

charactersMap: Map<string, AdvCharacter>

角色映射

tachiesMapRef

tachiesMapRef: Ref<Map<string, TachieState>>

角色立绘映射

ref for reactivity

---

store

store: Store

Defined in: packages/client/types/context.ts:15

---

themeConfig

themeConfig: ComputedRef<AdvThemeConfig>

Defined in: packages/client/types/context.ts:18