Variable

Static Public Summary
public	App: * App is the entrypoint for both the ios and (in the future) Android versions of the app.
public	DEQUEUE_GAME_MEMO: string Client->Client: Indicates that the user has read the most recent notificaiton.
public	Emoji(x: number, y: number): * This is a basic emoji component.
public	EmojiInput(emojiElements: array): * This is the input box in the EmojiKeyboard component.
public	GAME_MEMO: string Server->Client: conveys a game event to be displayed to the user in the ui and/or as a notification.
public	GameScreenContainer: * GameScreenContainer is a 'container component' which binds the props and actions creators of GameScreen to the store and dispatcher, respectively.
public	HomeScreen(onPress: function()): * onPress additionally triggers navigation to GameScreen
public	HomeScreenContainer: * HomeScreenContainer is a 'container component' which binds the props and actions creators of HomeScreen to the store and dispatcher, respectively.
public	Message(props: Object): * Message is a React functional component.
public	SEND_CLUE_MESSAGE: string Client->Server: sent to server when the dealer wants to broadcast a clue
public	SEND_GUESS_MESSAGE: string Client->Server: sent to server when the client wants to broadcast a guess
public	StatsScreenContainer: * StatsScreenContainer is a 'container component' which binds the props and actions creators of StatsScreen to the store and dispatcher, respectively.
public	UPDATE_GAME_STATE: string Server->Client: integrates `action.payload` into the game part of the store
public	UPDATE_MESSAGE_STATE: string Server->Client: integrates `action.payload` into the message part of the store
public	UPDATE_USER_STATE: string Server->Client: integrates `action.payload` into the user part of the store
public	colors: * The app's color palette is based on this Adobe color theme: https://color.adobe.com/Color-Theme-4-color-theme-8030401/edit/?copy=true It consists of the five colors below: darkBlue, midBlue, lightBlue, caramel, cream To access colors in any other file, import colors object and access individual colors as properties
public	dequeueMemo: * This creates an action which removes a memo from the notifications queue once it has been dismissed by the user.
public	submitClue: * This creates an action for the dealer to submit a clue This action is handeled by the server
public	submitGuess: * Creates an action for submitting a guess to the server This action is handled by the server

Static Public

public App: * source

import App from './app/App.js'

App is the entrypoint for both the ios and (in the future) Android versions of the app. It is rendered only once when the app is loaded and instantiates all of the applicaiton routes, the store and the provider.

public DEQUEUE_GAME_MEMO: string source

import {DEQUEUE_GAME_MEMO} from './app/action_types/actionTypes.js'

Client->Client: Indicates that the user has read the most recent notificaiton.

public Emoji(x: number, y: number): * source

import Emoji from './app/components/Emoji.js'

This is a basic emoji component. It renders an image of an emoji based on the spritemap in the 'image!emojis' static resource and the x/y coordinates you provide to the component.

public EmojiInput(emojiElements: array): * source

import EmojiInput from './app/components/EmojiInput.js'

This is the input box in the EmojiKeyboard component. You feed it an array of tuples representing the x/y coordinates of the emojis you want to render in the sprite map and it renders them in a little white box.

public GAME_MEMO: string source

import {GAME_MEMO} from './app/action_types/actionTypes.js'

Server->Client: conveys a game event to be displayed to the user in the ui and/or as a notification.

public GameScreenContainer: * source

import GameScreenContainer from './app/screens/GameScreen.js'

GameScreenContainer is a 'container component' which binds the props and actions creators of GameScreen to the store and dispatcher, respectively. It should be imported in favor of HomeScreen, which is exported only for documentation purposes.

public HomeScreen(onPress: function()): * source

import {HomeScreen} from './app/screens/HomeScreen.js'

onPress additionally triggers navigation to GameScreen

public HomeScreenContainer: * source

import HomeScreenContainer from './app/screens/HomeScreen.js'

HomeScreenContainer is a 'container component' which binds the props and actions creators of HomeScreen to the store and dispatcher, respectively. It should be imported in favor of HomeScreen, which is exported only for documentation purposes.

public Message(props: Object): * source

import Message from './app/components/Message.js'

Message is a React functional component. It renders a single message with useful metadata.

public SEND_CLUE_MESSAGE: string source

import {SEND_CLUE_MESSAGE} from './app/action_types/actionTypes.js'

Client->Server: sent to server when the dealer wants to broadcast a clue

public SEND_GUESS_MESSAGE: string source

import {SEND_GUESS_MESSAGE} from './app/action_types/actionTypes.js'

Client->Server: sent to server when the client wants to broadcast a guess

public StatsScreenContainer: * source

import StatsScreenContainer from './app/screens/StatsScreen.js'

StatsScreenContainer is a 'container component' which binds the props and actions creators of StatsScreen to the store and dispatcher, respectively. It should be imported in favor of HomeScreen, which is exported only for documentation purposes.

public UPDATE_GAME_STATE: string source

import {UPDATE_GAME_STATE} from './app/action_types/actionTypes.js'

Server->Client: integrates action.payload into the game part of the store

public UPDATE_MESSAGE_STATE: string source

import {UPDATE_MESSAGE_STATE} from './app/action_types/actionTypes.js'

Server->Client: integrates action.payload into the message part of the store

public UPDATE_USER_STATE: string source

import {UPDATE_USER_STATE} from './app/action_types/actionTypes.js'

Server->Client: integrates action.payload into the user part of the store

public colors: * source

import {colors} from './app/styles/colors.js'

The app's color palette is based on this Adobe color theme: https://color.adobe.com/Color-Theme-4-color-theme-8030401/edit/?copy=true It consists of the five colors below: darkBlue, midBlue, lightBlue, caramel, cream

To access colors in any other file, import colors object and access individual colors as properties

public dequeueMemo: * source

import {dequeueMemo} from './app/actions/user.js'

This creates an action which removes a memo from the notifications queue once it has been dismissed by the user.

public submitClue: * source

import {submitClue} from './app/actions/user.js'

This creates an action for the dealer to submit a clue This action is handeled by the server

public submitGuess: * source

import {submitGuess} from './app/actions/user.js'

Creates an action for submitting a guess to the server This action is handled by the server