HUD | CoSpaces API

Controls UI elements used while a Scene is played.

Index

Interfaces

CaptionsOptions

Variables

Functions

Variables

VRBackButtonVisible

VRBackButtonVisible: boolean

Toggles visibility of the VR menu / VR back button.

By default this button is enabled during VR mode.

sceneNavigationVisible

sceneNavigationVisible: boolean

Toggles visibility of the Scene navigation at the bottom of the screen.

Functions

showChoicePanel

showChoicePanel(options: { answer1: string; answer2: string; answer3?: string; answer4?: string; answer5?: string; answer6?: string; question: string; onAnswer?: any }): Disposable

- Defined in api.ts:3156
Displays a panel with one question and up to four answers_.
At least two answers must be defined.

Example
```
GUI.HUD.showChoicePanel({
    question: 'This is your question.',
    answer1: 'First answer.',
    answer2: 'Second answer.',
    onAnswer: answerIndex => {
        Debug.log(`Answer ${answerIndex} selected!`)
    }
})
```
Parameters
- options: { answer1: string; answer2: string; answer3?: string; answer4?: string; answer5?: string; answer6?: string; question: string; onAnswer?: any }
  - Readonly answer1: string
  - Readonly answer2: string
  - Optional Readonly answer3?: string
  - Optional Readonly answer4?: string
  - Optional Readonly answer5?: string
  - Optional Readonly answer6?: string
  - Readonly question: string
  - onAnswer?:function
    - onAnswer(t: number): void
    - Defined in api.ts:3171
      Parameters
      - t: number
      Returns void
Returns Disposable

showInfoPanel

showInfoPanel(options: { image?: string; text: string; title: string; onHide?: any }): Disposable

- Defined in api.ts:3087
Displays a panel with title text, body text and an image via id.
text and title must be defined.

Example
```
GUI.HUD.showInfoPanel({
    title: 'This is the title',
    image: 'yourImageID',
    text: 'This is the body text.',
    onHide: () => Debug.log('Panel closed.'),
})
```
Parameters
- options: { image?: string; text: string; title: string; onHide?: any }
  
  panel options
  - Optional Readonly image?: string
  - Readonly text: string
  - Readonly title: string
  - onHide?:function
    - onHide(): void
    - Defined in api.ts:3094
      Returns void
Returns Disposable
created panel.

showQuizPanel

showQuizPanel(options: { answer1: string; answer2: string; answer3?: string; answer4?: string; answer5?: string; answer6?: string; correctAnswer: number; question: string; onCorrect?: any; onWrong?: any }): Disposable

- Defined in api.ts:3116
Displays a panel with one question and up to four answers, one of which is correct. At least two answers and the correct answer must be defined.
Example
```
GUI.HUD.showQuizPanel({
    question: 'This is your quiz question.',
    answer1: 'Correct answer.',
    answer2: 'Wrong answer.',
    correctAnswer: 1,
    onCorrect: () => Debug.log('Correct answer selected.'),
    onWrong: () => Debug.log('Wrong answer selected.')
})
```
Parameters
- options: { answer1: string; answer2: string; answer3?: string; answer4?: string; answer5?: string; answer6?: string; correctAnswer: number; question: string; onCorrect?: any; onWrong?: any }
  
  panel options.
  - Readonly answer1: string
  - Readonly answer2: string
  - Optional Readonly answer3?: string
  - Optional Readonly answer4?: string
  - Optional Readonly answer5?: string
  - Optional Readonly answer6?: string
  - Readonly correctAnswer: number
  - Readonly question: string
  - onCorrect?:function
    - onCorrect(): void
    - Defined in api.ts:3133
      Returns void
  - onWrong?:function
    - onWrong(): void
    - Defined in api.ts:3135
      Returns void
Returns Disposable

showYoutubeVideo

showYoutubeVideo(video: string, onClose: (() => void)): void

- Defined in api.ts:3193
Displays a dialog that plays an embedded YouTube video.

Parameters
- video: string
  
  YouTube video URL
- onClose: (() => void)
  - - (): void
    - Returns void
Returns void

Index

Interfaces

Variables

Functions

Variables

VRBackButtonVisible

sceneNavigationVisible

Functions

showChoicePanel

Parameters

options: { answer1: string; answer2: string; answer3?: string; answer4?: string; answer5?: string; answer6?: string; question: string; onAnswer?: any }

Readonly answer1: string

Readonly answer2: string

Optional Readonly answer3?: string

Optional Readonly answer4?: string

Optional Readonly answer5?: string

Optional Readonly answer6?: string

Readonly question: string

onAnswer?:function

Parameters

t: number

Returns void

Returns Disposable

showInfoPanel

Parameters

options: { image?: string; text: string; title: string; onHide?: any }

Optional Readonly image?: string

Readonly text: string

Readonly title: string

onHide?:function

Returns void

Returns Disposable

showQuizPanel

Parameters

options: { answer1: string; answer2: string; answer3?: string; answer4?: string; answer5?: string; answer6?: string; correctAnswer: number; question: string; onCorrect?: any; onWrong?: any }

Readonly answer1: string

Readonly answer2: string

Optional Readonly answer3?: string

Optional Readonly answer4?: string

Optional Readonly answer5?: string

Optional Readonly answer6?: string

Readonly correctAnswer: number

Readonly question: string

onCorrect?:function

Returns void

onWrong?:function

Returns void

Returns Disposable

showYoutubeVideo

Parameters

video: string

onClose: (() => void)

Returns void

Returns void