S&box Wiki


What Are RPCs?

They're just network messages.

The server sends a message to the client, when the client receives the message it calls a function. It's that simple.

RPC is short for Remote Procedure Call.


On entities you can mark a function as an RPC:

[ClientRpc] public void ShowDeathScreen( string killedName ) { Log.Info( "TODO SHOW DEATH SCREEN" ); }

Here, "Client" tells us that this method should only ever be called on the client.

So, if you're on the server and you do this:

entity.ShowDeathScreen( "Killa04" );

It gets called on the client version of the entity. We've done some magic in the background.

RPCs on static classes

You can also use RPCs on static classes.

public static partial class MyStaticClass { [ClientRpc] public static void MyStaticMethod() { Log.Info("Hello!"); } }

This can then be invoked from the server using MyStaticClass.MyStaticMethod().

During compilation we've added an extra step in the RPC function that checks if we're being called serverside, and if so, then broadcast a message to every client, which will call the method.

Targeting Players

We have a problem with the above example. We wouldn't want to show the death screen to every player. We'd want to show it to just one.

The code generator has got you covered, it's created another function in the background which takes a target as the first argument.

entity.ShowDeathScreen( To.Single(deadPlayer), "Killa04" );

Calling this will only call ShowDeathScreen on deadPlayer's client.


Client-to-Server RPCs aren't enabled yet, but you can send console commands instead.

Here, the client sends a command to the server, which modifies their Pawn's rotation.

[ConCmd.Server] public static void ClientVectorToServer( Vector3 lookAtPos ) { Entity pawn = ConsoleSystem.Caller.Pawn; pawn.Rotation = Rotation.LookAt( (lookAtPos - pawn.Position).WithZ( 0 ).Normal ); pawn.EyeRot = pawn.Rotation; }

Now you need to call this static function within the client-side code. For this example, it can be used in the Camera Controller Update function.

ClientVectorToServer( new Vector3( 10, 10, 10 ) );

Sending Entities to the Server

If you need to send a reference to an entity to the server you can do so by taking advantage of entities "network identifiers."

public void SendToServer() { ClientEntityToServer(myPawn.NetworkIdent); } [ConCmd.Server] public static void ClientEntityToServer( int identifier ) { Entity ent = Entity.FindByIndex(identifier); }
You cannot send client-side only entities to the server.