import Interface from 'WTF-Adventure/WTF-Adventure/client/controllers/interface.js'

public class | source

Interface

Handles game UI interfaces

Constructor Summary

Public Constructor
public	constructor(game: Game) Default constructor

Member Summary

Public Members
public	actions: Actions A reference to player click interactions
public	bank: Bank A reference to player's bank
public	confirm: DOMElement Jquery DOM reference to the confirm box
public	done: DOMElement Jquery DOM reference to the notifcations done button
public	enchant: Enchant A reference to the player's magic
public	fade: DOMElement Jquery DOM reference to the notifcations fading out
public	game: Game An instance of the game
public	inventory: Inventory A reference to the inventory class
public	message: DOMElement Jquery DOM reference to the message box
public	notify: DOMElement Jquery DOM reference to the notifcations box
public	profile: Profile A reference to the player's profile class
public	warp: Warp A reference to warp map

Method Summary

Public Methods
public	displayConfirm(message: [type]) Display the confirmation box
public	displayNotify(message: String) Display a notification if not already visible
public	getQuestPage(): Quest Return a reference to the profile quests
public	hideAll() Hides all interface menus
public	hideConfirm() Hide the confirmation window
public	hideNotify() Hide the notifications window
public	isConfirmVisible(): Boolean Check if the confirmation box is visible
public	isNotifyVisible(): Boolean Checks to see if the notifications window is visible or not
public	loadActions() Load the player's click actions
public	loadBank(size: Number, data: Object) Similar structure as the inventory, just that it has two containers.
public	loadEnchant() Load the player's magic enchantments
public	loadInventory(size: Number, data: Object) This can be called multiple times and can be used to completely refresh the inventory.
public	loadNotifications() Load the player's current notifications
public	loadProfile() Load the player's profile
public	loadWarp() Load warp map
public	resize() Handles resizing the interface elements by calling each UI element's unique resize functionality

Public Constructors

public constructor(game: Game) source

Default constructor

Params:

Name	Type	Attribute	Description
game	Game		instance of the game

Public Members

public actions: Actions source

A reference to player click interactions

public bank: Bank source

A reference to player's bank

public confirm: DOMElement source

Jquery DOM reference to the confirm box

public done: DOMElement source

Jquery DOM reference to the notifcations done button

public enchant: Enchant source

A reference to the player's magic

public fade: DOMElement source

Jquery DOM reference to the notifcations fading out

public game: Game source

An instance of the game

public inventory: Inventory source

A reference to the inventory class

public message: DOMElement source

Jquery DOM reference to the message box

public notify: DOMElement source

Jquery DOM reference to the notifcations box

public profile: Profile source

A reference to the player's profile class

public warp: Warp source

A reference to warp map

Public Methods

public displayConfirm(message: [type]) source

Display the confirmation box

Params:

Name	Type	Attribute	Description
message	[type]		The confirmation message

public displayNotify(message: String) source

Display a notification if not already visible

Params:

Name	Type	Attribute	Description
message	String		the message to display

public getQuestPage(): Quest source

Return a reference to the profile quests

Return:

Quest

The quests for this player

public hideAll() source

Hides all interface menus

public hideConfirm() source

Hide the confirmation window

public hideNotify() source

Hide the notifications window

public isConfirmVisible(): Boolean source

Check if the confirmation box is visible

Return:

Boolean

the status of the confirmation window

public isNotifyVisible(): Boolean source

Checks to see if the notifications window is visible or not

Return:

Boolean

the status of the notifications window

public loadActions() source

Load the player's click actions

public loadBank(size: Number, data: Object) source

Similar structure as the inventory, just that it has two containers. The bank and the inventory.

Params:

Name	Type	Attribute	Description
size	Number		how large the inventory is
data	Object		the player's bank information

public loadEnchant() source

Load the player's magic enchantments

public loadInventory(size: Number, data: Object) source

This can be called multiple times and can be used to completely refresh the inventory.

Params:

Name	Type	Attribute	Description
size	Number		how large the inventory is
data	Object		the player's inventory items from the server

public loadNotifications() source

Load the player's current notifications

public loadProfile() source

Load the player's profile

public loadWarp() source

Load warp map

public resize() source

Handles resizing the interface elements by calling each UI element's unique resize functionality