1.92 User .819
1.92.1 User.GetName .819
1.92.2 User.GetPerson .820
1.92.3 User.GetSceneOwner .821
1.92.4 User.GoToLocation .821
1.92.5 User.InviteToLocation .822
1.92.6 User.IsFriend .822
1.92.7 User.lsInHome .823
1.92.8 User.lsOnline .824

User
User.GetName
Brief
Returns the user's Online ID.
Definition
string User.GetName( User User )
Arguments
user - The user object.
Return Values
The user's Online ID.
Description
Returns the user's Online ID, but only if you launch HomeDeveloper.self in online mode. If launching in offline mode, this function returns the
string "Me”.
Examples
myUser = LocalPlayer.GetUser()
print( "My name is " .. User.GetName( myUser ) )
See Also
• LocalPlayer.GetUser
User.GetPerson
Brief
Returns a Person object if the user is found in the current instance and nil otherwise.
Definition
Person User.GetPerson( User user )
Arguments
user - The User object
Return Values
Returns a Person object if the user is found and nil otherwise.
Description
Returns a Person object if the user is found and nil otherwise. Person objects only exist in the current instance of the scene.
Examples
local person = User.GetPerson ( user )
if person ~= nil then
friendLockStatus = Person.Lock( person ) — locking a friend
end
See Also
None
User.GetSceneOwner
Brief
Returns the owner of a scene as a User object.
Definition
User|nil User.GetSceneOwner()
Arguments
None
Return Values
The owner as a User or nil if there is no owner or it hasn't calculated the owner yet.
Description
Returns the owner of a scene as a User object. If called from an apartment it will return the owner of the apartment and if called from a club house
it will return the leader of the club house. All other types of scene will return nil. It may initially return nil if you are not the owner of the scene so
you should keep calling it each frame until it returns a User. The cases in which this could happen are club houses and when visiting a friend's
apartment.
Examples
local owner = User.GetSceneOwner ()
if owner ~= nil and User.GetName( owner ) == Person.GetName( LocalPlayer.GetPerson() ) then
print( ’I am the owner' )
end
See Also
• User.GetPerson
• Person.GetlnstanceSessionMasterld
User.GoToLocation
Brief
Go to the user's location.
Definition
User.GoToLocation ( User user )
Arguments
user - The user object.
Return Values
Description
Go to the user's location.
Examples
friends = LocalPlayer.GetFriends()
User.GoToLocation( friends[ 1 ] )
See Also
• LocalPlayer.GetFriends
User.InviteToLocation
Brief
Invites the user to the Local player's location.
Definition
User.InviteToLocation ( User user )
Arguments
user - The user object.
Return Values
Description
Invites the user to the Local player’s location.
Examples
friends = LocalPlayer.GetFriends()
for index, friend in ipairs( friends ) do
if User.IsInHome( friend ) == true then
User.InviteToLocation ( friend )
end
end
See Also
• LocalPlayer.GetFriends
User.IsFriend
Brief
Returns true if the user is a friend.
Definition
boolean User.IsFriend( User user )
Arguments
user - The user object.
Return Values
Returns true if the user is a friend and false otherwise.
Description
Returns true if the user is a friend.
Examples
friends = LocalPlayer.GetFriends()
for index, friend in ipairs( friends ) do
if User.IsFriend( friend ) == true then
print( User.GetName( friend ) .. ' is a friend.' )
else
print( 'Something bad has happened.' )
end
end
See Also
• LocalPlayer.GetFriends
User.lsInHome
Brief
Returns true if the user is in PS Plome.
Definition
boolean User.IsInHome( User user )
Arguments
user - The user object.
Return Values
Returns true if the user is in PS Plome and false otherwise.
Description
Returns true if the user is in PS Plome.
Examples
friends = LocalPlayer.GetFriends()
for index, friend in ipairs ( friends ) do
if User.IsInHome( friend ) == true then
print( User.GetName( friend ) .. ' is in PS Home.' )
end
end
See Also
• LocalPlayer.GetFriends
• User.lsOnline
User.lsOnline
Brief
Returns true if the user is online.
Definition
boolean User.IsOnline ( User user )
Arguments
user - The user object.
Return Values
Returns true if the user is online and false otherwise.
Description
Returns true if the user is online. They are not necessarily in PS Flome when online.
Examples
friends = LocalPlayer.GetFriends()
for index, friend in ipairs( friends ) do
if User.IsOnline( friend ) == true then
print( User.GetName( friend ) .. 'is online.' )
end
end
See Also
• LocalPlayer.GetFriends
• User.lsInFlome