@advjs/monorepo / @advjs/client / AdvContext

Interface: AdvContext

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

start with $ means it's a system functions

Properties

$bgm

$bgm: object

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

isMuted

isMuted: Ref<boolean, boolean>

pauseBgm()

pauseBgm: (bgmId) => void

Parameters

bgmId

string

Returns

void

playBgm()

playBgm: (bgmId) => void

播放指定的背景音乐

Parameters

bgmId

string

Returns

void

stopBgm()

stopBgm: (bgmId) => void

Parameters

bgmId

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

---

$logic

$logic: object

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

handleAdvNode()

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

handle adv node

Parameters

node

Item | AdvFlowNode

Returns

Promise<undefined | true>

handleCode()

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

handle code block

Parameters

node

Code

Returns

Promise<undefined | true>

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:20

go()

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

go to target node

Parameters

target

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

Returns

Promise<undefined | AdvFlowNode>

loadChapter()

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

load chapter

Parameters

id?

string

Returns

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

next()

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

下一部分

Returns

Promise<undefined | AdvFlowNode>

start()

start: (params) => Promise<void>

start

Parameters

params

chapterId?

string

nodeId

string

Returns

Promise<void>

---

$t

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

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

---

$tachies

$tachies: object

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

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:14

---

functions

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

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

---

gameConfig

gameConfig: ComputedRef<AdvGameConfig>

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

---

init()

init: () => Promise<void>

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

Returns

Promise<void>

---

pixiGame?

optional pixiGame: PixiGame

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

---

runtime

runtime: object

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

运行时变量

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:13

---

themeConfig

themeConfig: ComputedRef<AdvThemeConfig>

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