/ 
Games-Framework-RCP-0.01_02
River stage zero No dependents
/ Games::Framework::RCP::Utilities::Vars_Bool

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::Utilities::Vars_Bool - Subroutines for the vars_bool Table.

VERSION

Version 0.07

DEPENDENCIES

The requirements for this module are as follows:

SYNOPSIS

Games::Framework::RCP::Utilities::Vars_Bool - A listing of the different subroutines that one can use to manipulate boolean variables.

DESCRIPTION

This module contains various functions used to manipulate the vars_bool table. One can insert, delete, update, and select various boolean variable names and values. Note that it is recommended to not delete the particular variables.

CONFIGURATION AND ENVIRONMENT

No configuration should be required.

SUBROUTINES/METHODS

insert_boolean_variable

This function is used to insert a new variable that takes a boolean value. Any new variables created are inaccessible until either coded in the modules or your own driver program.

The parameters are as follows:

  • $_[0]

    the name of the variable.

  • $_[1]

    the value of the variable. It defaults to 0 if nothing is provided.

Returns "taken" if that variable name is already in use.

update_boolean_variable_value_by_name

This function takes a boolean variable's name to update its value.

The parameters are as follows:

  • $_[0]

    the name of the variable.

  • $_[1]

    the new value.

update_boolean_variable_value_by_id

This function takes a boolean variable's ID to update its value.

The parameters are as follows:

  • $_[0]

    the ID of the variable.

  • $_[1]

    the new value.

invert_boolean_variable_by_name

This function inverts a boolean variable's value, given a name. It is provided as a convenience to Game Masters.

The parameters are as follows:

  • $_[0]

    the name of the variable.

invert_boolean_variable_by_id

This function inverts a boolean variable's value, given an ID. It is provided as a convenience to Game Masters.

The parameters are as follows:

  • $_[0]

    the ID of the variable.

invert_all_boolean_variables

This function inverts all of the integer variables' values. It is provided as a convenience to Game Masters.

There are no parameters in this function.

delete_boolean_variable_by_name

This function removes a boolean variable based off of its name. It is recommended to NEVER call this function: however, it is provided just in case someone wants to have fun with it.

The parameters are as follows:

  • $_[0]

    the name of the variable.

delete_boolean_variable_by_id

This function removes a boolean variable based off of its ID. It is recommended to NEVER call this function: however, it is provided just in case someone wants to have fun with it.

The parameters are as follows:

  • $_[0]

    the ID of the variable.

select_boolean_variable_value_by_name

This function is available to get the value of a boolean variable by its name.

The parameters are as follows:

  • $_[0]

    the name of the variable.

Return the value of the variable if it was selected.

select_boolean_variable_value_by_id

This function is available to get the value of a boolean variable by its ID.

The parameters are as follows:

  • $_[0]

    the ID of the variable.

Return the value of the variable if it was selected.

select_id_by_boolean_variable

This function returns the ID of the specific boolean variable.

The parameters are as follows:

  • $_[0]

    The name of the variable.

Returns the ID of the variable if it exists.

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-Utilities-Vars_Bool. 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::Utilities::Vars_Bool

You can also look for information at:

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.