PHP Class Slackwolf\Game\Role

Show file Open project: chrisgillis/slackwolf Class Usage Examples

Public Methods

Method	Description
appearsAsWerewolf ( ) : boolean
getDescription ( ) : string	Returns the description of the Role.
getName ( ) : string	Returns the name of the current Role.
getSpecialRoles ( )
isRole ( $roleName ) : boolean	Returns a bool on whether the Role name matches.
isWerewolfTeam ( ) : boolean

Method Details

appearsAsWerewolf() public method

public appearsAsWerewolf ( ) : boolean
return	boolean

getDescription() public method

Returns the description of the Role.

public getDescription ( ) : string
return	string

getName() public method

Returns the name of the current Role.

public getName ( ) : string
return	string

getSpecialRoles() public static method

public static getSpecialRoles ( )

isRole() public method

Returns a bool on whether the Role name matches.

public isRole ( $roleName ) : boolean
$roleName		The Role name to compare against.
return	boolean

isWerewolfTeam() public method

public isWerewolfTeam ( ) : boolean
return	boolean