Skip to main content

UCR.GetRoleInstance

Optional integration

This method requires UncomplicatedCustomRoles.

Gets a player's active UCR role instance.

Syntax​

UCR.GetRoleInstance @player

Returns​

reference to UCRRoleInstance object

Arguments​

NameRequiredTypeDescription
playerYesPlayer value e.g. @player, with EXACTLY 1 player.

Details​

Returns an invalid reference when the player does not have a UCR role. The reference exposes id, player, role, and object.

On a running server​

Use serhelp UCR.GetRoleInstance to inspect the reference generated by your installed SER version.