Documentation

Want to improve the docs? Take a look at scripting-api-data!
Found a bug? jc3mp/bugs is a good place to let us know.

RemoteClient

Constructible This class can not be instantiated from your script. Do not try to use the `new` keyword on this class. Auto Destroy Instances of this class will be deleted automatically. Custom Properties You can extend instances of this class with your own properties.

represents a Client connected to the server.

Properties

Name Type Description
name string read only the RemoteClient's name
ipAddress string read only the ip address of the client
networkId number read only the network id of this entity. It is not unique across different entities and will be re-assigned once this entity was destroyed
ping number read only the client's ping
steamId string read only the Steam64ID of the client
steamAuthenticated boolean read only whether the client is authenticated via Steam

Functions

RemoteClient.Kick(string reason)

Immediately kicks the Client from the Server.

Parameter

Name Type Description
reason string reason for kicking the Client. currently unused (cannot be seen by the user)

Example

jcmp.events.Add('ClientConnected', client => {
  client.Kick('meow!');
});

RemoteClient.DoesOwnDLC(number dlc)

Checks whether the client owns the DLC

Available DLCs

Name Value
SKY_FORTRESS 400551
MECH_LAND_ASSAULT 400490
BAVARIUM_SEA_HEIST 442051
AIR_LAND_SEA 401850
FIRESTARTER_SKINS 348880
CAPSTONE_BLOODHOUND_RPG 388294
KOUSAVA_RIFLE 442050
FINAL_ARGUMENT_SNIPER 488293
COMBAT_BUGGY 388290
MINIGUN_RACING_BOAT 388291
ROCKET_LAUNCHER_SPORTS_CAR 388292
REAPER_MISSILE_MECH 442052

returns: boolean

Parameter

Name Type Description
dlc number DLC number

Example

jcmp.events.Add('ClientConnected', client => {
  if (!client.DoesOwnDLC(400551)) {
    console.log(`${client.name} does not own Sky Fortress.`);
  }
});

Stay informed

By becoming the newest member of our growing forums, we and hundreds of other players will always keep you up to date on everything JC3:MP related.