RAGE Multiplayer Wiki - User contributions [en]

GetPlayerSocialClubId

2019-12-12T15:10:54Z

Muphy:

Gets the social club id from a player

{{CSharpContainer|
{{#tag:syntaxhighlight|string {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(Client player);|lang=csharp}}

{{Parameters}}
*'''player:''' parameter input should be in '''Client''' type

{{Example}}
{{#tag:syntaxhighlight|
[Command("mysocialclub")]
public void MySocialClubId(Client sender)
{
string socialclubid = {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(sender);
sender.SendChatMessage("~g~Your social club id is: " + socialclubid);
}
|lang=csharp}}
}}

[[Category:Serverside API]]

GetPlayerSocialClubId

2019-12-12T15:10:32Z

Muphy:

Gets the social club id from a player

{{CSharpContainer|
{{#tag:syntaxhighlight|string {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(Client player);|lang=csharp}}

{{Parameters}}
*'''player:''' parameter input should be in '''Client''' type

{{Example}}
{{#tag:syntaxhighlight|
[Command("mysocialclub"]
public void MySocialClubId(Client sender)
{
string socialclubid = {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(sender);
sender.SendChatMessage("~g~Your social club id is: " + socialclubid);
}
|lang=csharp}}
}}

[[Category:Serverside API]]

GetPlayerSocialClubId

2019-12-12T15:09:43Z

Muphy: Created page with "Gets the social club id from a player {{CSharpContainer| {{#tag:syntaxhighlight|bool {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(Client player);|lan..."

Gets the social club id from a player

{{CSharpContainer|
{{#tag:syntaxhighlight|bool {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(Client player);|lang=csharp}}

{{Parameters}}
*'''player:''' parameter input should be in '''Client''' type

{{Example}}
{{#tag:syntaxhighlight|
[Command("mysocialclub"]
public void MySocialClubId(Client sender)
{
string socialclubid = {{Template:CSharp_Serverside_namespace}}Player.GetPlayerSocialClubId(sender);
sender.SendChatMessage("~g~Your social club id is: " + socialclubid);
}
|lang=csharp}}
}}

[[Category:Serverside API]]

Server-side CSharp events

2019-11-27T13:43:42Z

Muphy:

==Global==
* [[OnUpdate]]
* [[OnChatMessage]]
* [[FirstChanceException]]
* [[UnhandledException]]
==Resource==
* [[OnResourceStart]]
* [[OnResourceStop]]
* [[OnServerResourceStart]]
* [[OnServerResourceStop]]

==Entity==
(Every server handled object is called an 'entity', which includes Players, Vehicles, Objects and etc..)
* [[OnEntityModelChange]]

==Player==
* [[OnPlayerConnected]]
* [[OnPlayerDisconnected]]
* [[OnPlayerDeath]]
* [[OnPlayerSpawn]]
* [[OnPlayerPickup]]
==Health/Armor==
* [[OnPlayerDamage]]

==Vehicle==
* [[OnPlayerEnterVehicle]]
* [[OnPlayerExitVehicle]]
==Weapon==
* [[OnPlayerWeaponSwitch]]
* [[OnPlayerDetonateStickies]]

==ColShapes==
* [[OnPlayerEnterColShape]]
* [[OnPlayerExitColShape]]
==Checkpoints==
* [[OnPlayerEnterCheckpoint]]
* [[OnPlayerExitCheckpoint]]

==Vehicle==
* [[OnVehicleDamage]]
* [[OnVehicleSirenToggle]]
* [[OnVehicleDoorBreak]]
* [[OnVehicleWindowSmash]]
* [[OnVehicleTyreBurst]]
* [[OnVehicleDeath]]
* [[OnVehicleTrailerChange]]

Server-side CSharp events

2019-11-27T13:41:49Z

Muphy:

==Global==
* [[OnUpdate]]
* [[OnChatMessage]]
* [[FirstChanceException]]
* [[UnhandledException]]
===Resource===
* [[OnResourceStart]]
* [[OnResourceStop]]
* [[OnServerResourceStart]]
* [[OnServerResourceStop]]

==Entity==
(Every server handled object is called an 'entity', which includes Players, Vehicles, Objects and etc..)
* [[OnEntityModelChange]]

==Player==
* [[OnPlayerConnected]]
* [[OnPlayerDisconnected]]
* [[OnPlayerDeath]]
* [[OnPlayerSpawn]]
* [[OnPlayerPickup]]
===Health/Armor===
* [[OnPlayerDamage]]

===Vehicle===
* [[OnPlayerEnterVehicle]]
* [[OnPlayerExitVehicle]]
===Weapon===
* [[OnPlayerWeaponSwitch]]
* [[OnPlayerDetonateStickies]]

===ColShapes===
* [[OnPlayerEnterColShape]]
* [[OnPlayerExitColShape]]
===Checkpoints===
* [[OnPlayerEnterCheckpoint]]
* [[OnPlayerExitCheckpoint]]

==Vehicle==
* [[OnVehicleDamage]]
* [[OnVehicleSirenToggle]]
* [[OnVehicleDoorBreak]]
* [[OnVehicleWindowSmash]]
* [[OnVehicleTyreBurst]]
* [[OnVehicleDeath]]
* [[OnVehicleTrailerChange]]

Server-side CSharp events

2019-11-27T13:41:22Z

Muphy:

IsPlayerInAnyVehicle

2019-11-27T13:32:45Z

Muphy: Created page with "This function will tell you if the player is in an vehicle. ==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Player.IsPlayerInAnyVehicle(Client player);</syntaxhighlight> ''..."

This function will tell you if the player is in an vehicle.

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Player.IsPlayerInAnyVehicle(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.IsPlayerInAnyVehicle(player);</syntaxhighlight>

[[Category:Serverside API]]

IsPlayerDead

2019-11-27T13:32:26Z

Muphy: Created page with "This function will tell you if the player is dead or not. ==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Player.IsPlayerDead(Client player);</syntaxhighlight> '''Required..."

This function will tell you if the player is dead or not.

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Player.IsPlayerDead(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.IsPlayerDead(player);</syntaxhighlight>

[[Category:Serverside API]]

IsPlayerAiming

2019-11-27T13:32:11Z

Muphy: Created page with "This function will tell you if the player is aiming. ==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Player.IsPlayerAiming(Client player);</syntaxhighlight> '''Required Arg..."

This function will tell you if the player is aiming.

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Player.IsPlayerAiming(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.IsPlayerAiming(player);</syntaxhighlight>

[[Category:Serverside API]]

HasPlayerGotWeaponComponent

2019-11-27T13:31:45Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Player.HasPlayerWeaponComponent(Client player, WeaponHash weapon, WeaponComponent component);</syntaxhighlight> '''Required A..."

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Player.HasPlayerWeaponComponent(Client player, WeaponHash weapon, WeaponComponent component);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''weapon:''' parameter input should be in '''WeaponHash''' type.
*'''component:''' parameter input should be in '''WeaponComponent''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.HasPlayerWeaponComponent(player, weapon, component);</syntaxhighlight>

[[Category:Serverside API]]

GivePlayerWeaponComponent

2019-11-27T13:31:09Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >void NAPI.Player.SetPlayerWeaponComponent(Client player, WeaponHash weapon, WeaponComponent component);</syntaxhighlight> '''Required A..."

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Player.SetPlayerWeaponComponent(Client player, WeaponHash weapon, WeaponComponent component);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''weapon:''' parameter input should be in '''WeaponHash''' type.
*'''component:''' parameter input should be in '''WeaponComponent''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.SetPlayerWeaponComponent(player, weapon, component);</syntaxhighlight>

[[Category:Serverside API]]

GivePlayerWeapon

2019-11-27T13:30:33Z

Muphy: Created page with "Gives the given player a weapon of the given type. See also Weapons Models. ==Syntax== <syntaxhighlight lang="C#">void NAPI.Player.GivePlayerWeapon(Client player, WeaponH..."

Gives the given player a weapon of the given type. See also [[Weapons Models]].

==Syntax==
<syntaxhighlight lang="C#">void NAPI.Player.GivePlayerWeapon(Client player, WeaponHash weaponHash, int ammo);</syntaxhighlight>

*'''player:''' parameter input should be in '''Client''' type.
*'''weaponHash:''' parameter input should be in '''WeaponHash''' type.
*'''ammo:''' parameter input should be in '''int''' type.

'''Note''': All the weapons in a slot share the same ammo.

==Usage example(s)==
<syntaxhighlight lang="C#">
// Use as: /weapon smg
[Command("weapon")]
public void WeaponCommand(Client sender, WeaponHash hash)
{
NAPI.Player.GivePlayerWeapon(sender, hash, 500);
}
</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerWeaponTint

2019-11-27T13:29:36Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >WeaponTint NAPI.Player.GetPlayerWeaponTint(Client player, WeaponHash weapon);</syntaxhighlight> '''Required Arguments''' *'''player:'''..."

==Syntax==
<syntaxhighlight lang="C#" >WeaponTint NAPI.Player.GetPlayerWeaponTint(Client player, WeaponHash weapon);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''weapon:''' parameter input should be in '''WeaponHash''' type.

'''NOTE:''' This function returns data in '''WeaponTint''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerWeaponTint(player, weapon);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerWeapons

2019-11-27T13:29:11Z

Muphy: Created page with "Returns an array of weapon hashes that contains all the weapons the player is currently holding. ==Syntax== <syntaxhighlight lang="C#" >WeaponHash[] NAPI.Player.GetPlayerWeap..."

Returns an array of weapon hashes that contains all the weapons the player is currently holding.

==Syntax==
<syntaxhighlight lang="C#" >WeaponHash[] NAPI.Player.GetPlayerWeapons(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''WeaponHash[]''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >
WeaponHash[] playerWeapons = NAPI.Player.GetPlayerWeapons(player);

foreach(WeaponHash weapon in playerWeapons) {
// will loop through all player's weapons.
}
</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerWeaponComponents

2019-11-27T13:28:39Z

Muphy: Created page with "Get all components from a weapon. ==Syntax== <syntaxhighlight lang="C#" >WeaponComponent[] NAPI.Player.GetPlayerWeaponComponents(Client player, WeaponHash weapon);</syntaxhig..."

Get all components from a weapon.

==Syntax==
<syntaxhighlight lang="C#" >WeaponComponent[] NAPI.Player.GetPlayerWeaponComponents(Client player, WeaponHash weapon);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''weapon:''' parameter input should be in '''WeaponHash''' type.

'''NOTE:''' This function returns data in '''WeaponComponent[]''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerWeaponComponents(player, weapon);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerWeaponAmmo

2019-11-27T13:28:16Z

Muphy: Created page with "Returns the amount of ammo in the weapon of the player. ==Syntax== <syntaxhighlight lang="C#">int NAPI.Player.GetPlayerWeaponAmmo(Client player, WeaponHash weapon);</syntaxhi..."

Returns the amount of ammo in the weapon of the player.

==Syntax==
<syntaxhighlight lang="C#">int NAPI.Player.GetPlayerWeaponAmmo(Client player, WeaponHash weapon);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''weapon:''' parameter input should be in '''WeaponHash''' type.

'''NOTE:''' This function returns data in '''int''' type.

==Usage example(s)==
<syntaxhighlight lang="C#" >
int ammoAmount = NAPI.Player.GetPlayerWeaponAmmo(player, WeaponHash.SMG);
player.sendChatMessage("You have " + ammoAmount + " bullets in your SMG.");
</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerWantedLevel

2019-11-27T13:27:52Z

Muphy: Created page with "Returns the player wanted level. ==Syntax== <syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerWantedLevel(Client player);</syntaxhighlight> '''Required Arguments''' *'''p..."

Returns the player wanted level.

==Syntax==
<syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerWantedLevel(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''int''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerWantedLevel(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerVelocity

2019-11-27T13:27:18Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >Vector3 NAPI.Player.GetPlayerVelocity(Client player);</syntaxhighlight> '''Required Arguments''' *'''player:''' parameter input should..."

==Syntax==
<syntaxhighlight lang="C#" >Vector3 NAPI.Player.GetPlayerVelocity(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''Vector3''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerVelocity(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerVehicleSeat

2019-11-27T13:26:32Z

Muphy: Created page with "Returns the seat ID that the player is currently occupying. ==Syntax== <syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerVehicleSeat(Client player);</syntax..."

Returns the [[Seat_Types|seat ID]] that the player is currently occupying.

==Syntax==
<syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerVehicleSeat(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''int''' type. -1 for driver's seat, 0 upwards for passengers.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerVehicleSeat(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerVehicle

2019-11-27T13:26:06Z

Muphy: Created page with "Returns the vehicle of the given player. ==Syntax== <syntaxhighlight lang="C#" >Vehicle NAPI.Player.GetPlayerVehicle(Client player);</syntaxhighlight> '''Required Arguments'..."

Returns the vehicle of the given player.

==Syntax==
<syntaxhighlight lang="C#" >Vehicle NAPI.Player.GetPlayerVehicle(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''Vehicle''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerVehicle(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayersInRadiusOfPosition

2019-11-27T13:25:38Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >List<Client> NAPI.Player.GetPlayersInRadiusOfPosition(float radius, Vector3 position);</syntaxhighlight> '''Required Arguments''' *'''r..."

==Syntax==
<syntaxhighlight lang="C#" >List<Client> NAPI.Player.GetPlayersInRadiusOfPosition(float radius, Vector3 position);</syntaxhighlight>

'''Required Arguments'''
*'''radius:''' parameter input should be in '''float''' type.
*'''position:''' parameter input should be in '''Vector3''' type.

'''NOTE:''' This function returns data in '''List<Client>''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayersInRadiusOfPosition(radius, position);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayersInRadiusOfPlayer

2019-11-27T13:25:22Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >List<Client> NAPI.Player.GetPlayersInRadiusOfPlayer(double radius, Client player);</syntaxhighlight> '''Required Arguments''' *'''radiu..."

==Syntax==
<syntaxhighlight lang="C#" >List<Client> NAPI.Player.GetPlayersInRadiusOfPlayer(double radius, Client player);</syntaxhighlight>

'''Required Arguments'''
*'''radius:''' parameter input should be in '''double''' type.
*'''player:''' parameter input should be in '''[[Client]]''' type.

'''NOTE:''' This function returns data in '''List<[[Client]]>''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayersInRadiusOfPlayer(radius, player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerSeatbelt

2019-11-27T13:25:00Z

Muphy: Created page with "This function will tell you if the player has the seatbelt on or not. ==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Player.GetPlayerSeatbelt(Client player);</syntaxhighlig..."

This function will tell you if the player has the seatbelt on or not.

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Player.GetPlayerSeatbelt(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerSeatbelt(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerPing

2019-11-27T13:24:34Z

Muphy: Created page with "Gets the current player ping ==Syntax== <syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerPing(Client player);</syntaxhighlight> '''Required Arguments''' *'''player:''' p..."

Gets the current player ping

==Syntax==
<syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerPing(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''int''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerPing(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerNametagVisible

2019-11-27T13:24:12Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Player.GetPlayerNametagVisible(Client player);</syntaxhighlight> '''Required Arguments''' *'''player:''' parameter input shou..."

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Player.GetPlayerNametagVisible(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerNametagVisible(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerName

2019-11-27T13:23:51Z

Muphy: Created page with "Gets the current player's name ==Syntax==  <syntaxhighlight lang="C#" >string NAPI.Player.GetPlayerName(Client player);</syntaxhighlight>  '''Required Ar..."

Gets the current player's name

==Syntax== 
<syntaxhighlight lang="C#" >string NAPI.Player.GetPlayerName(Client player);</syntaxhighlight>


'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.


'''NOTE:''' This function returns data in '''string''' type.

==Usage example(s)== 
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerName(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerHealth

2019-11-27T13:23:21Z

Muphy: Created page with "This function will tell you, how much health has the player. ==Syntax== <syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerHealth(Client player);</syntaxhighlight> '''Requ..."

This function will tell you, how much health has the player.

==Syntax==
<syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerHealth(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''int''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerHealth(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerFromName

2019-11-27T13:22:52Z

Muphy: Created page with "This method returns a Player param from a given player name, returns '''null''' if the player name does not exist. ==Syntax== <syntaxhighlight lang="C#" >Client NAPI.Player.G..."

This method returns a Player param from a given player name, returns '''null''' if the player name does not exist.

==Syntax==
<syntaxhighlight lang="C#" >Client NAPI.Player.GetPlayerFromName(string name);</syntaxhighlight>

'''Required Arguments'''
*'''name:''' parameter input should be in '''string''' type.

'''NOTE:''' This function returns data in '''Client''' type.

==Usage example==
Check if the name Bob exists.
<syntaxhighlight lang="C#" >
bool exists = NAPI.Player.GetPlayerFromName("Bob") != null;
if(exists) NAPI.Chat.SendChatMessageToAll("BOB EXISTS!!!");
</syntaxhighlight>

Kick the Player if their name exists.
<syntaxhighlight lang="C#" >
string name = "Bob";
Client target = NAPI.Player.GetPlayerFromName(name);
bool exists = target != null;
if (exists) NAPI.Player.KickPlayer(target, "Flock you Bob!");
</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerFromHandle

2019-11-27T13:22:27Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >Client NAPI.Player.GetPlayerFromHandle(NetHandle handle);</syntaxhighlight> '''Required Arguments''' *'''handle:''' parameter input sho..."

==Syntax==
<syntaxhighlight lang="C#" >Client NAPI.Player.GetPlayerFromHandle(NetHandle handle);</syntaxhighlight>

'''Required Arguments'''
*'''handle:''' parameter input should be in '''NetHandle''' type.

'''NOTE:''' This function returns data in '''Client''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerFromHandle(handle);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerCurrentWeapon

2019-11-27T13:22:07Z

Muphy: Created page with "This function will tell you which weapon has the player in the hand. See also Weapons Models. ==Syntax== <syntaxhighlight lang="C#" >WeaponHash NAPI.Player.GetPlayerCurre..."

This function will tell you which weapon has the player in the hand. See also [[Weapons Models]].

==Syntax==
<syntaxhighlight lang="C#" >WeaponHash NAPI.Player.GetPlayerCurrentWeapon(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''WeaponHash''' type.

==Usage example(s)==
The example shows an in-game command which will first print out the actual hash code number and on the next line it will display the name of the weapon in use.
<syntaxhighlight lang="C#" >
[Command("checkweapon")]
public void CheckGun(Client player)
{
WeaponHash hashcode = NAPI.Player.GetPlayerCurrentWeapon(player);
NAPI.Chat.SendChatMessageToPlayer(player, "You have a weapon with hash code " + (int)hashcode + "!");
NAPI.Chat.SendChatMessageToPlayer(player, "The weapon name is " + hashcode + "!");
}
</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerArmor

2019-11-27T13:21:29Z

Muphy: Created page with "This function will tell you how much armor has the player. ==Syntax== <syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerArmor(Client player);</syntaxhighlight> '''Require..."

This function will tell you how much armor has the player.

==Syntax==
<syntaxhighlight lang="C#" >int NAPI.Player.GetPlayerArmor(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''int''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerArmor(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerAimingPoint

2019-11-27T13:21:05Z

Muphy: Created page with "Gets the aiming point of a player ==Syntax== <syntaxhighlight lang="C#" >Vector3 NAPI.Player.GetPlayerAimingPoint(Client player);</syntaxhighlight> '''Required Arguments'''..."

Gets the aiming point of a player

==Syntax==
<syntaxhighlight lang="C#" >Vector3 NAPI.Player.GetPlayerAimingPoint(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''Vector3''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerAimingPoint(player);</syntaxhighlight>

[[Category:Serverside API]]

GetPlayerAddress

2019-11-27T13:20:02Z

Muphy: Created page with "Get the address of the player ==Syntax== <syntaxhighlight lang="C#" >string NAPI.Player.GetPlayerAddress(Client player);</syntaxhighlight> '''Required Arguments''' *'''playe..."

Get the address of the player

==Syntax==
<syntaxhighlight lang="C#" >string NAPI.Player.GetPlayerAddress(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

'''NOTE:''' This function returns data in '''string''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.GetPlayerAddress(player);</syntaxhighlight>

[[Category:Serverside API]]

FreezePlayerTime

2019-11-27T13:19:13Z

Muphy: Created page with "Freezes or unfreezes the world time for the given player. ==Syntax== <syntaxhighlight lang="C#" >void NAPI.Player.FreezePlayerTime(Client client, bool freeze);</syntaxhighlig..."

Freezes or unfreezes the world time for the given player.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Player.FreezePlayerTime(Client client, bool freeze);</syntaxhighlight>

'''Required Arguments'''
*'''client:''' parameter input should be in '''Client''' type.
*'''freeze:''' parameter input should be in '''bool''' type.

==Usage example(s)==
<syntaxhighlight lang="C#" >
[Command("freezetime")]
public void FreezeTimeCommand(Client sender, bool frozen)
{
NAPI.Player.FreezePlayerTime(sender, frozen);
}
</syntaxhighlight>

[[Category:Serverside API]]

FreezePlayer

2019-11-27T13:18:24Z

Muphy: Created page with "Freezes or unfreezes a player into their current position. While frozen, they won't be able to move, but their walking and running animations will still play. The player will..."

Freezes or unfreezes a player into their current position. While frozen, they won't be able to move, but their walking and running animations will still play. The player will still be able to do other things, like shooting a weapon.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Player.FreezePlayer(Client player, bool freeze);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''freeze:''' parameter input should be in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >
[Command("freeze")]
public void FreezeCommand(Client sender, bool frozen)
{
NAPI.Player.FreezePlayer(sender, frozen);
}
</syntaxhighlight>

[[Category:Serverside API]]

DoesEntityExistForPlayer

2019-11-27T13:17:57Z

Muphy: Created page with "Checks if an entity exists for the given player. ==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Entity.DoesEntityExistForPlayer(Client player, NetHandle entity);</syntaxhig..."

Checks if an entity exists for the given player.

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Entity.DoesEntityExistForPlayer(Client player, NetHandle entity);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''entity:''' parameter input should be in '''NetHandle''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Entity.DoesEntityExistForPlayer(Client player, NetHandle entity);</syntaxhighlight>

[[Category:Serverside API]]

DetonatePlayerStickies

2019-11-27T13:17:17Z

Muphy: Created page with "Detonates the stickies of a player. ==Syntax== <syntaxhighlight lang="C#" >void NAPI.Player.DetonatePlayerStickies(Client player);</syntaxhighlight> '''Required Arguments'''..."

Detonates the stickies of a player.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Player.DetonatePlayerStickies(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.DetonatePlayerStickies(Client player);</syntaxhighlight>

[[Category:Serverside API]]

ClearPlayerTasks

2019-11-27T13:16:59Z

Muphy: Created page with "Clears all the tasks of the player. ==Syntax== <syntaxhighlight lang="C#" >void NAPI.Player.ClearPlayerTasks(Client player);</syntaxhighlight> '''Required Arguments''' *'''p..."

Clears all the tasks of the player.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Player.ClearPlayerTasks(Client player);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.ClearPlayerTasks(Client player);</syntaxhighlight>

[[Category:Serverside API]]

ClearPlayerAccessory

2019-11-27T13:16:39Z

Muphy: Created page with "This function let's you clear the player accessories. ==Syntax== <syntaxhighlight lang="C#" >void NAPI.Player.ClearPlayerAccessory(Client player, int slot);</syntaxhighlight>..."

This function let's you clear the player accessories.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Player.ClearPlayerAccessory(Client player, int slot);</syntaxhighlight>

'''Required Arguments'''
*'''player:''' parameter input should be in '''Client''' type.
*'''slot:''' parameter input should be in '''int''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Player.ClearPlayerAccessory(Client player, int slot);</syntaxhighlight>

[[Category:Serverside API]]

GetAllEntityData

2019-11-27T01:40:29Z

Muphy:

Gets all keys set in the server's entity data, set with SetEntityData.

==Syntax==
<syntaxhighlight lang="C#" >string[] NAPI.Data.GetAllEntityData(NetHandle entity);</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.

'''NOTE:''' This function returns an array of '''string[]''' type.

==Usage example(s)==
<syntaxhighlight lang="C#">
string[] keys = NAPI.Data.GetAllEntityData(entity);
foreach (string key in keys) {
NAPI.Util.ConsoleOutput("\"{0}\": \"{1}\"", key, NAPI.Data.GetEntityData(entity, key));
}
</syntaxhighlight>

[[Category:Serverside API]]

GetAllEntityData

2019-11-27T01:40:07Z

Muphy: Created page with "Gets all keys set in the server's entity data, set with SetEntityData. ==Syntax== <syntaxhighlight lang="C#" >string[] NAPI.Data.GetAllEntityData(NetHandle entity);</synt..."

Gets all keys set in the server's entity data, set with [[SetEntityData]].

==Syntax==
<syntaxhighlight lang="C#" >string[] NAPI.Data.GetAllEntityData(NetHandle entity);</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.

'''NOTE:''' This function returns an array of '''string[]''' type.

==Usage example(s)==
<syntaxhighlight lang="C#">
string[] keys = NAPI.Data.GetAllEntityData(entity);
foreach (string key in keys) {
NAPI.Util.ConsoleOutput("\"{0}\": \"{1}\"", key, NAPI.Data.GetEntityData(entity, key));
}
</syntaxhighlight>

[[Category:Serverside API]]

SetWorldData

2019-11-27T01:39:41Z

Muphy: Created page with "This function sets world data but the data is only accessible by the server. It is not synced to any client. ==Syntax== <syntaxhighlight lang="C#" >void NAPI.Data.SetWorldDat..."

This function sets world data but the data is only accessible by the server. It is not synced to any client.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Data.SetWorldData(string key, object value);</syntaxhighlight>

'''Required Arguments'''
*'''key:''' parameter input should be in '''string''' type.
*'''value:''' parameter input should be in '''object''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.SetWorldData("mykey", 1);</syntaxhighlight>

[[Category:Serverside API]]

SetEntityData

2019-11-27T01:39:20Z

Muphy: Created page with "Sets the given data value on the entity. This does not synchronize the data to clients. Use SetEntitySharedData if you want this value to synchronize to clients. ==Syntax== <..."

Sets the given data value on the entity. This does not synchronize the data to clients. Use SetEntitySharedData if you want this value to synchronize to clients.

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Data.SetEntityData(NetHandle entity, string key, object value);</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.
*'''key:''' parameter input should be in '''string''' type.
*'''value:''' parameter input can be of any type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#">
NAPI.Data.SetEntityData(player, "Jailtime", 50);
</syntaxhighlight>

[[Category:Serverside API]]

ResetWorldData

2019-11-27T01:38:54Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >void NAPI.Data.ResetWorldData(string key);</syntaxhighlight> '''Required Arguments''' *'''key:''' parameter input should be in '''strin..."

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Data.ResetWorldData(string key);</syntaxhighlight>

'''Required Arguments'''
*'''key:''' parameter input should be in '''string''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.ResetWorldData(key);</syntaxhighlight>

[[Category:Serverside API]]

ResetEntityData

2019-11-27T01:38:36Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >void NAPI.Data.ResetEntityData(NetHandle entity, string key);</syntaxhighlight> '''Required Arguments''' *'''entity:''' parameter input..."

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Data.ResetEntityData(NetHandle entity, string key);</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.
*'''key:''' parameter input should be in '''string''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.ResetEntityData(entity, key);</syntaxhighlight>

[[Category:Serverside API]]

HasWorldData

2019-11-27T01:38:10Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Data.HasWorldData(string key);</syntaxhighlight> '''Required Arguments''' *'''key:''' parameter input should be in '''string'..."

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Data.HasWorldData(string key);</syntaxhighlight>

'''Required Arguments'''
*'''key:''' parameter input should be in '''string''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.HasWorldData(key);</syntaxhighlight>

[[Category:Serverside API]]

HasEntityData

2019-11-27T01:37:49Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >bool NAPI.Data.HasEntityData(NetHandle entity, string key);</syntaxhighlight> '''Required Arguments''' *'''entity:''' parameter input s..."

==Syntax==
<syntaxhighlight lang="C#" >bool NAPI.Data.HasEntityData(NetHandle entity, string key);</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.
*'''key:''' parameter input should be in '''string''' type.

'''NOTE:''' This function returns data in '''bool''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.HasEntityData(entity, key);</syntaxhighlight>

[[Category:Serverside API]]

GetWorldData

2019-11-27T01:37:24Z

Muphy: Created page with "==Syntax== <syntaxhighlight lang="C#" >dynamic NAPI.Data.GetWorldData(string key);</syntaxhighlight> '''Required Arguments''' *'''key:''' parameter input should be in '''stri..."

==Syntax==
<syntaxhighlight lang="C#" >dynamic NAPI.Data.GetWorldData(string key);</syntaxhighlight>

'''Required Arguments'''
*'''key:''' parameter input should be in '''string''' type.

'''NOTE:''' This function returns data in '''dynamic''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.GetWorldData(key);</syntaxhighlight>

[[Category:Serverside API]]

SetEntitySyncedData

2019-11-27T01:37:00Z

Muphy:

Sets the given data value for the given entity and synchronizes this value to clients. Use SetEntityData if the data should only exist on the server and shouldn't be synchronized. Check the Synchronized Types for which types you can synchronize with this..

==Syntax==
<syntaxhighlight lang="C#" >void NAPI.Data.SetEntitySharedData(NetHandle entity, string key, object value);</syntaxhighlight>
<syntaxhighlight lang="C#" >void NAPI.Data.SetEntitySharedData(NetHandle entity, Dictionary<string, object> valueforstring );</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.

'''1. overload:'''
*'''key:''' parameter input should be in '''string''' type.
*'''value:''' parameter input should be in any type.

'''2. overload:'''
*'''valueforstring:''' like 1. overload, but for multiple keys at one time. Parameter input should be in '''Dictionary<string, object>''' type.

==Usage example(s)==
Example Description
<syntaxhighlight lang="C#" >NAPI.Data.SetEntitySharedData(entity, key, value);</syntaxhighlight>

[[Category:Serverside API]]

GetEntityData

2019-11-27T01:36:31Z

Muphy:

Gets entity data that was set with SetEntityData.

Note that this data is in a different state than synced data that you set with SetEntitySharedData. To get synced data, use GetEntitySharedData instead.

==Syntax==
<syntaxhighlight lang="C#" >dynamic NAPI.Data.GetEntityData(NetHandle entity, string key);</syntaxhighlight>

'''Required Arguments'''
*'''entity:''' parameter input should be in '''NetHandle''' type.
*'''key:''' parameter input should be in '''string''' type.

'''NOTE:''' This function returns data in '''dynamic''' type.

==Usage example(s)==
<syntaxhighlight lang="C#">
// Note: Since the return type is dynamic, this will throw an exception if the data is not of type int!
int jailtime = NAPI.Data.GetEntityData(player, "Jailtime");
</syntaxhighlight>

[[Category:Serverside API]]