Yield functions
9CreatePlaceAsync
(placeName: string, templatePlaceID: int, description: string = …) → int
| Field | XML type | Value |
|---|
Name | string | CreatePlaceAsync |
CreatePlaceInPlayerInventoryAsync
(player: Instance, placeName: string, templatePlaceID: int, description: string = …) → int
| Field | XML type | Value |
|---|
Name | string | CreatePlaceInPlayerInventoryAsync |
GetAssetVersions
(placeId: int, pageNum: int = …) → Dictionary
| Field | XML type | Value |
|---|
Name | string | GetAssetVersions |
summary | string | Given a placeID, this function will return a table with the version info of the place. An optional arg of page number can be used to page through all revisions (a single page may hold about 50 revisions). |
GetCreatorAssetID
(creationID: int) → int
| Field | XML type | Value |
|---|
Name | string | GetCreatorAssetID |
summary | string | Given a creationID, this function will return the asset that created the creationID. If no other asset created the given creationID, 0 is returned. |
GetGamePlacesAsync
() → Instance
| Field | XML type | Value |
|---|
Name | string | GetGamePlacesAsync |
GetPlacePermissions
(placeId: int) → Dictionary
| Field | XML type | Value |
|---|
Name | string | GetPlacePermissions |
summary | string | Given a placeID, this function will return a table with the permissions of the place. Useful for determining what kind of permissions a particular user may have for a place. |
RevertAsset
(placeId: int, versionNumber: int) → bool
| Field | XML type | Value |
|---|
Name | string | RevertAsset |
summary | string | Reverts a given place id to the version number provided. Returns true if successful on reverting, false otherwise. |
SavePlaceAsync
() → void
| Field | XML type | Value |
|---|
Name | string | SavePlaceAsync |
SetPlacePermissions
(placeId: int, accessType: AccessType = …, inviteList: Array = …) → bool
| Field | XML type | Value |
|---|
Name | string | SetPlacePermissions |
summary | string | Sets the permissions for a placeID to the place accessType. An optional table (inviteList) can be included that will set the accessType for only the player names provided. The table should be set up as an array of usernames (strings). |