StalEF at 17:59, 1 April 2026

2026-04-01T17:59:14Z

← Older revision		Revision as of 19:59, 1 April 2026
Line 1:		Line 1:
	~~{{ModdingOutdated}}~~

	== Modding Tutorial: Generic Authorization ==		== Modding Tutorial: Generic Authorization ==

Redwyre: Created page with "{{ModdingOutdated}} == Modding Tutorial: Generic Authorization == === Intro === Want to authorize certain players to do certain actions with your world objects or items? W..."

2021-07-04T16:52:45Z

Created page with "{{ModdingOutdated}} == Modding Tutorial: Generic Authorization == === Intro === Want to authorize certain players to do certain actions with your world objects or items? W..."

New page

{{ModdingOutdated}}

== Modding Tutorial: Generic Authorization ==

=== Intro ===

Want to authorize certain players to do certain actions with your world objects or items? We added the AuthorizationController just for that! It's the same one we use for all the current content and is easy to use in your own mods.

=== Steps ===

Include:
<pre>
using Eco.Gameplay.Buildings
</pre>

Create an *AuthorizationController* in your world object or item class:

<pre>
[DataMember]
public AuthorizationController Authorization { get; private set; }
</pre>

Initialize it in the constructor:

<pre>
this.Authorization = new AuthorizationController();
this.Authorization.AddAuthorizedPlayer(playerCreator);
this.Authorization.Name = "Some Default Name";
</pre>

=== Open the Authorization UI ===

Whenever you want to toggle the visibility of the authorization manager UI (for example, on left click), call:

<pre>
this.Authorization.OpenAuthorizationMenuOn(player);
</pre>

=== Check If a Player Is Authorized: ===

<pre>
if (this.Authorization.IsAuthorized(player))
// do something
</pre>

=== That's it! ===

Feel free to have multiple AuthorizationControllers for a single object if you wish to have different auth for various actions.

=== Full API for AuthorizationController ===

<pre>
public List<string> AuthorizedUsers { get; set; } = new List<string>();
public string Name { get; set;}

public bool IsAuthorized(Player player)
public bool AddAuthorizedPlayer(Player player)
public bool AddAuthorizedUser(ServerUser user)
public bool RemoveAuthorizedUser(ServerUser user)
public bool RemoveAuthorizedPlayer(Player player)
public void OpenAuthorizationMenuOn(Player player)
</pre>

[[Category: Modding]]

Generic Authorization - Revision history

StalEF at 17:59, 1 April 2026

Redwyre: Created page with "{{ModdingOutdated}} == Modding Tutorial: Generic Authorization == === Intro === Want to authorize certain players to do certain actions with your world objects or items? W..."