This is only the functionality required to make the functionality associated with money work (such as land transfers). There is no money code here! Use FORGE as an example for money code. Demo Economy/Money Module. This is a purposely crippled module! // To land transfer you need to add: -helperuri http://serveraddress:port/ to the command line parameters you use to start up your client This commonly looks like -helperuri http://127.0.0.1:9000/ More...

Inheritance diagram for OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule:

[legend]

Collaboration diagram for OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule:

[legend]

Public Member Functions
void	Initialise (IConfigSource config)
	Called on startup so the module can be configured. More...

void	AddRegion (Scene scene)
	This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called. More...

void	RemoveRegion (Scene scene)
	This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed. More...

void	RegionLoaded (Scene scene)
	This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module. More...

void	ApplyCharge (UUID agentID, int amount, MoneyTransactionType type, string extraData)

void	ApplyCharge (UUID agentID, int amount, MoneyTransactionType type)

void	ApplyUploadCharge (UUID agentID, int amount, string text)

bool	ObjectGiveMoney (UUID objectID, UUID fromID, UUID toID, int amount, UUID txn, out string result)

void	PostInitialise ()
	This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised. More...

void	Close ()
	This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...

void	SendMoneyBalance (IClientAPI client, UUID agentID, UUID SessionID, UUID TransactionID)
	Sends the the stored money balance to the client More...

XmlRpcResponse	UserAlert (XmlRpcRequest request, IPEndPoint remoteClient)
	XMLRPC handler to send alert message and sound to client More...

XmlRpcResponse	quote_func (XmlRpcRequest request, IPEndPoint remoteClient)

XmlRpcResponse	buy_func (XmlRpcRequest request, IPEndPoint remoteClient)

XmlRpcResponse	preflightBuyLandPrep_func (XmlRpcRequest request, IPEndPoint remoteClient)

XmlRpcResponse	landBuy_func (XmlRpcRequest request, IPEndPoint remoteClient)

Scene	GetRandomScene ()
	Utility function Gets a Random scene in the instance. For when which scene exactly you're doing something with doesn't matter More...

Scene	GetSceneByUUID (UUID RegionID)
	Utility function to get a Scene by RegionID in a module More...

void	requestPayPrice (IClientAPI client, UUID objectID)

void	ClientClosed (UUID AgentID, Scene scene)
	When the client closes the connection we remove their accounting info from memory to free up resources. More...

void	EconomyDataRequestHandler (IClientAPI user)
	Event called Economy Data Request handler. More...

void	ClientClosed (IClientAPI client)
	Call this when the client disconnects. More...

int	GetBalance (UUID agentID)

bool	UploadCovered (UUID agentID, int amount)

bool	AmountCovered (UUID agentID, int amount)

void	ObjectBuy (IClientAPI remoteClient, UUID agentID, UUID sessionID, UUID groupID, UUID categoryID, uint localID, byte saleType, int salePrice)

void	MoveMoney (UUID fromAgentID, UUID toAgentID, int amount, string text)

Properties
int	UploadCharge `[get]`

int	GroupCreationCharge `[get]`

Type	ReplaceableInterface `[get]`

string	Name `[get]`

Properties inherited from OpenSim.Framework.IMoneyModule
int	UploadCharge `[get]`

int	GroupCreationCharge `[get]`

Properties inherited from OpenSim.Region.Framework.Interfaces.IRegionModuleBase
string	Name `[get]`

Type	ReplaceableInterface `[get]`
	If this returns non-null, it is the type of an interface that this module intends to register. This will cause the loader to defer loading of this module until all other modules have been loaded. If no other module has registered the interface by then, this module will be activated, else it will remain inactive, letting the other module take over. This should return non-null ONLY in modules that are intended to be easily replaceable, e.g. stub implementations that the developer expects to be replaced by third party provided modules. More...

Events
ObjectPaid	OnObjectPaid

Events inherited from OpenSim.Framework.IMoneyModule
ObjectPaid	OnObjectPaid

Detailed Description

This is only the functionality required to make the functionality associated with money work (such as land transfers). There is no money code here! Use FORGE as an example for money code. Demo Economy/Money Module. This is a purposely crippled module! // To land transfer you need to add: -helperuri http://serveraddress:port/ to the command line parameters you use to start up your client This commonly looks like -helperuri http://127.0.0.1:9000/

Definition at line 59 of file SampleMoneyModule.cs.

Member Function Documentation

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.AddRegion ( Scene scene )

inline

This is called whenever a Scene is added. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, after Initialise has been called.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 136 of file SampleMoneyModule.cs.

bool OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.AmountCovered	(	UUID	agentID,
		int	amount
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 787 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ApplyCharge	(	UUID	agentID,
		int	amount,
		MoneyTransactionType	type,
		string	extraData
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 196 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ApplyCharge	(	UUID	agentID,
		int	amount,
		MoneyTransactionType	type
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 200 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ApplyUploadCharge	(	UUID	agentID,
		int	amount,
		string	text
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 204 of file SampleMoneyModule.cs.

XmlRpcResponse OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.buy_func	(	XmlRpcRequest	request,
		IPEndPoint	remoteClient
	)

inline

Definition at line 483 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ClientClosed	(	UUID	AgentID,
		Scene	scene
	)

inline

When the client closes the connection we remove their accounting info from memory to free up resources.

Parameters

AgentID	UUID of agent
scene	Scene the agent was connected to.

OpenSim.Region.Framework.Scenes.EventManager.ClientClosed

Definition at line 690 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ClientClosed ( IClientAPI client )

inline

Call this when the client disconnects.

Parameters

client

Definition at line 758 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.Close ( )

inline

This is the inverse to Initialise. After a Close(), this instance won't be usable anymore.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 225 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.EconomyDataRequestHandler ( IClientAPI user )

inline

Event called Economy Data Request handler.

Parameters

agentId

Definition at line 699 of file SampleMoneyModule.cs.

Here is the call graph for this function:

int OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.GetBalance ( UUID agentID )

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 775 of file SampleMoneyModule.cs.

Scene OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.GetRandomScene ( )

inline

Utility function Gets a Random scene in the instance. For when which scene exactly you're doing something with doesn't matter

Returns

Definition at line 634 of file SampleMoneyModule.cs.

Scene OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.GetSceneByUUID ( UUID RegionID )

inline

Utility function to get a Scene by RegionID in a module

Parameters

RegionID

Returns

Definition at line 649 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.Initialise ( IConfigSource config )

inline

Called on startup so the module can be configured.

Parameters

config Configuration source.

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 124 of file SampleMoneyModule.cs.

XmlRpcResponse OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.landBuy_func	(	XmlRpcRequest	request,
		IPEndPoint	remoteClient
	)

inline

Definition at line 531 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.MoveMoney	(	UUID	fromAgentID,
		UUID	toAgentID,
		int	amount,
		string	text
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 847 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ObjectBuy	(	IClientAPI	remoteClient,
		UUID	agentID,
		UUID	sessionID,
		UUID	groupID,
		UUID	categoryID,
		uint	localID,
		byte	saleType,
		int	salePrice
	)

inline

Definition at line 794 of file SampleMoneyModule.cs.

bool OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ObjectGiveMoney	(	UUID	objectID,
		UUID	fromID,
		UUID	toID,
		int	amount,
		UUID	txn,
		out string	result
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 208 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.PostInitialise ( )

inline

This is called exactly once after all the shared region-modules have been instanciated and IRegionModuleBase.Initialised.

Implements OpenSim.Region.Framework.Interfaces.ISharedRegionModule.

Definition at line 221 of file SampleMoneyModule.cs.

XmlRpcResponse OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.preflightBuyLandPrep_func	(	XmlRpcRequest	request,
		IPEndPoint	remoteClient
	)

inline

Definition at line 496 of file SampleMoneyModule.cs.

XmlRpcResponse OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.quote_func	(	XmlRpcRequest	request,
		IPEndPoint	remoteClient
	)

inline

Definition at line 459 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.RegionLoaded ( Scene scene )

inline

This will be called once for every scene loaded. In a shared module this will be multiple times in one instance, while a nonshared module instance will only be called once. This method is called after AddRegion has been called in all modules for that scene, providing an opportunity to request another module's interface, or hook an event from another module.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 188 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.RemoveRegion ( Scene scene )

inline

This is called whenever a Scene is removed. For shared modules, this can happen several times. For non-shared modules, this happens exactly once, if the scene this instance is associated with is removed.

Parameters

scene A Scene

Implements OpenSim.Region.Framework.Interfaces.IRegionModuleBase.

Definition at line 184 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.requestPayPrice	(	IClientAPI	client,
		UUID	objectID
	)

inline

Definition at line 668 of file SampleMoneyModule.cs.

void OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.SendMoneyBalance	(	IClientAPI	client,
		UUID	agentID,
		UUID	SessionID,
		UUID	TransactionID
	)

inline

Sends the the stored money balance to the client

Parameters

client
agentID
SessionID
TransactionID

Definition at line 318 of file SampleMoneyModule.cs.

bool OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.UploadCovered	(	UUID	agentID,
		int	amount
	)

inline

Implements OpenSim.Framework.IMoneyModule.

Definition at line 783 of file SampleMoneyModule.cs.

XmlRpcResponse OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.UserAlert	(	XmlRpcRequest	request,
		IPEndPoint	remoteClient
	)

inline

XMLRPC handler to send alert message and sound to client

Definition at line 409 of file SampleMoneyModule.cs.

Property Documentation

int OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.GroupCreationCharge

get

Definition at line 116 of file SampleMoneyModule.cs.

string OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.Name

get

Definition at line 235 of file SampleMoneyModule.cs.

Type OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.ReplaceableInterface

get

Definition at line 230 of file SampleMoneyModule.cs.

int OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.UploadCharge

get

Definition at line 111 of file SampleMoneyModule.cs.

Event Documentation

ObjectPaid OpenSim.Region.OptionalModules.World.MoneyModule.SampleMoneyModule.OnObjectPaid

Definition at line 107 of file SampleMoneyModule.cs.

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

Region/OptionalModules/World/MoneyModule/SampleMoneyModule.cs

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation