Sinespace Client
2023.2.17543
Client-side scripting for Sinespace
|
Public Member Functions | |
SScene (SScript script) | |
SGameObject | Find (string name) |
Find a GameObject by name and returns it. More... | |
SGameObject | FindID (string id) |
Find a GameObject by id in Scene Object Database and returns it. More... | |
void | MarkObjectTemporary (SGameObject obj) |
Mark a GameObject as temporary. More... | |
SAvatar | GetAvatar (long id) |
Return an avatar with id More... | |
SAvatar | GetAvatar (string name) |
Return an avatar with Name More... | |
SGameObject | CreateGameObject (string name) |
Create a GameObject with name. More... | |
SGameObject | CreateGameObject (SResource resource) |
Create a GameObject with Resources. More... | |
void | SwitchToInstance (uint id) |
Switch to a shard region of current region with its id. More... | |
void | OnPlayerJoin (Action< SAvatar > e) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar More... | |
void | OnPlayerJoin (Closure e) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar More... | |
void | OnPlayerLeave (Action< long > e) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar More... | |
void | OnPlayerLeave (Closure e) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar More... | |
void | OnEditModeStart (Closure e) |
An event which fires whenever enter the edit mode. More... | |
void | OnEditModeEnd (Closure e) |
An event which fires whenever leave the edit mode. More... | |
void | OnEditModeAdd (Closure e) |
void | OnEditModeRemove (Closure e) |
Properties | |
SAvatar | PlayerAvatar [get] |
Return current PlayerAvatar More... | |
SAvatar[] | Avatars [get] |
Return all avatars in the scene (except self) More... | |
List< SAvatar > | AllAvatars [get] |
Return all avatars in the scene More... | |
int | Population [get] |
Return the total number of avatars currently in the scene. More... | |
SGameObject[] | Objects [get] |
Returns all objects in the scene More... | |
string | Name [get] |
Return the name of current region. More... | |
string | Url [get] |
Return the Url of current region. More... | |
long | RegionID [get] |
Return the RegionID of current region. More... | |
long | InstanceID [get] |
Return the InstanceID of current region. More... | |
long | Owner [get] |
Returns the OwnerID of current region. More... | |
bool | PlayerIsOwner [get] |
Return true if current player is the region owner. More... | |
bool | PlayerIsAdmin [get] |
Return true if current player is the region admin. More... | |
bool | PlayerIsModerator [get] |
Return true if the current player is Moderator. More... | |
bool | PlayerIsDeveloper [get] |
bool | PlayerIsTrusted [get] |
Return true if the current player is Trusted. More... | |
bool | IsInEditMode [get] |
Return true if the current player is in edit mode. More... | |
SGameObject[] | Floors [get] |
Return an array of all floors in the region More... | |
SLandmark[] | Landmarks [get] |
SineSpace.Scripting.Scene.SScene.SScene | ( | SScript | script | ) |
SGameObject SineSpace.Scripting.Scene.SScene.CreateGameObject | ( | SResource | resource | ) |
Create a GameObject with Resources.
resource | The resource GameObject of created GameObject |
SGameObject SineSpace.Scripting.Scene.SScene.CreateGameObject | ( | string | name | ) |
Create a GameObject with name.
name | The name of created GameObject |
SGameObject SineSpace.Scripting.Scene.SScene.Find | ( | string | name | ) |
Find a GameObject by name and returns it.
name | The name of the GameObject. |
SGameObject SineSpace.Scripting.Scene.SScene.FindID | ( | string | id | ) |
Find a GameObject by id in Scene Object Database and returns it.
id | The id of the GameObject in the database |
SAvatar SineSpace.Scripting.Scene.SScene.GetAvatar | ( | long | id | ) |
Return an avatar with id
id | The id of avatar |
SAvatar SineSpace.Scripting.Scene.SScene.GetAvatar | ( | string | name | ) |
Return an avatar with Name
name | The name of avatar |
void SineSpace.Scripting.Scene.SScene.MarkObjectTemporary | ( | SGameObject | obj | ) |
Mark a GameObject as temporary.
obj | The GameObject you want to mark |
void SineSpace.Scripting.Scene.SScene.OnEditModeAdd | ( | Closure | e | ) |
void SineSpace.Scripting.Scene.SScene.OnEditModeEnd | ( | Closure | e | ) |
An event which fires whenever leave the edit mode.
e | A valid event handler delegate |
void SineSpace.Scripting.Scene.SScene.OnEditModeRemove | ( | Closure | e | ) |
void SineSpace.Scripting.Scene.SScene.OnEditModeStart | ( | Closure | e | ) |
An event which fires whenever enter the edit mode.
e | A valid event handler delegate |
void SineSpace.Scripting.Scene.SScene.OnPlayerJoin | ( | Action< SAvatar > | e | ) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar
e | A valid event handler delegate |
void SineSpace.Scripting.Scene.SScene.OnPlayerJoin | ( | Closure | e | ) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar
e | A valid event handler delegate |
void SineSpace.Scripting.Scene.SScene.OnPlayerLeave | ( | Action< long > | e | ) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar
e | A valid event handler delegate |
void SineSpace.Scripting.Scene.SScene.OnPlayerLeave | ( | Closure | e | ) |
An event which fires whenever a new avatar joins the scene, first argument is the avatar
e | A valid event handler delegate |
void SineSpace.Scripting.Scene.SScene.SwitchToInstance | ( | uint | id | ) |
Switch to a shard region of current region with its id.
id | The shard region id |
|
get |
Return all avatars in the scene
|
get |
Return all avatars in the scene (except self)
|
get |
Return an array of all floors in the region
|
get |
Return the InstanceID of current region.
|
get |
Return true if the current player is in edit mode.
|
get |
|
get |
Return the name of current region.
|
get |
Returns all objects in the scene
|
get |
Returns the OwnerID of current region.
|
get |
Return current PlayerAvatar
|
get |
Return true if current player is the region admin.
|
get |
|
get |
Return true if the current player is Moderator.
|
get |
Return true if current player is the region owner.
|
get |
Return true if the current player is Trusted.
|
get |
Return the total number of avatars currently in the scene.
|
get |
Return the RegionID of current region.
|
get |
Return the Url of current region.