Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/tutorial3/src/modules/docking/DockToShip.cc @ 12412

Last change on this file since 12412 was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 2.8 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Sven Stucki
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file DockToShip.cc
31    @brief Implementation of the DockToShip class.
32*/
33
34#include "DockingEffect.h"
35#include "DockToShip.h"
36#include "core/CoreIncludes.h"
37
38namespace orxonox
39{
40    CreateFactory(DockToShip);
41
42    DockToShip::DockToShip(BaseObject* creator) : DockingEffect(creator)
43    {
44        RegisterObject(DockToShip);
45        orxout(verbose, context::docking) << "DockToShip instance created.." << endl;
46    }
47
48    DockToShip::~DockToShip()
49    {
50
51    }
52
53
54    void DockToShip::XMLPort(Element& xmlelement, XMLPort::Mode mode) {
55        SUPER(DockToShip, XMLPort, xmlelement, mode);
56
57        XMLPortParam(DockToShip, "target", setTargetId, getTargetId, xmlelement, mode);
58    }
59
60    void DockToShip::setTargetId(const std::string& str) {
61        this->target_ = str;
62    }
63
64    const std::string& DockToShip::getTargetId() const {
65        return this->target_;
66    }
67
68
69    bool DockToShip::docking(PlayerInfo* player)
70    {
71        orxout(verbose, context::docking) << "DockToShip::attach" << endl;
72
73        DockingTarget *target = DockingEffect::findTarget(this->target_);
74        if (target == NULL) {
75            orxout(internal_warning, context::docking) << "Can't retrieve target for '" << this->target_ << "'.." << endl;
76            return false;
77        }
78
79        ControllableEntity *dockTo = (ControllableEntity*) target->getParent();
80        if (dockTo == NULL) {
81            orxout(internal_warning, context::docking) << "Parent is not a ControllableEntity.." << endl;
82            return false;
83        }
84
85        // Make sure target isn't removed when undocking
86        dockTo->setDestroyWhenPlayerLeft(false);
87        player->startTemporaryControl(dockTo);
88
89        return true;
90    }
91
92    bool DockToShip::release(PlayerInfo* player)
93    {
94        orxout(verbose, context::docking) << "DockToShip::release" << endl;
95
96        player->stopTemporaryControl();
97
98        return true;
99    }
100}
101
Note: See TracBrowser for help on using the repository browser.