mirror of
https://github.com/azerothcore/mod-ale
synced 2025-11-29 15:38:17 +08:00
9d9e72e598
Method documentation should be completed. Only thing left now is polishing up (fixing typos, update wording, add enumerator data to method documentation that doesn't have it, etc).. Cleaned whitespaces Corrected/Fixed up some comments Removed all known documented method comments in LuaFunctions.cpp. Commented out methods are now marked as undocumented until they are uncommented & documented in their respective header files. Removed 'Getter, Setter, Boolean, Other' comments in method files Documented VehicleMethods, the rest of PlayerMethods, UnitMethods, CreatureMethods and GuildMethods. Refer to #101 for more information
115 lines
2.7 KiB
C++
115 lines
2.7 KiB
C++
/*
|
|
* Copyright (C) 2010 - 2015 Eluna Lua Engine <http://emudevs.com/>
|
|
* This program is free software licensed under GPL version 3
|
|
* Please see the included DOCS/LICENSE.md for more information
|
|
*/
|
|
|
|
#ifndef VEHICLEMETHODS_H
|
|
#define VEHICLEMETHODS_H
|
|
#ifndef CLASSIC
|
|
#ifndef TBC
|
|
|
|
/***
|
|
* Inherits all methods from: none
|
|
*/
|
|
namespace LuaVehicle
|
|
{
|
|
/**
|
|
* Returns true if the [Unit] passenger is on board
|
|
*
|
|
* @param [Unit] passenger
|
|
* @return bool isOnBoard
|
|
*/
|
|
int IsOnBoard(Eluna* /*E*/, lua_State* L, Vehicle* vehicle)
|
|
{
|
|
Unit* passenger = Eluna::CHECKOBJ<Unit>(L, 2);
|
|
#ifndef TRINITY
|
|
Eluna::Push(L, vehicle->HasOnBoard(passenger));
|
|
#else
|
|
Eluna::Push(L, passenger->IsOnVehicle(vehicle->GetBase()));
|
|
#endif
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Returns the [Vehicle]'s owner
|
|
*
|
|
* @return [Unit] owner
|
|
*/
|
|
int GetOwner(Eluna* /*E*/, lua_State* L, Vehicle* vehicle)
|
|
{
|
|
#ifndef TRINITY
|
|
Eluna::Push(L, vehicle->GetOwner());
|
|
#else
|
|
Eluna::Push(L, vehicle->GetBase());
|
|
#endif
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Returns the [Vehicle]'s entry
|
|
*
|
|
* @return uint32 entry
|
|
*/
|
|
int GetEntry(Eluna* /*E*/, lua_State* L, Vehicle* vehicle)
|
|
{
|
|
#ifndef TRINITY
|
|
Eluna::Push(L, vehicle->GetVehicleEntry()->m_ID);
|
|
#else
|
|
Eluna::Push(L, vehicle->GetVehicleInfo()->m_ID);
|
|
#endif
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Returns the [Vehicle]'s passenger in the specified seat
|
|
*
|
|
* @param int8 seat
|
|
* @return [Unit] passenger
|
|
*/
|
|
int GetPassenger(Eluna* /*E*/, lua_State* L, Vehicle* vehicle)
|
|
{
|
|
int8 seatId = Eluna::CHECKVAL<int8>(L, 2);
|
|
Eluna::Push(L, vehicle->GetPassenger(seatId));
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Adds [Unit] passenger to a specified seat in the [Vehicle]
|
|
*
|
|
* @param [Unit] passenger
|
|
* @param int8 seat
|
|
*/
|
|
int AddPassenger(Eluna* /*E*/, lua_State* L, Vehicle* vehicle)
|
|
{
|
|
Unit* passenger = Eluna::CHECKOBJ<Unit>(L, 2);
|
|
int8 seatId = Eluna::CHECKVAL<int8>(L, 3);
|
|
#ifndef TRINITY
|
|
if (vehicle->CanBoard(passenger))
|
|
vehicle->Board(passenger, seatId);
|
|
#else
|
|
vehicle->AddPassenger(passenger, seatId);
|
|
#endif
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Removes [Unit] passenger from the [Vehicle]
|
|
*
|
|
* @param [Unit] passenger
|
|
*/
|
|
int RemovePassenger(Eluna* /*E*/, lua_State* L, Vehicle* vehicle)
|
|
{
|
|
Unit* passenger = Eluna::CHECKOBJ<Unit>(L, 2);
|
|
#ifndef TRINITY
|
|
vehicle->UnBoard(passenger, false);
|
|
#else
|
|
vehicle->RemovePassenger(passenger);
|
|
#endif
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
#endif // CLASSIC
|
|
#endif // TBC
|
|
#endif // VEHICLEMETHODS_H
|