S&box Wiki

RPCs

RPCs

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)

You may need to turn prediction off before running a client RPC in some situations for it to work. Example:

using( Prediction.Off() ) { entity.ShowDeathScreen( "Killa04" ); }

Example

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.

During compilation we've added an extra step in the RPC function that checks if we're being called serverside, and if we are it'll 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.

todo

  • Sending messages from client to server
  • Multicast messages

Special Pages


Wikis

?

Render Time: 12ms

DB GetPage 3
Generate Html 0
SaveChanges (1) 6
Render Body 0
Render Sidebar 0