Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientConfig

ClientConfig is config file for whole client part of application. It is a better to not mix with server config staff. All data is defined like default private property values. Use mmethod class to get proper. Class don't have any args passed.

Hierarchy

  • ClientConfig

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Properties

Private addson

addson: Addson = [{name: "cache",enabled: false,scriptPath: "externals/cacheInit.ts",},{name: "hackerTimer",enabled: true,scriptPath: "externals/hack-timer.js",},{name: "dragging",enabled: true,scriptPath: "externals/drag.ts",},{name: "adapter",enabled: true,scriptPath: "externals/adapter.js",},{name: "facebook",enabled: false,scriptPath: "externals/fb.js",},]

Addson - Role is : "no dependencies scripts only" All addson are ansync loaded scripts.

  • hackerTimer is for better performace also based on webWorkers. Load this script on top.
  • Cache is based on webWorkers.
  • dragging is script for dragging dom elements taken from stackoverflow.com.
  • facebook addson is simple fb api implementation.
  • adapter is powerfull media/communication fixer(Objective : working on all moder browsers).

Private appUseAccountsSystem

appUseAccountsSystem: boolean = true

appUseAccountsSystem If you don't want to use session in your application just setup this variable to the false.

Private appUseBroadcaster

appUseBroadcaster: boolean = true

appUseBroadcaster Disable or enable broadcaster for video chats.

Private appUseNetwork

appUseNetwork: boolean = true

Important note for this property: if you disable (false) you cant use Account system or any other network. Use 'false' if you wanna make single player game. In other way keep it 'true'.

Private aspectRatio

aspectRatio: number = 1.333

aspectRatio default value, can be changed in run time. This is 800x600, 1.78 is also good fit for lot of desktop monitors screens

Private autoStartGamePlay

autoStartGamePlay: boolean = false

Private broadcastAutoConnect

broadcastAutoConnect: boolean = false

broadcaster socket.io address. Change it for production regime

Private broadcasterPort

broadcasterPort: number = 9001

broadcasterPort Port used to connect multimedia server MultiRTC3. I will use it for explicit video chat multiplatform support. Default value is 9001

Private connectorPort

connectorPort: number = 1234

connectorPort is access port used to connect session web socket.

Private defaultGamePlayLevelName

defaultGamePlayLevelName: string = "public"

Implement default gamePlay variable's

Private domain

domain: string = "maximumroulette.com"

domain is simple url address, recommendent to use for local propose LAN ip like : 192.168.0.XXX if you wanna run ant test app with server.

Private drawReference

drawReference: string = "frame"

This is main coordinary types of positions Can be "diametric-fullscreen" or "frame".

  • diametric-fullscreen is simple fullscreen canvas element.
  • frame keeps aspect ratio in any aspect.

drawReference

string

Private gameList

gameList: any[]

Private masterServerKey

masterServerKey: string = "maximumroulette.server1"

masterServerKey is channel access id used to connect multimedia server channel.Both multiRTC2/3

Private networkDeepLogs

networkDeepLogs: boolean = false

networkDeepLogs control of dev logs for webRTC context only.

Private rtcServerPort

rtcServerPort: number = 12034

rtcServerPort Port used to connect multimedia server. Default value is 12034

Private runBroadcasterOnInt

runBroadcasterOnInt: boolean = true

runBroadcasterOnInt load broadcaster

Private showBroadcasterOnInt

showBroadcasterOnInt: boolean = true

Private startUpHtmlForm

startUpHtmlForm: string = "register"

Possible variant by default : "register", "login"

Private stunList

stunList: string[] = ["stun:stun.l.google.com:19302","stun:stun1.l.google.com:19302","stun:stun.l.google.com:19302?transport=udp",]

Methods

didAppUseAccountsSystem

  • didAppUseAccountsSystem(): boolean

didAppUseBroadcast

  • didAppUseBroadcast(): boolean

didAppUseNetwork

  • didAppUseNetwork(): boolean

getAddson

getAspectRatio

  • getAspectRatio(): number

getAutoStartGamePlay

  • getAutoStartGamePlay(): boolean

getBroadcastAutoConnect

  • getBroadcastAutoConnect(): boolean

getBroadcastSockRoute

  • getBroadcastSockRoute(): string

getBroadcasterPort

  • getBroadcasterPort(): number

getBroadcasterSessionDefaults

getConnectorPort

  • getConnectorPort(): number

getDefaultGamePlayLevelName

  • getDefaultGamePlayLevelName(): string

getDomain

  • getDomain(): string

getDrawRefference

  • getDrawRefference(): string

getGamesList

  • getGamesList(): any[]

getMasterServerKey

  • getMasterServerKey(): string

getNetworkDeepLog

  • getNetworkDeepLog(): boolean

getProtocolFromAddressBar

  • getProtocolFromAddressBar(): string

getRemoteServerAddress

  • getRemoteServerAddress(): string

getRemoteServerAddressControlller

  • getRemoteServerAddressControlller(): string

getRunBroadcasterOnInt

  • getRunBroadcasterOnInt(): boolean

getShowBroadcasterOnInt

  • getShowBroadcasterOnInt(): boolean

getStartUpHtmlForm

  • getStartUpHtmlForm(): string

getStunList

  • getStunList(): string[]

getcontrols

  • getcontrols(): any

setAspectRatio

  • setAspectRatio(newAspectRatio: number): void

setNetworkDeepLog

  • setNetworkDeepLog(newState: boolean): void

Object literals

Private broadcasterSessionDefaults

broadcasterSessionDefaults: object

broadcaster rtc session init values. Change it for production regime

enableFileSharing

enableFileSharing: true = true

sessionAudio

sessionAudio: true = true

sessionData

sessionData: true = true

sessionVideo

sessionVideo: true = true

Private controls

controls: object

enableMobileControlsOnDesktop

enableMobileControlsOnDesktop: boolean = true

platformerPlayerController

platformerPlayerController: boolean = true

Generated using TypeDoc