SineSpace.Scripting.Components.SSeat Class Reference

Inheritance diagram for SineSpace.Scripting.Components.SSeat:

Public Member Functions
void	SitPlayer ()
	Make a player sit.
void	UnseatPlayer ()
	Make a player unseat.
void	OnStandUp (Closure e)
void	OnSit (Closure e)
void	OnPlayerStandUp (Closure e)
void	OnPlayerSit (Closure e)
Public Member Functions inherited from ScriptClassWrapper< T >
override void	Initialise (SScript runtime, object wrapper)
Public Member Functions inherited from ScriptClass
void	ReportError (string error, bool fatal, UnityEngine.Object target=null)
void	Initialise (SScript runtime, object wrapper)

Properties
bool	Enabled [get, set]
	Whether the seat component is enabled or not.
bool	InUse [get]
	Return that whether the seat is in use.
long	PlayerSeated [get]
	Return the ID of the seating player.
bool	UseSlotID [get, set]
	Return true if uses SlotID.
string	SlotID [get, set]
	Return the slotID of the seat.
SCollider	ClickableCollider [get, set]
	Return the clickable collider.
SResource	Animation [get, set]
	Return the animation.
SResource	AnimationMale [get, set]
	Return the male animation.
SResource	AnimationFemale [get, set]
	Return the female animation.
Properties inherited from ScriptClassComponent< T >
SGameObject	GameObject [get]
	Return the GameObject which component added.
Properties inherited from ScriptClass< T >
override bool	Alive [get]
	Return if the component is alive.
Properties inherited from ScriptClassWrapper< T >
T	_wrap [get]
Properties inherited from ScriptClass
virtual bool	Alive [get]
DynValue	CachedData [get, set]

Additional Inherited Members
Protected Member Functions inherited from ScriptClass
void	Initialise (SScript runtime)

Member Function Documentation

OnPlayerSit()

void SineSpace.Scripting.Components.SSeat.OnPlayerSit

(

Closure

e

)

OnPlayerStandUp()

void SineSpace.Scripting.Components.SSeat.OnPlayerStandUp

(

Closure

e

)

OnSit()

void SineSpace.Scripting.Components.SSeat.OnSit

(

Closure

e

)

OnStandUp()

void SineSpace.Scripting.Components.SSeat.OnStandUp

(

Closure

e

)

SitPlayer()

void SineSpace.Scripting.Components.SSeat.SitPlayer

(

)

Make a player sit.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function Seat()
    seat.SitPlayer()
end 
–print "Unable to seat player avatar; seat CanClick is false."

UnseatPlayer()

void SineSpace.Scripting.Components.SSeat.UnseatPlayer

(

)

Make a player unseat.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function UnSeat()
    seat.UnseatPlayer()
end 
–print current avatar is: 0 

Property Documentation

Animation

SResource SineSpace.Scripting.Components.SSeat.Animation

getset

Return the animation.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
local animation=seat.Animation
Space.Log(animation.Name) 
–print the name of animation.

AnimationFemale

SResource SineSpace.Scripting.Components.SSeat.AnimationFemale

getset

Return the female animation.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
local animation=seat.AnimationFemale
Space.Log(animation.Name) 
–print the name of animation

AnimationMale

SResource SineSpace.Scripting.Components.SSeat.AnimationMale

getset

Return the male animation.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
local animation=seat.AnimationMale
Space.Log(animation.Name) 
–print the name of animation

ClickableCollider

SCollider SineSpace.Scripting.Components.SSeat.ClickableCollider

getset

Return the clickable collider.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function ClickableCollider()
    local clickcoll=seat.ClickableCollider
    Space.Log(clickcoll.Enabled)
end

Enabled

bool SineSpace.Scripting.Components.SSeat.Enabled

getset

Whether the seat component is enabled or not.

local seat=thisObject.seat
Space.Log(seat.Enabled)

InUse

bool SineSpace.Scripting.Components.SSeat.InUse

get

Return that whether the seat is in use.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function InUse()
    local inUse=seat.InUse
    Space.Log(inUse)
end

PlayerSeated

long SineSpace.Scripting.Components.SSeat.PlayerSeated

get

Return the ID of the seating player.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function PlaySeated ()
    local playSeated=seat.PlayerSeated
    Space.Log(playSeated)
end

SlotID

string SineSpace.Scripting.Components.SSeat.SlotID

getset

Return the slotID of the seat.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function SlotID ()
    local slotID=seat.SlotID
    Space.Log(slotID)
end

UseSlotID

bool SineSpace.Scripting.Components.SSeat.UseSlotID

getset

Return true if uses SlotID.

local thisObject=Space.Host.ExecutingObject
local seat=thisObject.Children[0].Seat
function UseSlotID ()
    local useSlotID=seat.UseSlotID
    Space.Log(useSlotID) 
end