X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fscripting%2Fplayer.hpp;h=a8f63b769c9d10851a19a49dc65b6f85b23ddf91;hb=02006fdd9da5000586077bf331620b92854c8125;hp=0a337692339d37bbaa124516b738e02ca93d6891;hpb=07ddaed2a657e4d2a3d038fed223fc5827159caf;p=supertux.git diff --git a/src/scripting/player.hpp b/src/scripting/player.hpp index 0a3376923..a8f63b769 100644 --- a/src/scripting/player.hpp +++ b/src/scripting/player.hpp @@ -1,12 +1,10 @@ -// $Id$ -// // SuperTux // Copyright (C) 2006 Matthias Braun // -// This program is free software; you can redistribute it and/or -// modify it under the terms of the GNU General Public License -// as published by the Free Software Foundation; either version 2 -// of the License, or (at your option) any later version. +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -14,14 +12,16 @@ // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. +// along with this program. If not, see . -#ifndef __PLAYER_H__ -#define __PLAYER_H__ +#ifndef HEADER_SUPERTUX_SCRIPTING_PLAYER_HPP +#define HEADER_SUPERTUX_SCRIPTING_PLAYER_HPP -namespace Scripting -{ +#ifndef SCRIPTING_API +#include +#endif + +namespace scripting { class Player { @@ -35,21 +35,21 @@ public: * Set tux bonus. * This can be "grow", "fireflower" or "iceflower" at the moment */ - virtual void set_bonus(const std::string& bonus) = 0; + virtual bool add_bonus(const std::string& bonus) = 0; /** * Give tux more coins */ virtual void add_coins(int count) = 0; /** - * Make tux invicible for a short amount of time + * Make tux invincible for a short amount of time */ virtual void make_invincible() = 0; /** - * Deactivate user input for Tux + * Deactivate user/scripting input for Tux */ virtual void deactivate() = 0; /** - * Give control back to user + * Give control back to user/scripting */ virtual void activate() = 0; /** @@ -57,17 +57,88 @@ public: */ virtual void walk(float speed) = 0; /** - * Set player visible or not visible + * Face Tux in the proper direction + */ + virtual void set_dir(bool right) = 0; + /** + * Set player visible or invisible */ virtual void set_visible(bool visible) = 0; /** * returns true if the player is currently visible (that is he was not set - * inivisible by the set_visible method) + * invisible by the set_visible method) */ virtual bool get_visible() = 0; + + /** + * Hurts a player, if completely=true then the player will be killed even + * if he had grow or fireflower bonus + */ + virtual void kill(bool completely) = 0; + + /** + * Switches ghost mode on/off. + * Lets Tux float around and through solid objects. + */ + virtual void set_ghost_mode(bool enable) = 0; + + /** + * Returns whether ghost mode is currently enabled + */ + virtual bool get_ghost_mode() = 0; + + /** + * start kick animation + */ + virtual void kick() = 0; + + /** + * play cheer animation. + * This might need some space and behave in an unpredictable way. Best to use this at level end. + */ + virtual void do_cheer() = 0; + + /** + * duck down if possible. + * this won't last long as long as input is enabled. + */ + virtual void do_duck() = 0; + + /** + * stand back up if possible. + */ + virtual void do_standup() = 0; + + /** + * do a backflip if possible. + */ + virtual void do_backflip() = 0; + + /** + * jump in the air if possible + * sensible values for yspeed are negative - unless we want to jump into the ground of course + */ + virtual void do_jump(float yspeed) = 0; + + /** + * Orders the current GameSession to start a sequence + */ + virtual void trigger_sequence(std::string sequence_name) = 0; + + /** + * Uses a scriptable controller for all user input (or restores controls) + */ + virtual void use_scripting_controller(bool use_or_release) = 0; + + /** + * Instructs the scriptable controller to press or release a button + */ + virtual void do_scripting_controller(std::string control, bool pressed) = 0; + }; } #endif +/* EOF */