Class SpectrumCommunity

SpectrumCommunity

Helper class for a Spectrum Community (currently Star Citizen or Org)

class: SpectrumCommunity

Hierarchy

SpectrumCommunity

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SpectrumCommunity(co: Community): SpectrumCommunity

- Defined in Spectrum/components/community.component.ts:20
Parameters
- co: Community
  
  the community object sent by RSI
Returns SpectrumCommunity

Properties

Protected _community

_community: Community

the community rsi api object

Protected _lobbies

_lobbies: SpectrumLobby[] = []

an array of lobbies the bot can see in this community

Methods

getLobbies

getLobbies(): SpectrumLobby[]

- Defined in Spectrum/components/community.component.ts:36
Public getter for Lobbies in the Community

Returns SpectrumLobby[]

array of Lobbies the bot can see in this community

getLobbyById

getLobbyById(id: number): SpectrumLobby

- Defined in Spectrum/components/community.component.ts:40
Parameters
- id: number
Returns SpectrumLobby

getLobbyByName

getLobbyByName(name: string): SpectrumLobby

- Defined in Spectrum/components/community.component.ts:49
Parameters
- name: string
Returns SpectrumLobby

getRaw

getRaw(): Community

- Defined in Spectrum/components/community.component.ts:64
Getter function for _community

Returns Community

the community object in RSI api format

Generated using TypeDoc