Class Team

Represent a team

Hierarchy

Team

Index

Constructors

constructor

new Team(name: string, options?: teamOptions): Team
Parameters
- name: string
  
  The name of the team
- Optional options: teamOptions
Returns Team
- Defined in src/src/tools/team.ts:39

Properties

edit

edit: { collisions: ((type: extraTeamChoice) => string); color: ((color: mcDefaultColors) => string); deathMessage: ((hideFor: extraTeamChoice) => string); display: ((content: JsonRaw) => string); friendlyFire: ((active: boolean) => string); invisibleFriends: ((hidden: boolean) => string); nametag: ((hideFor: extraTeamChoice) => string); prefix: ((content: JsonRaw) => string); suffix: ((content: JsonRaw) => string); update: (() => string[]) } = ...

Manage the team attributes

Type declaration

collisions: ((type: extraTeamChoice) => string)
- - (type: extraTeamChoice): string
  - Set the new team's collision rule
    Parameters
    - type: extraTeamChoice
    Returns string
color: ((color: mcDefaultColors) => string)
- - (color: mcDefaultColors): string
  - Set the new team's color
    Parameters
    - color: mcDefaultColors
    Returns string
deathMessage: ((hideFor: extraTeamChoice) => string)
- - (hideFor: extraTeamChoice): string
  - Set if member of this team show a message after they die
    Parameters
    - hideFor: extraTeamChoice
    Returns string
display: ((content: JsonRaw) => string)
- - (content: JsonRaw): string
  - Set the new team's display name
    Parameters
    - content: JsonRaw
    Returns string
friendlyFire: ((active: boolean) => string)
- - (active: boolean): string
  - Set if PvP is activated inside the team
    Parameters
    - active: boolean
    Returns string
invisibleFriends: ((hidden: boolean) => string)
- - (hidden: boolean): string
  - Set if invisible member can be saw by the other team member
    Parameters
    - hidden: boolean
    Returns string
nametag: ((hideFor: extraTeamChoice) => string)
- - (hideFor: extraTeamChoice): string
  - Set the new team's nametag visibility rule
    Parameters
    - hideFor: extraTeamChoice
    Returns string
prefix: ((content: JsonRaw) => string)
- - (content: JsonRaw): string
  - Set the new team member's prefix
    Parameters
    - content: JsonRaw
    Returns string
suffix: ((content: JsonRaw) => string)
- - (content: JsonRaw): string
  - Set the new team member's suffix
    Parameters
    - content: JsonRaw
    Returns string
update: (() => string[])
- - (): string[]
  - update all the team attribute in one time
    
    Returns string[]

members

members: { add: ((entity?: Entity, force?: boolean) => string | (string | string[])[]); clear: (() => string); remove: ((entity: Entity, force: boolean) => string | string[]) } = ...

Manage the team member

Type declaration

add: ((entity?: Entity, force?: boolean) => string | (string | string[])[])
- - (entity?: Entity, force?: boolean): string | (string | string[])[]
  - Add a member to the team
    Parameters
    - Optional entity: Entity
      
      The entity to add to the team
    - Optional force: boolean
      
      If is set to false the command will do nothing if the entity is already in an other team
    Returns string | (string | string[])[]
clear: (() => string)
- - (): string
  - Remove all the team member
    
    Returns string
remove: ((entity: Entity, force: boolean) => string | string[])
- - (entity: Entity, force: boolean): string | string[]
  - Remove a team member
    
    Returns
    Parameters
    - entity: Entity
      
      The entity to remove
    - force: boolean
      
      If is set to false the command will do nothing if the entity is already in an other team
    Returns string | string[]

name

name: string

settings

settings: teamOptions

Methods

create

create(force?: boolean): string[]
Create the team
Parameters
- Optional force: boolean
  
  Delete other team named as this one before create this one
Returns string[]
- Defined in src/src/tools/team.ts:51

delete

delete(): string
Delete the team

Returns string
- Defined in src/src/tools/team.ts:59

`Private` extraTeamToStr

extraTeamToStr(txt: extraTeamChoice, type: string): string
Parameters
- txt: extraTeamChoice
- type: string
Returns string
- Defined in src/src/tools/team.ts:63

Class Team

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

name: string

Optional options: teamOptions

Returns Team

Properties

edit

Type declaration

collisions: ((type: extraTeamChoice) => string)

Parameters

type: extraTeamChoice

Returns string

color: ((color: mcDefaultColors) => string)

Parameters

color: mcDefaultColors

Returns string

deathMessage: ((hideFor: extraTeamChoice) => string)

Parameters

hideFor: extraTeamChoice

Returns string

display: ((content: JsonRaw) => string)

Parameters

content: JsonRaw

Returns string

friendlyFire: ((active: boolean) => string)

Parameters

active: boolean

Returns string

invisibleFriends: ((hidden: boolean) => string)

Parameters

hidden: boolean

Returns string

nametag: ((hideFor: extraTeamChoice) => string)

Parameters

hideFor: extraTeamChoice

Returns string

prefix: ((content: JsonRaw) => string)

Parameters

content: JsonRaw

Returns string

suffix: ((content: JsonRaw) => string)

Parameters

content: JsonRaw

Returns string

update: (() => string[])

Returns string[]

members

Type declaration

add: ((entity?: Entity, force?: boolean) => string | (string | string[])[])

Parameters

Optional entity: Entity

Optional force: boolean

Returns string | (string | string[])[]

clear: (() => string)

Returns string

remove: ((entity: Entity, force: boolean) => string | string[])

Returns

Parameters

entity: Entity

force: boolean

Returns string | string[]

name

settings

Methods

create

Parameters

Optional force: boolean

Returns string[]

delete

Returns string

Private extraTeamToStr

Parameters

txt: extraTeamChoice

`Optional` options: teamOptions

`Optional` entity: Entity

`Optional` force: boolean

`Optional` force: boolean

`Private` extraTeamToStr