SineSpace.Scripting.Types.SAvatar Class Reference

Inheritance diagram for SineSpace.Scripting.Types.SAvatar:

Public Member Functions
void	AttachTo (SGameObject target)
void	Detach ()
void	OnAvatarAttached (Action e)
	An event which fires whenever this avatar is attached to a game object in the current scene. More...
void	OnAvatarAttached (Closure e)
	An event which fires whenever this avatar is attached to a game object in the current scene. More...
void	OnAvatarDetached (Action e)
	An event which fires whenever this avatar is detached from a game object in the current scene. More...
void	OnAvatarDetached (Closure e)
	An event which fires whenever this avatar is detached from a game object in the current scene. More...
void	LoadOutfit (int outfitID)
	Only works on a white-label deployment due to abuse concerns. More...
void	ResetOutfit ()
	Only works on a white-label deployment due to abuse concerns. More...
void	Register (string username, string password, string email, bool subscribeToSinespaceNewsletter=false, Closure onSuccess=null, Closure onError=null)
	Only works on white label grids, allows a guest to register. More...
void	ResetOutfitToTemplate (int outfitID)
SGameObject	FindBone (string bone)
void	Teleport (string landmarkName)
void	Teleport (SVector position)
void	Teleport (SVector position, SQuaternion rotation)
void	Teleport (int region, SVector position, SQuaternion rotation)
void	Teleport (int region)
void	SetIKGoal (string goal, bool positionGoal, float positionStrength, SVector positionTarget, bool rotationGoal, float rotationStrength, SQuaternion rotationTarget)
void	ClearIKGoal (string goal)
void	PlayCustomAnimation (SResource animationClip)
void	StopCustomAnimation ()
void	OnAvatarReload (Closure o)
void	OnAvatarReload (Action callback)
void	SynchroniseState ()
void	StartFly ()
void	EndFly ()
void	OnAvatarSkeletonReload (Closure o)
void	OnAvatarSkeletonReload (Action callback)
double	TeleportToNextEvent (long withinSeconds=600)

Properties
string	Username [get]
string	DisplayName [get]
string	Title [get]
string	OrgTitle [get]
string	OrgName [get]
long	ID [get]
bool	IsAttached [get]
float	MovementSpeed [get, set]
float	JumpHeight [get, set]
bool	Guest [get]
long	OutfitID [get]
bool	Loaded [get]
string	Gender [get]
SGameObject	LockObject [get]
SGameObject	Skeleton [get]
bool	BlockMovement [get, set]
bool	BlockRun [get, set]
bool	BlockFly [get, set]
bool	BlockCrouch [get, set]
bool	BlockJump [get, set]
bool	IsGrounded [get]
bool	IsBot [get]
Properties inherited from ScriptClassComponent< AvatarComponentBaseInternal >
SGameObject	GameObject [get]
	Return the GameObject which component added. More...

Member Function Documentation

AttachTo()

void SineSpace.Scripting.Types.SAvatar.AttachTo

(

SGameObject

target

)

ClearIKGoal()

void SineSpace.Scripting.Types.SAvatar.ClearIKGoal

(

string

goal

)

Detach()

void SineSpace.Scripting.Types.SAvatar.Detach

(

)

EndFly()

void SineSpace.Scripting.Types.SAvatar.EndFly

(

)

FindBone()

SGameObject SineSpace.Scripting.Types.SAvatar.FindBone

(

string

bone

)

LoadOutfit()

void SineSpace.Scripting.Types.SAvatar.LoadOutfit

(

int

outfitID

)

Only works on a white-label deployment due to abuse concerns.

Parameters

outfitID

A valid outfit ID

OnAvatarAttached() [1/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarAttached

(

Action

e

)

An event which fires whenever this avatar is attached to a game object in the current scene.

Parameters

e	A valid event handler delegate

OnAvatarAttached() [2/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarAttached

(

Closure

e

)

An event which fires whenever this avatar is attached to a game object in the current scene.

Parameters

e	A valid event handler delegate

Space.Scene.PlayerAvatar.OnAvatarAttached(function ()
    Space.Log("You got attached to "..Space.Scene.PlayerAvatar.LockObject.Name.."!")
end)

OnAvatarDetached() [1/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarDetached

(

Action

e

)

An event which fires whenever this avatar is detached from a game object in the current scene.

Parameters

e	A valid event handler delegate

OnAvatarDetached() [2/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarDetached

(

Closure

e

)

An event which fires whenever this avatar is detached from a game object in the current scene.

Parameters

e	A valid event handler delegate

Space.Scene.PlayerAvatar.OnAvatarDetached(function ()
    Space.Log("You got detached from something!")
end)

OnAvatarReload() [1/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarReload

(

Action

callback

)

OnAvatarReload() [2/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarReload

(

Closure

o

)

OnAvatarSkeletonReload() [1/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarSkeletonReload

(

Action

callback

)

OnAvatarSkeletonReload() [2/2]

void SineSpace.Scripting.Types.SAvatar.OnAvatarSkeletonReload

(

Closure

o

)

PlayCustomAnimation()

void SineSpace.Scripting.Types.SAvatar.PlayCustomAnimation

(

SResource

animationClip

)

Register()

void SineSpace.Scripting.Types.SAvatar.Register	(	string	username,
		string	password,
		string	email,
		bool	subscribeToSinespaceNewsletter = false,
		Closure	onSuccess = null,
		Closure	onError = null
	)

Only works on white label grids, allows a guest to register.

ResetOutfit()

void SineSpace.Scripting.Types.SAvatar.ResetOutfit

(

)

Only works on a white-label deployment due to abuse concerns.

ResetOutfitToTemplate()

void SineSpace.Scripting.Types.SAvatar.ResetOutfitToTemplate

(

int

outfitID

)

SetIKGoal()

void SineSpace.Scripting.Types.SAvatar.SetIKGoal	(	string	goal,
		bool	positionGoal,
		float	positionStrength,
		SVector	positionTarget,
		bool	rotationGoal,
		float	rotationStrength,
		SQuaternion	rotationTarget
	)

StartFly()

void SineSpace.Scripting.Types.SAvatar.StartFly

(

)

StopCustomAnimation()

void SineSpace.Scripting.Types.SAvatar.StopCustomAnimation

(

)

SynchroniseState()

void SineSpace.Scripting.Types.SAvatar.SynchroniseState

(

)

Teleport() [1/5]

void SineSpace.Scripting.Types.SAvatar.Teleport

(

int

region

)

Teleport() [2/5]

void SineSpace.Scripting.Types.SAvatar.Teleport	(	int	region,
		SVector	position,
		SQuaternion	rotation
	)

Teleport() [3/5]

void SineSpace.Scripting.Types.SAvatar.Teleport

(

string

landmarkName

)

Teleport() [4/5]

void SineSpace.Scripting.Types.SAvatar.Teleport

(

SVector

position

)

Teleport() [5/5]

void SineSpace.Scripting.Types.SAvatar.Teleport	(	SVector	position,
		SQuaternion	rotation
	)

TeleportToNextEvent()

double SineSpace.Scripting.Types.SAvatar.TeleportToNextEvent

(

long

withinSeconds = 600

)

Property Documentation

BlockCrouch

bool SineSpace.Scripting.Types.SAvatar.BlockCrouch

getset

BlockFly

bool SineSpace.Scripting.Types.SAvatar.BlockFly

getset

BlockJump

bool SineSpace.Scripting.Types.SAvatar.BlockJump

getset

BlockMovement

bool SineSpace.Scripting.Types.SAvatar.BlockMovement

getset

BlockRun

bool SineSpace.Scripting.Types.SAvatar.BlockRun

getset

DisplayName

string SineSpace.Scripting.Types.SAvatar.DisplayName

get

Gender

string SineSpace.Scripting.Types.SAvatar.Gender

get

Guest

bool SineSpace.Scripting.Types.SAvatar.Guest

get

ID

long SineSpace.Scripting.Types.SAvatar.ID

get

IsAttached

bool SineSpace.Scripting.Types.SAvatar.IsAttached

get

IsBot

bool SineSpace.Scripting.Types.SAvatar.IsBot

get

IsGrounded

bool SineSpace.Scripting.Types.SAvatar.IsGrounded

get

JumpHeight

float SineSpace.Scripting.Types.SAvatar.JumpHeight

getset

Loaded

bool SineSpace.Scripting.Types.SAvatar.Loaded

get

LockObject

SGameObject SineSpace.Scripting.Types.SAvatar.LockObject

get

MovementSpeed

float SineSpace.Scripting.Types.SAvatar.MovementSpeed

getset

OrgName

string SineSpace.Scripting.Types.SAvatar.OrgName

get

OrgTitle

string SineSpace.Scripting.Types.SAvatar.OrgTitle

get

OutfitID

long SineSpace.Scripting.Types.SAvatar.OutfitID

get

Skeleton

SGameObject SineSpace.Scripting.Types.SAvatar.Skeleton

get

Title

string SineSpace.Scripting.Types.SAvatar.Title

get

Username

string SineSpace.Scripting.Types.SAvatar.Username

get