Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::Scripting::Lua::Lua51RealArgument Class Reference

A Real that can readily be passed into lua scripts. More...

#include <lua51scriptargument.h>

+ Inheritance diagram for Mezzanine::Scripting::Lua::Lua51RealArgument:
+ Collaboration diagram for Mezzanine::Scripting::Lua::Lua51RealArgument:

Public Member Functions

 Lua51RealArgument (Real InitialValue=0.0)
 Initializing constructor. More...
 
virtual ~Lua51RealArgument ()
 Virtual deconstructor.
 
virtual Lua51RealArgumentGetMostDerived ()
 Get a pointer to the most Derived type of this class. More...
 
virtual void Pop (lua_State *TargetState)
 Handle the details of pulling data from Lua's Stack into this. More...
 
virtual void Push (lua_State *TargetState) const
 Handle the details of putting this data onto Lua's Stack. More...
 
- Public Member Functions inherited from Mezzanine::Scripting::Lua::LuaArgument
virtual ~LuaArgument ()
 Virtual deconstructor.
 
- Public Member Functions inherited from Mezzanine::Scripting::ScriptArgumentGeneric< Real >
 ScriptArgumentGeneric (Real InitialValue)
 Create an initialized Argument. More...
 
virtual ~ScriptArgumentGeneric ()
 Overloadable Deconstructor.
 
virtual Boole GetBoole () const
 Get the Real as a Boole. More...
 
virtual Integer GetInteger () const
 Get the Real as a Integer. More...
 
virtual Real GetReal () const
 Get the Real. More...
 
virtual String GetString () const
 Get the Real as a String. More...
 
virtual Integer GetTypeData () const
 Get data about this being a Real number. More...
 
virtual Real GetValue () const
 Get the raw primitive to value. More...
 
virtual Whole GetWhole () const
 Get the Real as a Whole. More...
 
virtual Boole IsNull () const
 Is this value representing a Null/Nil value. More...
 
virtual void SetValue (Real NewValue)
 Provide an overload point to change assignment that operators will use. More...
 
- Public Member Functions inherited from Mezzanine::Scripting::iScriptArgument
virtual ~iScriptArgument ()
 Overidable Deconstructor.
 
- Public Member Functions inherited from Mezzanine::IntrusiveRefCount
 IntrusiveRefCount ()
 Constructor for instatiating the Reference Count.
 
virtual ~IntrusiveRefCount ()
 Virtual Deconstructor to prevent issues with deletion with incomplete type information.
 
Whole DecrementReferenceCount ()
 Decrease the reference count by one and return the updated count. More...
 
Whole GetReferenceCount () const
 Get the current amount of references. More...
 
IntrusiveRefCountGetReferenceCountTargetAsPointer ()
 Gets the actual pointer to the target. More...
 
Whole IncrementReferenceCount ()
 Increase the reference count by one and return the updated count. More...
 

Additional Inherited Members

- Public Types inherited from Mezzanine::Scripting::ScriptArgumentGeneric< Real >
typedef Real Type
 To make working with this easier.
 
- Protected Attributes inherited from Mezzanine::Scripting::ScriptArgumentGeneric< Real >
Real Datum
 The Real actual data.
 

Detailed Description

A Real that can readily be passed into lua scripts.

Definition at line 124 of file lua51scriptargument.h.

Constructor & Destructor Documentation

Mezzanine::Scripting::Lua::Lua51RealArgument::Lua51RealArgument ( Real  InitialValue = 0.0)
inline

Initializing constructor.

Parameters
InitialValueDeafaults to 0.0

Definition at line 130 of file lua51scriptargument.h.

Member Function Documentation

virtual Lua51RealArgument* Mezzanine::Scripting::Lua::Lua51RealArgument::GetMostDerived ( )
inlinevirtual

Get a pointer to the most Derived type of this class.

Returns
A pointer of the most derived pointing to this.

Reimplemented from Mezzanine::Scripting::ScriptArgumentGeneric< Real >.

Definition at line 143 of file lua51scriptargument.h.

void Mezzanine::Scripting::Lua::Lua51RealArgument::Pop ( lua_State *  TargetState)
virtual

Handle the details of pulling data from Lua's Stack into this.

Parameters
TargetStateThe state with the stack to pull the data from.
Returns
Whatever the Lua return code of the first failing lua call, or the last successful call.

Implements Mezzanine::Scripting::Lua::LuaArgument.

Definition at line 88 of file lua51scriptargument.cpp.

void Mezzanine::Scripting::Lua::Lua51RealArgument::Push ( lua_State *  TargetState) const
virtual

Handle the details of putting this data onto Lua's Stack.

Parameters
TargetStateThe state with the stack to push the data onto.
Returns
Whatever the Lua return code of the first failing lua call, or the last successful call.

Implements Mezzanine::Scripting::Lua::LuaArgument.

Definition at line 86 of file lua51scriptargument.cpp.


The documentation for this class was generated from the following files: