Class RpcAttribute

Namespace

Godot

Assembly

GodotSharp.dll

Attribute that changes the RPC mode for the annotated method to the given Mode, optionally specifying the TransferMode and TransferChannel (on supported peers). See MultiplayerApi.RpcMode and MultiplayerPeer.TransferModeEnum. By default, methods are not exposed to networking (and RPCs).

[AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
public sealed class RpcAttribute : Attribute

Inheritance

object

Attribute

RpcAttribute

Inherited Members

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.Equals(object)

Attribute.GetHashCode()

Attribute.Match(object)

Attribute.IsDefaultAttribute()

Attribute.TypeId

object.GetType()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

RpcAttribute(RpcMode)

Constructs a RpcAttribute instance.

public RpcAttribute(MultiplayerApi.RpcMode mode = RpcMode.Authority)

Parameters

mode MultiplayerApi.RpcMode

The RPC mode to use.

Properties

CallLocal

If the method will also be called locally; otherwise, it is only called remotely.

public bool CallLocal { get; init; }

Property Value

bool

Mode

RPC mode for the annotated method.

public MultiplayerApi.RpcMode Mode { get; }

Property Value

MultiplayerApi.RpcMode

TransferChannel

Transfer channel for the annotated mode.

public int TransferChannel { get; init; }

Property Value

int

TransferMode

Transfer mode for the annotated method.

public MultiplayerPeer.TransferModeEnum TransferMode { get; init; }

Property Value

MultiplayerPeer.TransferModeEnum