scummvm/engines/lastexpress/entities/ivo.h
2021-12-26 18:48:43 +01:00

173 lines
3.7 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* 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, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef LASTEXPRESS_IVO_H
#define LASTEXPRESS_IVO_H
#include "lastexpress/entities/entity.h"
namespace LastExpress {
class LastExpressEngine;
class Ivo : public Entity {
public:
Ivo(LastExpressEngine *engine);
~Ivo() override {}
/**
* Resets the entity
*/
DECLARE_FUNCTION(reset)
/**
* Draws the entity
*
* @param sequence The sequence to draw
*/
DECLARE_FUNCTION_1(draw, const char *sequence)
/**
* Handles entering/exiting a compartment.
*
* @param sequence The sequence to draw
* @param compartment The compartment
*/
DECLARE_VFUNCTION_2(enterExitCompartment, const char *sequence, ObjectIndex compartment)
/**
* Updates parameter 2 using time value
*
* @param time The time to add
*/
DECLARE_FUNCTION_1(updateFromTime, uint32 time)
/**
* Updates parameter 2 using ticks value
*
* @param ticks The number of ticks to add
*/
DECLARE_FUNCTION_1(updateFromTicks, uint32 ticks)
/**
* Updates the entity
*
* @param car The car
* @param entityPosition The entity position
*/
DECLARE_VFUNCTION_2(updateEntity, CarIndex car, EntityPosition entityPosition)
/**
* Process callback action when the entity direction is not kDirectionRight
*/
DECLARE_FUNCTION(callbackActionOnDirection)
/**
* Plays sound
*
* @param savepoint The savepoint
* - the sound filename
*/
DECLARE_FUNCTION_NOSETUP(playSound)
/**
* Process callback action when somebody is standing in the restaurant or salon.
*/
DECLARE_FUNCTION(callbackActionRestaurantOrSalon)
/**
* Saves the game
*
* @param savegameType The type of the savegame
* @param param The param for the savegame (EventIndex or TimeValue)
*/
DECLARE_VFUNCTION_2(savegame, SavegameType savegameType, uint32 param)
DECLARE_FUNCTION(goCompartment)
DECLARE_FUNCTION(sitAtTableWithSalko)
DECLARE_FUNCTION(leaveTableWithSalko)
/**
* Setup Chapter 1
*/
DECLARE_VFUNCTION(chapter1)
/**
* Handle Chapter 1 events
*/
DECLARE_FUNCTION(chapter1Handler)
DECLARE_FUNCTION(inCompartment)
DECLARE_FUNCTION(function17)
/**
* Setup Chapter 2
*/
DECLARE_VFUNCTION(chapter2)
DECLARE_FUNCTION(goBreakfast)
DECLARE_FUNCTION(atBreakfast)
DECLARE_FUNCTION(function21)
/**
* Setup Chapter 3
*/
DECLARE_VFUNCTION(chapter3)
/**
* Handle Chapter 3 events
*/
DECLARE_FUNCTION(chapter3Handler)
/**
* Setup Chapter 4
*/
DECLARE_VFUNCTION(chapter4)
/**
* Handle Chapter 4 events
*/
DECLARE_FUNCTION(chapter4Handler)
DECLARE_FUNCTION(returnCompartment4)
DECLARE_FUNCTION(inCompartment4)
DECLARE_FUNCTION(hiding)
DECLARE_FUNCTION(function29)
/**
* Setup Chapter 5
*/
DECLARE_VFUNCTION(chapter5)
/**
* Handle Chapter 5 events
*/
DECLARE_FUNCTION(chapter5Handler)
DECLARE_FUNCTION(fightCath)
DECLARE_FUNCTION(knockedOut)
DECLARE_FUNCTION(function34)
};
} // End of namespace LastExpress
#endif // LASTEXPRESS_IVO_H