DISCLAIMER
This software is currently under development. It is not done. While it will not be done quickly, contributions can help make things go faster. Please contribute if you can.
NAME
Games::Framework::RCP::Data::Classes - Subroutines for the Classes table.
VERSION
Version 0.01_01
DEPENDENCIES
The requirements for this module are as follows:
Perl 5.10 or higher
SYNOPSIS
Games::Framework::RCP::Data::Classes - A listing of the different subroutines that one can use to manipulate the job classes.
DESCRIPTION
This module contains the basic functions for inserting, deleting, updating, or selecting classes and/or class stats. This module does NOT handle what status effects a class may start with at the beginning, for instance.
CONFIGURATION AND ENVIRONMENT
No configuration should be required.
SUBROUTINES/METHODS
insert_job_class
This function is for game masters to add a new job class to the database. This function only handles the information within the data.classes table.
The parameters are as follows:
$_[0]
The name of the new job class. Please keep within 32 characters. This is required.
$_[1]
The description of the new job class. Please keep within 256 characters. This is required.
$_[2]
The kind of job: hero usable, unlockable, boss only, etc. Integers are used here (numbers below are subject to change):
1
Normal class: anyone can use it.
2
Locked class: players must earn it, almost anyone else can use it.
3
Boss class: Game Masters use it, players generally can't.
-1
Penalty class: anyone can use it...but why? Can be administered for various reasons.
$_[3]
The
$statshash reference. It can contain the following stats:hp
HP of the job.
mp
MP of the job.
pp
PP of the job.
spd
Speed of the job.
patk
Physical Attack
matk
Magical Attack
pdef
Physical Defense
mdef
Magical Defense
pacc
Physical Accuracy
macc
Magical Accuracy
pevd
Physical Evade
mevd
Magical Evade
For any stat that is missing, the default value of 50 is provided.
delete_job_by_name
Remove a job from the database by its name PERMAMENTLY. Use this at your own risk!
The parameters are as follows:
$_[0]
The name of the job.
delete_job_by_id
Remove a job from the database by its ID PERMAMENTLY. Use this at your own risk!
The parameters are as follows:
$_[0]
The ID of the job.
update_job_name_by_name
Update a job's name based on the old name.
The parameters are as follows:
$_[0]
The old name of the job.
$_[1]
The new name of the job.
update_job_name_by_id
Update a job's name based on the ID.
The parameters are as follows:
$_[0]
The ID of the job.
$_[1]
The new name of the job.
update_job_desc_by_name
Update a job's description by its name.
The parameters are as follows:
$_[0]
The name of the job.
$_[1]
The description of the job.
update_job_desc_by_id
Update a job's description by its ID.
The parameters are as follows:
$_[0]
The ID of the job.
$_[1]
The description of the job.
update_job_kind_by_name
Update a job's kind (playability) by its name.
The parameters are as follows:
$_[0]
The name of the job.
$_[1]
The kind of job.
update_job_kind_by_id
Update a job's kind (playability) by its ID.
The parameters are as follows:
$_[0]
The ID of the job.
$_[1]
The kind of job.
update_job_stat_by_name
Update a job stat's value by its name.
The parameters are as follows:
$_[0]
The name of the job.
$_[1]
The stat to update.
$_[2]
The value of the new stat.
update_job_stat_by_id
Update a job stat's value by its ID.
The parameters are as follows:
$_[0]
The ID of the job.
$_[1]
The stat to update.
$_[2]
The value of the new stat.
select_job_id_by_name
Select the job ID based on the job name given.
The parameters are as follows:
$_[0]
The name of the job.
select_job_name_by_id
Select the job name based on the job ID given.
The parameters are as follows:
$_[0]
The ID of the job.
select_job_desc_by_name
Select the job description based on the job name given.
The parameters are as follows:
$_[0]
The name of the job.
select_job_desc_by_id
Select the job description based on the job ID given.
The parameters are as follows:
$_[0]
The ID of the job.
select_job_kind_by_name
Select the job kind (playability) based on the job name given.
The parameters are as follows:
$_[0]
The name of the job.
select_job_kind_by_id
Select the job kind (playability) based on the job ID given.
The parameters are as follows:
$_[0]
The ID of the job.
select_job_stat_by_name
Select the job stat based on the job name given.
The parameters are as follows:
$_[0]
The name of the job.
$_[1]
The stat of the job.
select_job_stat_by_id
Select the job stat based on the job ID given.
The parameters are as follows:
$_[0]
The ID of the job.
$_[1]
The stat of the job.
select_job_info_by_name
Get every column of data related to the job by its name.
The parameters are as follows:
$_[0]
The name of the job.
select_job_info_by_id
Get every column of data related to the job by its ID.
The parameters are as follows:
$_[0]
The ID of the job.
INCOMPATIBILITIES
There are no known incompatibilities in this module.
DIAGNOSTICS
There are no known problems, and therefore no need to provide solutions.
AUTHOR
Jason Felds, <wolfman.ncsu2000 at gmail.com>
BUGS AND LIMITATIONS
Please report any bugs or feature requests to bug-Games-Framework-RCP at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Games-Framework-RCP-Data-Classes. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Games::Framework::RCP::Data::ClassesYou can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Games-Framework-RCP-Data-Classes
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
http://cpanratings.perl.org/d/Games-Framework-RCP-Data-Classes
Search CPAN
http://search.cpan.org/dist/Games-Framework-RCP-Data-Classes/
ACKNOWLEDGEMENTS
See Games::Framework::RCP for all acknowledgements.
LICENSE AND COPYRIGHT
Copyright 2008 Jason Felds, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.