Move documentation from GameScriptRotation.h to ".cpp.

This commit is contained in:
hispidence 2021-07-20 17:49:14 +01:00
parent f6ff21bda2
commit 2d1b9c8178
2 changed files with 24 additions and 25 deletions

View file

@ -2,17 +2,40 @@
#include "GameScriptRotation.h"
#include "phd_global.h"
/***
Represents a rotation as a combination of individual
angles, in degrees, about each axis.
All values will be clamped to [-32768, 32767].
@classmod Rotation
@pragma nostrip
*/
void GameScriptRotation::Register(sol::state* state)
{
state->new_usertype<GameScriptRotation>("Rotation",
sol::constructors<GameScriptRotation(int, int, int)>(),
/// (int) rotation about x axis
//@mem X
"X", &GameScriptRotation::x,
/// (int) rotation about x axis
//@mem Y
"Y", &GameScriptRotation::y,
/// (int) rotation about x axis
//@mem Z
"Z", &GameScriptRotation::z
);
}
/***
@int X rotation about x axis
@int Y rotation about y axis
@int Z rotation about z axis
@return A Rotation object.
@function Rotation.new
*/
GameScriptRotation::GameScriptRotation(int aX, int aY, int aZ)
{
x = aX;