JSDoc: Class: chatBox

Constructor

new chatBox(client)

Instantiates a new Chat Box object

Parameters:

Name	Type	Description
`client`	channel	Parent client Management Object

Source:

chat.js, line 20

Members

adminIcon

Admin Panel Icon

Source:

chat.js, line 115

aspectLock

Whether or not chat-size should be locked to current media aspect ratio

Source:

chat.js, line 34

aspectLockIcon

Aspect Lock Icon Seems weird to stick this in here, but the split is dictated by chat width :P

Source:

chat.js, line 131

autoScroll

Whether or not the chat box should auto-scroll on new chat

Source:

chat.js, line 39

autocompleteDisplay

Auto-Complete Display

Source:

chat.js, line 105

autocompletePlaceholder

Auto-Complete Placeholder

Source:

chat.js, line 100

chatBuffer

Chat Buffer Div

Source:

chat.js, line 90

chatPanel

Chat Panel Container Div

Source:

chat.js, line 75

chatPostprocessor

Chat Post-Processor Object

Source:

chat.js, line 69

chatPrompt

Chat Prompt

Source:

chat.js, line 95

clickDragger

Click-Dragger Object for handling dynamic chat/video split re-sizing

Source:

chat.js, line 59

client

Parent Client Management Object

Source:

chat.js, line 29

commandPreprocessor

Command Pre-Processor Object

Source:

chat.js, line 64

emoteIcon

Emote Icon

Source:

chat.js, line 120

flairSelect

Flair Selector

Source:

chat.js, line 85

hideChatIcon

Hide Chat Icon

Source:

chat.js, line 136

highSelect

High Level Selector

Source:

chat.js, line 80

lastHeight

Height of Chat Buffer on last scroll

Source:

chat.js, line 49

lastPos

Chat Buffer Scroll Top on last scroll

Source:

chat.js, line 44

lastWidth

Width of Chat Buffer on last scroll

Source:

chat.js, line 54

sendButton

Send Chat/Command Button

Source:

chat.js, line 125

settingsIcon

Settings Panel Icon

Source:

chat.js, line 110

showChatIcon

Show Chat Icon

Source:

chat.js, line 141

Methods

catChat(text)

Concatinate Text into Chat Prompt

Parameters:

Name	Type	Description
`text`	String	Text to Concatinate

Source:

chat.js, line 262

checkAutocomplete(input) → {Object}

Checks string input against auto-complete dictionary to generate the best guess as to what the user is typing

Parameters:

Name	Type	Description
`input`	String	Current input from Chat Prompt

Source:

chat.js, line 336

Returns:

Object containing word we where handed and the match we found

Type: Object

clearChat(data)

Clears chat on command from server

Parameters:

Name	Type	Description
`data`	Object	Data from server

Source:

chat.js, line 191

defineListeners()

Defines network-related event listners

Source:

chat.js, line 182

displayAutocomplete(event)

Displays auto-complete text against current prompt input

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 293

displayChat(data)

Receives, Post-Processes, and Displays chat messages from server

Parameters:

Name	Type	Description
`data`	Object	De-hydrated chat object from server

Source:

chat.js, line 210

handleAutoScroll()

Auto-scrolls chat buffer when new chats are entered.

Source:

chat.js, line 614

handleClientInfo(data)

Handles initial client meta-data dump from server upon connection

Parameters:

Name	Type	Description
`data`	Object	Data dump from server

Source:

chat.js, line 388

handleVideoToggle(show)

Handles Video Toggling

Parameters:

Name	Type	Description
`show`	Boolean	Whether or not the video is currently being hidden

Source:

chat.js, line 539

lockAspect(event)

Locks chat-size to aspect ratio of media

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 453

resizeAspect(event)

Re-sizes chat back to aspect ratio on window re-size when chat box is aspect locked Also prevents horizontal scroll-bars from chat/window resizing

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 479

scrollHandler(event)

Handles scrolling within the chat buffer

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 567

send(event)

Pre-processes and sends text from chat prompt to server

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 279

setFlair(event)

Sets user flair

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 407

setHighLevel(event)

Sets user high-level

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 397

setupInput()

Defines input-related event listeners

Source:

chat.js, line 152

sizeToAspect()

Re-sizes chat box relative to media aspect ratio

Source:

chat.js, line 498

tabComplete(event)

Called upon tab-complete

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 308

toggleUI(show)

Toggles Chat Box UX

Parameters:

Name	Type	Description
`show`	Boolean	Whether or not to show Chat Box UX

Source:

chat.js, line 522

tokeWith(user)

Calls a toke command out with a specified user

Parameters:

Name	Type	Description
`user`	String	User to toke with

Source:

chat.js, line 271

unlockAspect(event)

Un-locks chat-size to aspect ratio of media

Parameters:

Name	Type	Description
`event`	Event	Event passed down from Event Handler

Source:

chat.js, line 466

updateFlairSelect(fliarList, fliar)

Handles flair updates from the server

Parameters:

Name	Type	Description
`fliarList`	Array	List of flairs to put into flair select
`fliar`	String	Flair to set

Source:

chat.js, line 426

updateHighSelect(highLevel)

Handles High-Level updates from the server

Parameters:

Name	Type	Description
`highLevel`	Number	High Level to Set

Source:

chat.js, line 417