OpenSim.Region.Framework.Interfaces.IEntityTransferModule Interface Reference

Inheritance diagram for OpenSim.Region.Framework.Interfaces.IEntityTransferModule:

Public Member Functions
void	Teleport (ScenePresence agent, ulong regionHandle, Vector3 position, Vector3 lookAt, uint teleportFlags)
	Teleport an agent within the same or to a different region. More...
bool	TeleportHome (UUID id, IClientAPI client)
	Teleports the agent for the given client to their home destination. More...
void	DoTeleport (ScenePresence sp, GridRegion reg, GridRegion finalDestination, Vector3 position, Vector3 lookAt, uint teleportFlags)
	Teleport an agent directly to a given region without checking whether the region should be substituted. More...
bool	IsInTransit (UUID id)
	Show whether the given agent is being teleported. More...
bool	Cross (ScenePresence agent, bool isFlying)
void	AgentArrivedAtDestination (UUID agent)
void	EnableChildAgents (ScenePresence agent)
void	EnableChildAgent (ScenePresence agent, GridRegion region)
GridRegion	GetDestination (Scene scene, UUID agentID, Vector3 pos, EntityTransferContext ctx, out Vector3 newpos, out string reason)
GridRegion	GetObjectDestination (SceneObjectGroup grp, Vector3 targetPosition, out Vector3 newpos)
bool	checkAgentAccessToRegion (ScenePresence agent, GridRegion destiny, Vector3 position, EntityTransferContext ctx, out string reason)
bool	CrossPrimGroupIntoNewRegion (GridRegion destination, Vector3 newPosition, SceneObjectGroup grp, bool silent, bool removeScripts)
ScenePresence	CrossAgentToNewRegionAsync (ScenePresence agent, Vector3 pos, GridRegion neighbourRegion, bool isFlying, EntityTransferContext ctx)
bool	HandleIncomingSceneObject (SceneObjectGroup so, Vector3 newPosition)

Detailed Description

Definition at line 41 of file IEntityTransferModule.cs.

Member Function Documentation

void OpenSim.Region.Framework.Interfaces.IEntityTransferModule.AgentArrivedAtDestination

(

UUID

agent

)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

bool OpenSim.Region.Framework.Interfaces.IEntityTransferModule.checkAgentAccessToRegion	(	ScenePresence	agent,
		GridRegion	destiny,
		Vector3	position,
		EntityTransferContext	ctx,
		out string	reason
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

bool OpenSim.Region.Framework.Interfaces.IEntityTransferModule.Cross	(	ScenePresence	agent,
		bool	isFlying
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

ScenePresence OpenSim.Region.Framework.Interfaces.IEntityTransferModule.CrossAgentToNewRegionAsync	(	ScenePresence	agent,
		Vector3	pos,
		GridRegion	neighbourRegion,
		bool	isFlying,
		EntityTransferContext	ctx
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

bool OpenSim.Region.Framework.Interfaces.IEntityTransferModule.CrossPrimGroupIntoNewRegion	(	GridRegion	destination,
		Vector3	newPosition,
		SceneObjectGroup	grp,
		bool	silent,
		bool	removeScripts
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

void OpenSim.Region.Framework.Interfaces.IEntityTransferModule.DoTeleport	(	ScenePresence	sp,
		GridRegion	reg,
		GridRegion	finalDestination,
		Vector3	position,
		Vector3	lookAt,
		uint	teleportFlags
	)

Teleport an agent directly to a given region without checking whether the region should be substituted.

Please use Teleport() instead unless you know exactly what you're doing. Do not use for same region teleports.

Parameters

sp
reg
finalDestination	/param> Parameters position lookAt teleportFlags

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

void OpenSim.Region.Framework.Interfaces.IEntityTransferModule.EnableChildAgent	(	ScenePresence	agent,
		GridRegion	region
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

void OpenSim.Region.Framework.Interfaces.IEntityTransferModule.EnableChildAgents

(

ScenePresence

agent

)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

GridRegion OpenSim.Region.Framework.Interfaces.IEntityTransferModule.GetDestination	(	Scene	scene,
		UUID	agentID,
		Vector3	pos,
		EntityTransferContext	ctx,
		out Vector3	newpos,
		out string	reason
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

GridRegion OpenSim.Region.Framework.Interfaces.IEntityTransferModule.GetObjectDestination	(	SceneObjectGroup	grp,
		Vector3	targetPosition,
		out Vector3	newpos
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

bool OpenSim.Region.Framework.Interfaces.IEntityTransferModule.HandleIncomingSceneObject	(	SceneObjectGroup	so,
		Vector3	newPosition
	)

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule, and OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.

bool OpenSim.Region.Framework.Interfaces.IEntityTransferModule.IsInTransit

(

UUID

id

)

Show whether the given agent is being teleported.

Parameters

id	The agent ID

Returns

true if the agent is in the process of being teleported, false otherwise.

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

void OpenSim.Region.Framework.Interfaces.IEntityTransferModule.Teleport	(	ScenePresence	agent,
		ulong	regionHandle,
		Vector3	position,
		Vector3	lookAt,
		uint	teleportFlags
	)

Teleport an agent within the same or to a different region.

Parameters

agent
regionHandle	The handle of the destination region. If it's the same as the region currently occupied by the agent then the teleport will be within that region.
agent
regionHandle
position
lookAt
teleportFlags

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule.

bool OpenSim.Region.Framework.Interfaces.IEntityTransferModule.TeleportHome	(	UUID	id,
		IClientAPI	client
	)

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

Parameters

id
client

Implemented in OpenSim.Region.CoreModules.Framework.EntityTransfer.EntityTransferModule, and OpenSim.Region.CoreModules.Framework.EntityTransfer.HGEntityTransferModule.

---

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

• Region/Framework/Interfaces/IEntityTransferModule.cs