Games::AssaultCube::Log::Line::TeamStatus - Describes the TeamStatus event in a log line


Games-AssaultCube documentation Contained in the Games-AssaultCube distribution.

Index


Code Index:

Games::AssaultCube::Log::Line::TeamStatus - Describes the TeamStatus event in a log line

ABSTRACT

Top

Describes the TeamStatus event in a log line

DESCRIPTION

Top

This module holds the "TeamStatus" event data from a log line. Normally, you would not use this class directly but via the Games::AssaultCube::Log::Line class.

This line is emitted when the AC server finishes a team-based game.

Attributes

Those attributes hold information about the event. As this class extends the Games::AssaultCube::Log::Line::Base class, you can also use it's attributes too.

team

The id of the team

	0 = CLA
	1 = RVSF
	2 = NONE

team_name

The team name ( CLA, RVSF, NONE )

players

The number of players on this team

frags

The total number of frags for this team

flags

The total number of captured flags this team did ( not always defined - depends on gamemode )

The number of passwords loaded

configfile

The admin password config filename

AUTHOR

Top

Apocalypse <apocal@cpan.org>

Props goes to the BS clan for the support!

This project is sponsored by http://cubestats.net

COPYRIGHT AND LICENSE

Top


Games-AssaultCube documentation Contained in the Games-AssaultCube distribution.

# Declare our package
package Games::AssaultCube::Log::Line::TeamStatus;

# import the Moose stuff
use Moose;

# Initialize our version
use vars qw( $VERSION );
$VERSION = '0.04';

extends 'Games::AssaultCube::Log::Line::Base';

with	'Games::AssaultCube::Log::Line::Base::TeamInfo';

# TODO improve validation for everything here, ha!

has 'players' => (
	isa		=> 'Int',
	is		=> 'ro',
	required	=> 1,
);

has 'frags' => (
	isa		=> 'Int',
	is		=> 'ro',
	required	=> 1,
);

has 'flags' => (
	isa		=> 'Int',
	is		=> 'ro',
);

has 'tostr' => (
	isa		=> 'Str',
	is		=> 'ro',
	lazy		=> 1,
	default		=> sub {
		my $self = shift;
		return "Team Status for " . $self->team_name . ": " . $self->players . " players, " . $self->frags . " frags" . ( defined $self->flags ? ", " . $self->flags . " flags" : "" );
	},
);

no Moose;
__PACKAGE__->meta->make_immutable;

1;
__END__