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

The implementations in the ScriptArgumentGeneric<Integer> will cover most of what this needs. More...

#include <lua51scriptargument.h>

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

Public Member Functions

 Lua51IntegerArgument (Integer InitialValue=0)
 Implicit constructor. More...
 
virtual ~Lua51IntegerArgument ()
 Virtual deconstructor.
 
virtual Lua51IntegerArgumentGetMostDerived ()
 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< Integer >
 ScriptArgumentGeneric (Integer InitialValue)
 Create an initialized Argument. More...
 
virtual ~ScriptArgumentGeneric ()
 Overloadable Deconstructor.
 
virtual Boole GetBoole () const
 Get the Integer as a Boole. More...
 
virtual Integer GetInteger () const
 Get the Integer as a Integer. More...
 
virtual Real GetReal () const
 Get the Integer as a Real. More...
 
virtual String GetString () const
 Get the Integer as a String. More...
 
virtual Integer GetTypeData () const
 Get data about this being and Integer. More...
 
virtual Integer GetValue () const
 Get the raw primitive to value. More...
 
virtual Whole GetWhole () const
 Get the Integer as a Whole. More...
 
virtual Boole IsNull () const
 Is this value representing a Null/Nil value. More...
 
virtual void SetValue (Integer 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< Integer >
typedef Integer Type
 To make working with this easier.
 
- Protected Attributes inherited from Mezzanine::Scripting::ScriptArgumentGeneric< Integer >
Integer Datum
 The Integer actual data.
 

Detailed Description

The implementations in the ScriptArgumentGeneric<Integer> will cover most of what this needs.

Definition at line 100 of file lua51scriptargument.h.

Constructor & Destructor Documentation

Mezzanine::Scripting::Lua::Lua51IntegerArgument::Lua51IntegerArgument ( Integer  InitialValue = 0)
inline

Implicit constructor.

Parameters
InitialValueDefaults to 0 and is the actual data to pass into Lua
Note
This is intentionally not explicit. This should make it easier to work with in situations where the creation of this is less important.

Definition at line 107 of file lua51scriptargument.h.

Member Function Documentation

virtual Lua51IntegerArgument* Mezzanine::Scripting::Lua::Lua51IntegerArgument::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< Integer >.

Definition at line 119 of file lua51scriptargument.h.

void Mezzanine::Scripting::Lua::Lua51IntegerArgument::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 74 of file lua51scriptargument.cpp.

void Mezzanine::Scripting::Lua::Lua51IntegerArgument::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 72 of file lua51scriptargument.cpp.


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