OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule Class Reference
Inheritance diagram for OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule:
Collaboration graph
[legend]

Public Member Functions

override void Initialise (IConfigSource source)
 This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created. More...
 
override 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...
 
override 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...
 
override 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...
 
override void TriggerTeleportHome (UUID id, IClientAPI client)
 
override bool TeleportHome (UUID id, IClientAPI client)
 Teleports the agent for the given client to their home destination. More...
 
override void RequestTeleportLandmark (IClientAPI remoteClient, AssetLandmark lm)
 Tries to teleport agent to landmark. More...
 
override bool HandleIncomingSceneObject (SceneObjectGroup so, Vector3 newPosition)
 
bool VerifyClient (AgentCircuitData aCircuit, string token)
 
- Public Member Functions inherited from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule
virtual void PostInitialise ()
 
virtual void Close ()
 This is the inverse to Initialise. After a Close(), this instance won't be usable anymore. More...
 
void Teleport (ScenePresence sp, ulong regionHandle, Vector3 position, Vector3 lookAt, uint teleportFlags)
 Teleport an agent within the same or to a different region. More...
 
void DoTeleport (ScenePresence sp, GridRegion reg, GridRegion finalDestination, Vector3 position, Vector3 lookAt, uint teleportFlags)
 Wraps DoTeleportInternal() and manages the transfer state. More...
 
bool checkAgentAccessToRegion (ScenePresence agent, GridRegion destiny, Vector3 position, EntityTransferContext ctx, out string reason)
 
GridRegion GetDestination (Scene scene, UUID agentID, Vector3 pos, EntityTransferContext ctx, out Vector3 newpos)
 
GridRegion GetDestination (Scene scene, UUID agentID, Vector3 pos, EntityTransferContext ctx, out Vector3 newpos, out string failureReason)
 
bool Cross (ScenePresence agent, bool isFlying)
 
ScenePresence CrossAsync (ScenePresence agent, bool isFlying)
 
delegate void InformClientToInitiateTeleportToLocationDelegate (ScenePresence agent, uint regionX, uint regionY, Vector3 position, Scene initiatingScene)
 
void InformClientToInitiateTeleportToLocationAsync (ScenePresence agent, uint regionX, uint regionY, Vector3 position, Scene initiatingScene)
 
bool CrossAgentToNewRegionPrep (ScenePresence agent, GridRegion neighbourRegion)
 
ScenePresence CrossAgentToNewRegionAsync (ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, EntityTransferContext ctx)
 This Closes child agents on neighbouring regions Calls an asynchronous method to do so.. so it doesn't lag the sim. More...
 
bool CrossAgentIntoNewRegionMain (ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, EntityTransferContext ctx)
 
void CrossAgentToNewRegionPost (ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, EntityTransferContext ctx)
 
void EnableChildAgent (ScenePresence sp, GridRegion region)
 This informs a single neighbouring region about agent "avatar", and avatar about it Calls an asynchronous method to do so.. so it doesn't lag the sim. More...
 
void EnableChildAgents (ScenePresence sp)
 This informs all neighbouring regions about agent "avatar". and as important informs the avatar about then More...
 
GridRegion GetRegionContainingWorldLocation (IGridService pGridService, UUID pScopeID, double px, double py)
 
GridRegion GetRegionContainingWorldLocation (IGridService pGridService, UUID pScopeID, double px, double py, uint pSizeHint)
 
void AgentArrivedAtDestination (UUID id)
 
GridRegion GetObjectDestination (SceneObjectGroup grp, Vector3 targetPosition, out Vector3 newpos)
 
bool CrossPrimGroupIntoNewRegion (GridRegion destination, Vector3 newPosition, SceneObjectGroup grp, bool silent, bool removeScripts)
 Move the given scene object into a new region More...
 
bool IsInTransit (UUID id)
 Show whether the given agent is being teleported. More...
 

Protected Member Functions

override void OnNewClient (IClientAPI client)
 
override GridRegion GetFinalDestination (GridRegion region, UUID agentID, string agentHomeURI, out string message)
 
override bool NeedsClosing (GridRegion reg, bool OutViewRange)
 
override void AgentHasMovedAway (ScenePresence sp, bool logout)
 Clean up operations once an agent has moved away through cross or teleport. More...
 
override bool CreateAgent (ScenePresence sp, GridRegion reg, GridRegion finalDestination, AgentCircuitData agentCircuit, uint teleportFlags, EntityTransferContext ctx, out string reason, out bool logout)
 
override bool ValidateGenericConditions (ScenePresence sp, GridRegion reg, GridRegion finalDestination, uint teleportFlags, out string reason)
 
- Protected Member Functions inherited from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule
virtual void InitialiseCommon (IConfigSource source)
 Initialize config common for this module and any descendents. More...
 
virtual void CleanupFailedInterRegionTeleport (ScenePresence sp, string auth_token, GridRegion finalDestination)
 Clean up an inter-region teleport that did not complete, either because of simulator failure or cancellation. More...
 
virtual void Fail (ScenePresence sp, GridRegion finalDestination, bool logout, string auth_code, string reason)
 Signal that the inter-region teleport failed and perform cleanup. More...
 
virtual bool UpdateAgent (GridRegion reg, GridRegion finalDestination, AgentData agent, ScenePresence sp, EntityTransferContext ctx)
 
virtual void SetCallbackURL (AgentData agent, RegionInfo region)
 
void KillEntity (Scene scene, uint localID)
 
virtual bool NeedsNewAgent (float viewdist, uint oldRegionX, uint newRegionX, uint oldRegionY, uint newRegionY, int oldsizeX, int oldsizeY, int newsizeX, int newsizeY)
 
List< GridRegionGetNeighbors (ScenePresence avatar, uint pRegionLocX, uint pRegionLocY)
 Return the list of online regions that are considered to be neighbours to the given scene. More...
 
void CrossAttachmentsIntoNewRegion (GridRegion destination, ScenePresence sp, bool silent)
 Cross the attachments for an avatar into the destination region. More...
 
void ReInstantiateScripts (ScenePresence sp)
 

Protected Attributes

bool m_RestrictAppearanceAbroad
 
string m_AccountName
 
List< AvatarAppearancem_ExportedAppearances
 
List< AvatarAttachmentm_Attachs
 
- Protected Attributes inherited from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule
string m_ThisHomeURI
 
string m_GatekeeperURI
 
bool m_Enabled = false
 

Properties

List< AvatarAppearanceExportedAppearance [get]
 
override string Name [get]
 
- Properties inherited from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule
int MaxTransferDistance [get, set]
 The maximum distance, in standard region units (256m) that an agent is allowed to transfer. More...
 
bool WaitForAgentArrivedAtDestination [get, set]
 If true then on a teleport, the source region waits for a callback from the destination region. If a callback fails to arrive within a set time then the user is pulled back into the source region. More...
 
bool DisableInterRegionTeleportCancellation [get, set]
 If true then we ask the viewer to disable teleport cancellation and ignore teleport requests. More...
 
Scene Scene [get, set]
 
Type ReplaceableInterface [get]
 
virtual string Name [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...
 

Additional Inherited Members

- Public Attributes inherited from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule
const int DefaultMaxTransferDistance = 4095
 
const bool WaitForAgentArrivedAtDestinationDefault = true
 

Detailed Description

Definition at line 51 of file HGEntityTransferModule.cs.

Member Function Documentation

override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.AddRegion ( Scene  scene)
inlinevirtual

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
sceneA Scene

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 155 of file HGEntityTransferModule.cs.

override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.AgentHasMovedAway ( ScenePresence  sp,
bool  logout 
)
inlineprotectedvirtual

Clean up operations once an agent has moved away through cross or teleport.

Parameters
sp
logout

now just a HG hook

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 254 of file HGEntityTransferModule.cs.

override bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.CreateAgent ( ScenePresence  sp,
GridRegion  reg,
GridRegion  finalDestination,
AgentCircuitData  agentCircuit,
uint  teleportFlags,
EntityTransferContext  ctx,
out string  reason,
out bool  logout 
)
inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 266 of file HGEntityTransferModule.cs.

Here is the call graph for this function:

override GridRegion OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.GetFinalDestination ( GridRegion  region,
UUID  agentID,
string  agentHomeURI,
out string  message 
)
inlineprotectedvirtual
override bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.HandleIncomingSceneObject ( SceneObjectGroup  so,
Vector3  newPosition 
)
inlinevirtual

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 591 of file HGEntityTransferModule.cs.

Here is the call graph for this function:

override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.Initialise ( IConfigSource  source)
inlinevirtual

This is called to initialize the region module. For shared modules, this is called exactly once, after creating the single (shared) instance. For non-shared modules, this is called once on each instance, after the instace for the region has been created.

Parameters
sourceA IConfigSource

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 126 of file HGEntityTransferModule.cs.

override bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.NeedsClosing ( GridRegion  reg,
bool  OutViewRange 
)
inlineprotectedvirtual
override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.OnNewClient ( IClientAPI  client)
inlineprotectedvirtual
override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.RegionLoaded ( Scene  scene)
inlinevirtual

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
sceneA Scene

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 193 of file HGEntityTransferModule.cs.

override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.RemoveRegion ( Scene  scene)
inlinevirtual

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
sceneA Scene

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 207 of file HGEntityTransferModule.cs.

override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.RequestTeleportLandmark ( IClientAPI  remoteClient,
AssetLandmark  lm 
)
inlinevirtual

Tries to teleport agent to landmark.

Parameters
remoteClient
regionHandle
position

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 505 of file HGEntityTransferModule.cs.

override bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.TeleportHome ( UUID  id,
IClientAPI  client 
)
inlinevirtual

Teleports the agent for the given client to their home destination.

Parameters
id
client

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 438 of file HGEntityTransferModule.cs.

override void OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.TriggerTeleportHome ( UUID  id,
IClientAPI  client 
)
inlinevirtual
override bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.ValidateGenericConditions ( ScenePresence  sp,
GridRegion  reg,
GridRegion  finalDestination,
uint  teleportFlags,
out string  reason 
)
inlineprotectedvirtual

Reimplemented from OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

Definition at line 319 of file HGEntityTransferModule.cs.

Here is the call graph for this function:

bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.VerifyClient ( AgentCircuitData  aCircuit,
string  token 
)
inline

Member Data Documentation

string OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.m_AccountName
protected

Definition at line 62 of file HGEntityTransferModule.cs.

List<AvatarAttachment> OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.m_Attachs
protected

Definition at line 64 of file HGEntityTransferModule.cs.

List<AvatarAppearance> OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.m_ExportedAppearances
protected

Definition at line 63 of file HGEntityTransferModule.cs.

bool OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.m_RestrictAppearanceAbroad
protected

Definition at line 61 of file HGEntityTransferModule.cs.

Property Documentation

List<AvatarAppearance> OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.ExportedAppearance
getprotected

Definition at line 67 of file HGEntityTransferModule.cs.

override string OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.Name
get

Definition at line 122 of file HGEntityTransferModule.cs.


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