Sinespace Client  2023.2.17543
Client-side scripting for Sinespace
SineSpace.Scripting.Scene.SActivity Class Reference
Inheritance diagram for SineSpace.Scripting.Scene.SActivity:
ScriptClass< T > ScriptClassWrapper< T >

Public Member Functions

override void Initialise (SScript runtime, object wrapper)
 
void StartActivity (int activityID)
 Start an activity with its id. More...
 
void RequestLeaderboard (int activityID, Closure results)
 Get the leader board of an activity. More...
 
void RequestLeaderboard (int activityID, Action< SScore[]> results)
 
void FinishActivity (int activityId, float score, int xp=0, Closure results=null)
 Start an activity with its id. More...
 
- Public Member Functions inherited from ScriptClass< T >
void ReportError (string error, bool fatal, UnityEngine.Object target=null)
 
- Public Member Functions inherited from ScriptClassWrapper< T >
override void Initialise (SScript runtime, object wrapper)
 

Additional Inherited Members

- Protected Member Functions inherited from ScriptClass< T >
void Initialise (SScript runtime)
 
- Properties inherited from ScriptClass< T >
override bool Alive [get]
 Return if the component is alive. More...
 
virtual bool Alive [get]
 
DynValue CachedData [get, set]
 
- Properties inherited from ScriptClassWrapper< T >
_wrap [get]
 

Member Function Documentation

◆ FinishActivity()

void SineSpace.Scripting.Scene.SActivity.FinishActivity ( int  activityId,
float  score,
int  xp = 0,
Closure  results = null 
)

Start an activity with its id.

Parameters
activityIdThe id of the activity.
scoreThe score of current activity.
xpxp.
resultsThe closure you want to call after complete this function. Will /// returns a SScoreRank value.
Space.Activity.FinishActivity(99956,100,0,function (rank)
Space.Log(rank.Level)
end)
&ndash;If the activity exists, it will display ScoreRank info.

◆ Initialise()

override void SineSpace.Scripting.Scene.SActivity.Initialise ( SScript  runtime,
object  wrapper 
)
virtual

Implements ScriptClass< T >.

◆ RequestLeaderboard() [1/2]

void SineSpace.Scripting.Scene.SActivity.RequestLeaderboard ( int  activityID,
Action< SScore[]>  results 
)

◆ RequestLeaderboard() [2/2]

void SineSpace.Scripting.Scene.SActivity.RequestLeaderboard ( int  activityID,
Closure  results 
)

Get the leader board of an activity.

Parameters
activityIDThe id of the activity.
resultsThe closure you want to call after complete this function. Will /// returns an array of SScore.
Space.Activity.RequestLeaderboard(99956,function (res)
for i=1,#res do
Space.Log(res[i].Rank.." Score "..res[i].Score.." Username "..res[i].Username)
end
end)
&ndash;If the activity exists, it will display Score info.

◆ StartActivity()

void SineSpace.Scripting.Scene.SActivity.StartActivity ( int  activityID)

Start an activity with its id.

Parameters
activityIDThe id of the activity.
Space.Activity.StartActivity(99956)
&ndash;If the activity exists, it will start.