4
Copyright (C) 2005-2010 Julien Jorge, Sebastien Angibaud
6
This program is free software; you can redistribute it and/or modify it
7
under the terms of the GNU General Public License as published by the
8
Free Software Foundation; either version 2 of the License, or (at your
9
option) any later version.
11
This program is distributed in the hope that it will be useful, but WITHOUT
12
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16
You should have received a copy of the GNU General Public License along
17
with this program; if not, write to the Free Software Foundation, Inc.,
18
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20
contact: plee-the-bear@gamned.org
22
Please add the tag [BEAR] in the subject of your mails.
25
* \file u_int_level_variable_getter_creator.hpp
26
* \brief A linear expression that returns the value of a level variable.
27
* \author Julien Jorge
29
#ifndef __BEAR_U_INT_LEVEL_VARIABLE_GETTER_CREATOR_HPP__
30
#define __BEAR_U_INT_LEVEL_VARIABLE_GETTER_CREATOR_HPP__
32
#include "engine/base_item.hpp"
33
#include "engine/function/linear_level_variable_getter.hpp"
34
#include "engine/item_brick/with_linear_expression_creation.hpp"
36
#include "engine/export.hpp"
37
#include "generic_items/class_export.hpp"
42
* \brief A linear expression that returns the value of a level variable.
44
* The valid fields for this item are
45
* - name: The name of the variable to get,
46
* - default_value: The default value of the variable, if not set,
47
* - any field supported by the parent classes.
49
* \author Julien Jorge
51
class GENERIC_ITEMS_EXPORT u_int_level_variable_getter_creator:
52
public engine::base_item,
53
public engine::with_linear_expression_creation
55
DECLARE_BASE_ITEM(u_int_level_variable_getter_creator);
58
/** \brief The type of the parent class. */
59
typedef engine::base_item super;
62
u_int_level_variable_getter_creator();
65
bool is_valid() const;
68
( const std::string& name, const std::string& value );
69
bool set_u_integer_field( const std::string& name, unsigned int value );
72
virtual expr::linear_expression do_get_expression() const;
75
/** \brief The expression created by this item. */
76
engine::linear_level_variable_getter<unsigned int> m_expr;
78
}; // class u_int_level_variable_getter_creator
81
#endif // __BEAR_U_INT_LEVEL_VARIABLE_GETTER_CREATOR_HPP__