Component:WorldPermissions: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=World Permissions
|Name=World Permissions
}}
}}
{{stub}}
The '''WorldPermissions''' component controls various actions the selected roles can do in the world.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|AllowSavingItems|Bool|
|AllowSavingItems|Bool| Whether the selected roles can save items.
|AllowTransferingObjectsOut|Bool|
|AllowTransferingObjectsOut|Bool| Whether the selected roles can [[Transcient Grabbing|smuggle]] items out.
|AllowSpawningObjects|Bool|
|AllowSpawningObjects|Bool| Whether the selected roles can spawn objects.
|AllowSwappingAvatars|Bool|
|AllowSwappingAvatars|Bool| Whether the selected roles can swap into a different avatar.
|SaveCopyPermission|'''[[#SavePermission|SavePermission]]'''|TypeAdv4=true|
|SaveCopyPermission|'''[[#SavePermission|SavePermission]]'''|TypeAdv4=true| When can the selected roles save the world?
}}
 
== SavePermission ==
{{Table EnumValues
|OnlyOwners|0|Only the owner or a member of a group that the group owns the world can save it.
|OnlyWhenPublic|1|Only allow saving if the world is public.
|Anyone|2|Anyone can save the world.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Found in the Permissions slot in the root of a world.


== See Also ==
== See Also ==
Line 23: Line 32:
[[Category:Components{{#translation:}}|World Permissions]]
[[Category:Components{{#translation:}}|World Permissions]]
[[Category:Components With Nested Enums{{#translation:}}|World Permissions]]
[[Category:Components With Nested Enums{{#translation:}}|World Permissions]]
[[Category:ComponentStubs]]

Latest revision as of 05:06, 7 February 2025

Component image 
World Permissions component as seen in the Scene Inspector

The WorldPermissions component controls various actions the selected roles can do in the world.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
AllowSavingItems Bool Whether the selected roles can save items.
AllowTransferingObjectsOut Bool Whether the selected roles can smuggle items out.
AllowSpawningObjects Bool Whether the selected roles can spawn objects.
AllowSwappingAvatars Bool Whether the selected roles can swap into a different avatar.
SaveCopyPermission SavePermission When can the selected roles save the world?

SavePermission

Values
Name Value Description
OnlyOwners 0 Only the owner or a member of a group that the group owns the world can save it.
OnlyWhenPublic 1 Only allow saving if the world is public.
Anyone 2 Anyone can save the world.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Examples

Found in the Permissions slot in the root of a world.

See Also