Difference between revisions of "Scripting/SScene"

 hand = Space.Scene.Find("Hand");
--This returns the GameObject named Hand.

hand = Space.Scene.Find("/Hand");
--This returns the GameObject named Hand.
--Hand must not have a parent in the Hierarchy view.

hand = Space.Scene.Find("/Monster/Arm/Hand");
--This returns the GameObject named Hand,
--which is a child of Arm > Monster.
--Monster must not have a parent in the Hierarchy view.

hand = Space.Scene.Find("Monster/Arm/Hand");
--This returns the GameObject named Hand,
--which is a child of Arm > Monster. 

local obj=Space.Scene.FindID("123")
Space.Log(obj.Name);
mat.SetColor("_Color",Color.New(0,0,1,1))

Space.Scene.OnEditModeAdd(AFunctionName)

--prints the total number of objects in the scene whenever a new object is added in edit mode

  function OnEditModeFunction()
   Space.Log(#Space.Scene.Objects)
  end


  Space.Scene.OnEditModeAdd(OnEditModeFunction)

Space.Scene.OnEditModeRemove(AFunctionName)

--prints the total number of objects in the scene whenever a new object is removed in edit mode

  function OnEditModeFunction()
   Space.Log(#Space.Scene.Objects)
  end


  Space.Scene.OnEditModeRemove(OnEditModeFunction)

--makes an object become active upon exiting edit mode
thisObject = Space.Host.ExecutingObject
targetObject = Space.Host.GetReference("target") --add to references in Scripting Runtime component

function OnEditModeFunction()
  targetObject.Active = false
end


Space.Scene.OnEditModeEnd(OnEditModeFunction)

--makes an object become active upon entering edit mode
thisObject = Space.Host.ExecutingObject
targetObject = Space.Host.GetReference("target") --add to references in Scripting Runtime component

function OnEditModeFunction()
  targetObject.Active = true
end


Space.Scene.OnEditModeStart(OnEditModeFunction)

newObject = Space.Scene.CreateGameObject("potato")

--clicking this object will create an empty GameObject and place it above our avatar

  thisObject = Space.Host.ExecutingObject
  thisPlayer = Space.Scene.PlayerAvatar


  OnClick = function()
    createdObject = Space.Scene.CreateGameObject("potato")   
    createdObject.WorldPosition = thisPlayer.GameObject.WorldPosition + thisPlayer.GameObject.Up
  end

  thisObject.AddClickable()
  thisObject.Clickable.OnClick(OnClick)

res = Space.GetResource("Tomato") 
--declare it as resource in your Scripting Runtime component
Space.Scene.CreateGameObject(res)
 

--clicking this object will create a GameObject from a resource and place it above our avatar

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

resource = Space.GetResource("Tomato")  --add it as resource in your Scripting Runtime component

OnClick = function()
createdObject = Space.Scene.CreateGameObject(resource)    
createdObject.WorldPosition = thisPlayer.GameObject.WorldPosition + thisPlayer.GameObject.Up
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--Place this script in a UIText object and it will
--update itself with the name of the last player joined

function updateText(Av) --we include "Av" here because the event gives us a reference to the Avatar that joined
Space.Host.ExecutingObject.UIText.Text= "Last player joined: " .. Av.Username
end

Space.Scene.OnPlayerJoin(updateText) -- updateText will now be called everytime a player joins

 function playerLeft(id) 
--
end
Space.Scene.OnPlayerLeave(playerLeft) 

--Place this script in a UIText object and it will
--update itself with the name of the last player left

function updateText(Av) --we include "Av" here because the event gives us a reference to the Avatar that has left
Space.Host.ExecutingObject.UIText.Text= "Last player left: " .. Av.Username
end

Space.Scene.OnPlayerLeave(updateText) -- updateText will now be called every time a player leaves

 CurrentPlayer = Space.Scene.PlayerAvatar 

avatars = Space.Scene.Avatars  

--this script, once clicked, will get all avatars in the scene
--and print their ID, Username and Title (excluding self)
--(Example: scoreboards/radars/scanners/game machines)

thisGameObject = Space.Host.ExecutingObject

OnClick = function()
Avatars = Space.Scene.Avatars

      if #Avatars > 0 then
            for var=1, #Avatars do
        local ID = Avatars[var].ID
        local Username = Avatars[var].Username
        local Title = Avatars[var].Title
        if Title == "" then Title = "None" end

         Space.Log("ID: " .. ID .. ", Username: " .. Username .. ", Title: " .. Title)
            end

      else
      Space.Log("No Avatars")
      end
end
 
thisGameObject.AddClickable() 
thisGameObject.Clickable.Tooltip = "Click to print all avatars' information"
thisGameObject.Clickable.OnClick(OnClick) 

 objects = Space.Scene.Objects 

--clicking this object will print a name of every object in the scene
--[better use a coroutine incase the foor loop exceeds allowed frame time]
  thisObject = Space.Host.ExecutingObject

  OnClickFunction = function()
    local objects = Space.Scene.Objects
    for i=1, #objects, 1 do
      Space.Log(objects[i].Name)
    end
  end

  thisObject.AddClickable()

RegionName = Space.Scene.Name 

--this object will be clickable only if it is in a region called "X Region"
--((for example: limiting object functionality to a specific region))

thisObject = Space.Host.ExecutingObject


OnClick = function()
Space.Log("We are in X Region")
end


if Space.Scene.Name == "X Region" then
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)
end

RegionUrl = Space.Scene.Url 

--the URL of this region will be placed in a UIText upon loading 
--and also printed if this object is clicked
thisObject = Space.Host.ExecutingObject
textObject = Space.Host.GetReference("textObject") -- add to scripting runtime references


function OnClick()
  Space.Log(Space.Scene.Url)
end

textObject.UIText.Text = Space.Scene.Url
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

RegionOwner = Space.Scene.Owner

--this script will make this object only clickable for the region owner

thisObject = Space.Host.ExecutingObject
thisPlayer = Space.Scene.PlayerAvatar

OnClick = function()
Space.Log("Do Something")
end

if thisPlayer.ID == Space.Scene.Owner then 
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)
end

Space.Log(#avatars)

 --this script, once clicked, will get all avatars in the scene
--and print their ID, Username and Title (including self)
--(Example: scoreboards/radars/scanners/game machines)

thisGameObject = Space.Host.ExecutingObject

OnClick = function()
allAvatars = Space.Scene.AllAvatars

    for var=1, #allAvatars do
local ID = allAvatars[var].ID
local Username = allAvatars[var].Username
local Title = allAvatars[var].Title
if Title == "" then Title = "None" end

 Space.Log("ID: " .. ID .. ", Username: " .. Username .. ", Title: " .. Title)
    end

end

 
thisGameObject.AddClickable() 
thisGameObject.Clickable.Tooltip = "Click to print all avatars' information"
thisGameObject.Clickable.OnClick(OnClick) 
 

--the RegionID of this region will be placed in a UIText upon loading 
--and also printed if this object is clicked
thisObject = Space.Host.ExecutingObject
textObject = Space.Host.GetReference("textObject") -- add to scripting runtime references


function OnClick()
  Space.Log(Space.Scene.RegionID)
end

textObject.UIText.Text = Space.Scene.RegionID
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

--the RegionID of this region will be placed in a UIText upon loading 
--and also printed if this object is clicked
thisObject = Space.Host.ExecutingObject
textObject = Space.Host.GetReference("textObject") -- add to scripting runtime references


function OnClick()
  Space.Log(Space.Scene.InstanceID)
end

textObject.UIText.Text = Space.Scene.InstanceID
thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClick)

        local landmark = Space.Scene.Landmarks
        for i = 1,#landmark do
    if landmark[i].Type == LandmarkType.LandingZone then
        Space.Log("LandingZone")
        end
                Space.Log(landmark[i].Name .. " ".. landmark[i].Position.ToString())
        end

--this script will make the object a clickable, but only if player is region Admin
--(Example: Access control)

thisGameObject = Space.Host.ExecutingObject

OnClick = function()
Space.Log("this click was only possible because you are a region Admin")
end

if Space.Scene.PlayerIsAdmin then
thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click me Admin"
thisGameObject.Clickable.OnClick(OnClick) 
end

--this script will make the object a clickable, but only if player is Moderator in this region
--(Example: Access control)

thisGameObject = Space.Host.ExecutingObject

OnClick = function()
Space.Log('this click was only possible because you are Moderator in this region')
end

if Space.Scene.PlayerIsModerator then
thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click me Moderator"
thisGameObject.Clickable.OnClick(OnClick) 
end

isOwner = Space.Scene.PlayerIsOwner 

--this script will make the object a clickable, but only if player is region owner
--(Example: Access control)

thisGameObject = Space.Host.ExecutingObject

OnClick = function()
Space.Log("this click was only possible because you are a region Owner")
end

if Space.Scene.PlayerIsOwner then
thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click me"
thisGameObject.Clickable.OnClick(OnClick) 
end

isOwner = Space.Scene.PlayerIsOwner 

--this script will make the object a clickable, but only if player is Trusted in this region
--(Example: Access control)

thisGameObject = Space.Host.ExecutingObject

OnClick = function()
Space.Log("this click was only possible because you are Trusted in this region")
end

if Space.Scene.PlayerIsTrusted then
thisGameObject.AddClickable()
thisGameObject.Clickable.Tooltip = "Click me Trusted"
thisGameObject.Clickable.OnClick(OnClick) 
end

--makes an object only active when this player is in Edit Mode
thisObject = Space.Host.ExecutingObject
targetObject = Space.Host.GetReference("target") --add to references in Scripting Runtime component

function OnUpdateFunction()
  targetObject.Active = Space.Scene.IsInEditMode 
end


thisObject.OnUpdate(OnUpdateFunction)

    Space.Log(Space.Scene.Floors[i].Name)
end