PHP Класс Slackwolf\Game\Game

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$dayEnded
$hunterNeedsToShoot
$nightEnded
$seerSeen
$state
$witchHealed
$witchPoisoned
$wolvesVoted

Открытые методы

Метод Описание
__construct ( $id, array $users, Slackwolf\Game\RoleStrategy\RoleStrategyInterface $roleStrategy )
addLobbyPlayer ( User $user ) : boolean If the lobby is open, adds a user to it.
assignRoles ( ) Assigns each user in the game to a role.
changeState ( $state )
clearPlayerVote ( $voterId )
clearVotes ( )
getDeadPlayers ( ) : User[] An array containing all the users that have been killed.
getGuardedUserId ( ) : mixed
getId ( ) : string
getLastGuardedUserId ( ) : mixed
getLivingPlayers ( ) : User[] An array containing all users that are still alive.
getLobbyPlayers ( ) : User[]
getNumRole ( $roleType ) : integer
getOriginalNumRole ( $roleType ) : integer
getOriginalPlayers ( ) : User[]
getOriginalPlayersOfRole ( $roleType ) : User[]
getPlayerById ( $id ) : User | boolean
getPlayersOfRole ( $roleType ) : User[]
getRoleStrategy ( ) : Slackwolf\Game\RoleStrategy\RoleStrategyInterface
getState ( ) : integer
getVillageTeam ( ) : User[]
getVotes ( ) : array
getWerewolves ( ) : User[]
getWitchHealed ( ) : mixed
getWitchHealedUserId ( ) : mixed
getWitchHealingPotion ( ) : integer
getWitchPoisonPotion ( ) : integer
getWitchPoisoned ( ) : mixed
getWitchPoisonedUserId ( ) : mixed
getWolvesVoted ( ) : mixed
hasPlayerVoted ( $voterId ) : boolean
isOver ( ) : boolean
isPlayerAlive ( $playerId ) : boolean Whether or not the player is alive.
killPlayer ( $player_id ) Kills the specified player.
removeLobbyPlayer ( $player_id ) : boolean Removes a user from the game lobby.
seerSeen ( ) : mixed
setDayEnded ( boolean $val )
setGuardedUserId ( $id )
setHunterNeedsToShoot ( boolean $val )
setLastGuardedUserId ( $id )
setNightEnded ( boolean $val )
setSeerSeen ( $seen )
setWitchHealed ( $healed )
setWitchHealedUserId ( $id )
setWitchHealingPotion ( $val )
setWitchPoisonPotion ( $val )
setWitchPoisoned ( $poisoned )
setWitchPoisonedUserId ( $id )
setWolvesVoted ( mixed $wolvesVoted )
vote ( $voterId, $voteForId )
votingFinished ( ) : boolean
whoWon ( ) : mixed

Описание методов

__construct() публичный Метод

public __construct ( $id, array $users, Slackwolf\Game\RoleStrategy\RoleStrategyInterface $roleStrategy )
$id
$users array
$roleStrategy Slackwolf\Game\RoleStrategy\RoleStrategyInterface

addLobbyPlayer() публичный Метод

If the lobby is open, adds a user to it.
public addLobbyPlayer ( User $user ) : boolean
$user Slack\User The user to add to the lobby.
Результат boolean If successful, returns TRUE, otherwise, FALSE.

assignRoles() публичный Метод

Assigns each user in the game to a role.
public assignRoles ( )

changeState() публичный Метод

public changeState ( $state )
$state

clearPlayerVote() публичный Метод

public clearPlayerVote ( $voterId )
$voterId

clearVotes() публичный Метод

public clearVotes ( )

getDeadPlayers() публичный Метод

An array containing all the users that have been killed.
public getDeadPlayers ( ) : User[]
Результат Slack\User[] Users who have been killed.

getGuardedUserId() публичный Метод

public getGuardedUserId ( ) : mixed
Результат mixed

getId() публичный Метод

public getId ( ) : string
Результат string The game's ID, matches the channel ID.

getLastGuardedUserId() публичный Метод

public getLastGuardedUserId ( ) : mixed
Результат mixed

getLivingPlayers() публичный Метод

An array containing all users that are still alive.
public getLivingPlayers ( ) : User[]
Результат Slack\User[] Users who are currently alive.

getLobbyPlayers() публичный Метод

public getLobbyPlayers ( ) : User[]
Результат Slack\User[] An array of the lobby members.

getNumRole() публичный Метод

public getNumRole ( $roleType ) : integer
Результат integer

getOriginalNumRole() публичный Метод

public getOriginalNumRole ( $roleType ) : integer
Результат integer

getOriginalPlayers() публичный Метод

public getOriginalPlayers ( ) : User[]
Результат Slack\User[]

getOriginalPlayersOfRole() публичный Метод

public getOriginalPlayersOfRole ( $roleType ) : User[]
Результат Slack\User[]

getPlayerById() публичный Метод

public getPlayerById ( $id ) : User | boolean
$id
Результат Slack\User | boolean

getPlayersOfRole() публичный Метод

public getPlayersOfRole ( $roleType ) : User[]
Результат Slack\User[]

getRoleStrategy() публичный Метод

public getRoleStrategy ( ) : Slackwolf\Game\RoleStrategy\RoleStrategyInterface
Результат Slackwolf\Game\RoleStrategy\RoleStrategyInterface The game's strategy type.

getState() публичный Метод

public getState ( ) : integer
Результат integer The state of the game.

getVillageTeam() публичный Метод

public getVillageTeam ( ) : User[]
Результат Slack\User[]

getVotes() публичный Метод

public getVotes ( ) : array
Результат array

getWerewolves() публичный Метод

public getWerewolves ( ) : User[]
Результат Slack\User[]

getWitchHealed() публичный Метод

public getWitchHealed ( ) : mixed
Результат mixed

getWitchHealedUserId() публичный Метод

public getWitchHealedUserId ( ) : mixed
Результат mixed

getWitchHealingPotion() публичный Метод

public getWitchHealingPotion ( ) : integer
Результат integer

getWitchPoisonPotion() публичный Метод

public getWitchPoisonPotion ( ) : integer
Результат integer

getWitchPoisoned() публичный Метод

public getWitchPoisoned ( ) : mixed
Результат mixed

getWitchPoisonedUserId() публичный Метод

public getWitchPoisonedUserId ( ) : mixed
Результат mixed

getWolvesVoted() публичный Метод

public getWolvesVoted ( ) : mixed
Результат mixed

hasPlayerVoted() публичный Метод

public hasPlayerVoted ( $voterId ) : boolean
$voterId
Результат boolean

isOver() публичный Метод

public isOver ( ) : boolean
Результат boolean

isPlayerAlive() публичный Метод

Whether or not the player is alive.
public isPlayerAlive ( $playerId ) : boolean
$playerId The Slack user ID.
Результат boolean TRUE if player is alive and in game, otherwise FALSE.

killPlayer() публичный Метод

Kills the specified player.
public killPlayer ( $player_id )
$player_id The player to kill.

removeLobbyPlayer() публичный Метод

Removes a user from the game lobby.
public removeLobbyPlayer ( $player_id ) : boolean
$player_id The user to remove from the lobby.
Результат boolean If successful, returns TRUE, otherwise, FALSE.

seerSeen() публичный Метод

public seerSeen ( ) : mixed
Результат mixed

setDayEnded() публичный Метод

public setDayEnded ( boolean $val )
$val boolean

setGuardedUserId() публичный Метод

public setGuardedUserId ( $id )
$id

setHunterNeedsToShoot() публичный Метод

public setHunterNeedsToShoot ( boolean $val )
$val boolean

setLastGuardedUserId() публичный Метод

public setLastGuardedUserId ( $id )
$id

setNightEnded() публичный Метод

public setNightEnded ( boolean $val )
$val boolean

setSeerSeen() публичный Метод

public setSeerSeen ( $seen )
$seen

setWitchHealed() публичный Метод

public setWitchHealed ( $healed )
$healed

setWitchHealedUserId() публичный Метод

public setWitchHealedUserId ( $id )
$id

setWitchHealingPotion() публичный Метод

public setWitchHealingPotion ( $val )
$val

setWitchPoisonPotion() публичный Метод

public setWitchPoisonPotion ( $val )
$val

setWitchPoisoned() публичный Метод

public setWitchPoisoned ( $poisoned )
$poisoned

setWitchPoisonedUserId() публичный Метод

public setWitchPoisonedUserId ( $id )
$id

setWolvesVoted() публичный Метод

public setWolvesVoted ( mixed $wolvesVoted )
$wolvesVoted mixed

vote() публичный Метод

public vote ( $voterId, $voteForId )
$voterId
$voteForId

votingFinished() публичный Метод

public votingFinished ( ) : boolean
Результат boolean

whoWon() публичный Метод

public whoWon ( ) : mixed
Результат mixed

Описание свойств

$dayEnded публичное свойство

public $dayEnded

$hunterNeedsToShoot публичное свойство

public $hunterNeedsToShoot

$nightEnded публичное свойство

public $nightEnded

$seerSeen публичное свойство

public $seerSeen

$state публичное свойство

public $state

$witchHealed публичное свойство

public $witchHealed

$witchPoisoned публичное свойство

public $witchPoisoned

$wolvesVoted публичное свойство

public $wolvesVoted