YUi | Ylands Text Scripting

Hierarchy

Index

Constructors

constructor

Methods

Constructors

constructor

new YUi(): YUi

Returns YUi

Methods

Static console

console(message: any): void

Print text to game console (chat).

Parameters
- message: any
Returns void

Static disableCharacterTab

disableCharacterTab(Tab: YUiCharacterTab, disable: boolean): void
disableCharacterTab(player: YCharacter, Tab: YUiCharacterTab, disable: boolean): void

Allows to enable/disable* character tab for all the players.

Parameters
- Tab: YUiCharacterTab
- disable: boolean
Returns void
Allows to enable/disable* character tab for specific player.

Parameters
- player: YCharacter
- Tab: YUiCharacterTab
- disable: boolean
Returns void

Static disableHud

disableHud(HUD: YHudElementType, disable: boolean): void
disableHud(player: YCharacter, HUD: YHudElementType, disable: boolean): void

Allows to enable/disable* HUD component for all the players.

Parameters
- HUD: YHudElementType
- disable: boolean
Returns void
Allows to enable/disable* HUD component for specific player.

Parameters
- player: YCharacter
- HUD: YHudElementType
- disable: boolean
Returns void

Static hideTextAboveEntity

hideTextAboveEntity(entity: YEntity): void

Hides the text displayed above an entity.

Parameters
- entity: YEntity
Returns void

Static showBubble

showBubble(speaker: YEntity, message: string, hideSpeaker: boolean): void
showBubble(speaker: YReferencePoint, message: string, hideSpeaker: boolean): void

Display text bubble above target entity.

Parameters
- speaker: YEntity
- message: string
- hideSpeaker: boolean
Returns void
Displays text bubble above the target entity.

Parameters
- speaker: YReferencePoint
- message: string
- hideSpeaker: boolean
Returns void

Static showNotification

showNotification(player: YCharacter, text: any, notificationType: YNotificationType): void
showNotification(text: any, notificationType: YNotificationType): void

Will show a notification text to a specific player.

Parameters
- player: YCharacter
- text: any
- notificationType: YNotificationType
Returns void
Will show a notification text to all players.

Parameters
- text: any
- notificationType: YNotificationType
Returns void

Static showPermanentTextAboveEntity

showPermanentTextAboveEntity(entity: YEntity, text: string, color: YColor): void

Shows permanent text above an entity.

Parameters
- entity: YEntity
- text: string
- color: YColor
Returns void

Static showTextAboveEntity

showTextAboveEntity(entity: YEntity, text: string, color: YColor, time: number, fadeIn: boolean, fadeOut: boolean, textAnimation: YTextAnimationType, renderOverEverything: boolean, fontSize: YFontSize, customImage: YImage): void
showTextAboveEntity(player: YCharacter, entity: YEntity, text: string, color: YColor, time: number, fadeIn: boolean, fadeOut: boolean, textAnimation: YTextAnimationType, renderOverEverything: boolean, fontSize: YFontSize, customImage: YImage): void

Displays the entered text above the target entity for the given time.

Parameters
- entity: YEntity
- text: string
- color: YColor
- time: number
- fadeIn: boolean
- fadeOut: boolean
- textAnimation: YTextAnimationType
- renderOverEverything: boolean
- fontSize: YFontSize
- customImage: YImage
Returns void
Displays the entered text above the target player's head for the given time.

Parameters
- player: YCharacter
- entity: YEntity
- text: string
- color: YColor
- time: number
- fadeIn: boolean
- fadeOut: boolean
- textAnimation: YTextAnimationType
- renderOverEverything: boolean
- fontSize: YFontSize
- customImage: YImage
Returns void

Static showWarning

showWarning(player: YCharacter, warning: any): void
showWarning(warning: any): void

Will show a warning text to a specific player.

Parameters
- player: YCharacter
- warning: any
Returns void
Will show a warning text to all players.

Parameters
- warning: any
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns YUi

Methods

Static console

Parameters

message: any

Returns void

Static disableCharacterTab

Parameters

Tab: YUiCharacterTab

disable: boolean

Returns void

Parameters

player: YCharacter

Tab: YUiCharacterTab

disable: boolean

Returns void

Static disableHud

Parameters

HUD: YHudElementType

disable: boolean

Returns void

Parameters

player: YCharacter

HUD: YHudElementType

disable: boolean

Returns void

Static hideTextAboveEntity

Parameters

entity: YEntity

Returns void

Static showBubble

Parameters

speaker: YEntity

message: string

hideSpeaker: boolean

Returns void

Parameters

speaker: YReferencePoint

message: string

hideSpeaker: boolean

Returns void

Static showNotification

Parameters

player: YCharacter

text: any

notificationType: YNotificationType

Returns void

Parameters

text: any

notificationType: YNotificationType

Returns void

Static showPermanentTextAboveEntity

Parameters

entity: YEntity

text: string

color: YColor

Returns void

Static showTextAboveEntity

Parameters

entity: YEntity

text: string

color: YColor

time: number

fadeIn: boolean

fadeOut: boolean

textAnimation: YTextAnimationType

renderOverEverything: boolean

fontSize: YFontSize

customImage: YImage

Returns void

Parameters

player: YCharacter

entity: YEntity

text: string