Version: latest - a1.7.0 ⚖️

👩‍💻 Joueur

info

🟥 Authority: You cannot spawn or Destroy Players.

Les joueurs sont des entités qui représente l'individu derrière son clavier et sa souris. Les joueurs apparaissent automatiquement quand ils sont connectés au serveur.

Utilisation

-- Fait apparaître un personnage et donne la possession au joueur quand il rejoint le serveur.
Player.Subscribe("Spawn", function(player)
    local new_char = Character()
    player:Possess(new_char)
end)

-- Détruit le personnage quand le joueur quitte ke serveur
Player.Subscribe("Destroy", function(player)
        local character = player:GetControlledCharacter()
        if (character) then
                character:Destroy()
        end
end)

Functions

Valeur retournée	Nom	Description
	`Ban`	Bannit le joueur du serveur
	`Connect`	Redirige le joueur sur un autre serveur
	`Kick`	Expulse le joueur du serveur
	`Possess`	Affecte un joueur à un personnage
	`SetCameraLocation`	Configure la position de la caméra du joueur
	`SetCameraRotation`	Configure la rotation de la caméra du joueur
	`SetCameraSocketOffset`	Sets the Player’s Camera Socket Offset
	`SetCameraArmLength`	Sets the Player’s Camera Arm Length
	`AttachCameraTo`	Attaches the Player’s Camera to an Actor
	`ResetCamera`	Resets the Player’s Camera to the default state
	`Spectate`	Spectates another Player
	`SetName`	Change le nom du joueur
	`SetValue`	Place une valeur dans l'entité, qui peut être accédée par n'importe quel package
	`SetVOIPChannel`	Configure le canal VOIP du joueur
	`SetVOIPSetting`	Configure les paramètres VOIP du joueur
	`SetVOIPVolume`	Change le volume VOIP du joueur
	`UnPossess`	Désaffecte le joueur du personnage
string	`GetSteamID`	Accéder au Steam ID
string	`GetAccountID`	Accéder à l'ID du compte nanos world
string	`GetAccountName`	Accéder au nom du compte nanos world
Vector	`GetCameraLocation`	Gets the Player’s Camera Location
Rotator	`GetCameraRotation`	Gets the Player’s Camera Rotation
Character	`GetControlledCharacter`	Returns the character of the player
number	`GetID`	Gets the network ID of this entity
string	`GetIP`	Gets the IP of this Player
string	`GetName`	Returns the player’s name
number	`GetPing`	Returns the ping of a player
string	`GetType`	Returns the type of this Actor
number	`GetVOIPChannel`	Returns the VOIP Channel of this Player
any	`GetValue`	Gets a value given a key
boolean	`IsHost`	Returns if this Player started the server from New Game
boolean	`IsLocalPlayer`	Returns if this is the LocalPlayer
boolean	`IsValid`	Returns if this entity is valid (i.e. wasn’t destroyed and points to a valid entity)
VOIPSetting	`GetVOIPSetting`	Returns this Player VOIP Setting
function	`Subscribe`	Subscribes for an Event
	`Unsubscribe`	Unsubscribes from all subscribed Events in this Entity and in this Package

Events

	Nom	Description
	`Destroy`	Triggered when Player disconnects from the server
	`Possess`	A `Player` was bound to a Character
	`Spawn`	Triggered when Player connects to the server
	`Ready`	Triggered when Player is ready (the client fully joined, loaded the map and all entities and is ready to play)
	`UnPossess`	A Character was released from the `Player`
	`VOIP`	When a Player starts/ends using VOIP

Functions Detailed

`Ban`

Bannit le joueur du serveur

my_player:Ban(reason)

Type	Parameter	Description
string	`reason`

`Connect`

Redirige le joueur sur un autre serveur

my_player:Connect(IP, password = "")

Type	Parameter	Default Value	Description
string	`IP`		IP du serveur
string	`password`	`""`	Mot de passe du serveur

`Kick`

Expulse le joueur du serveur

my_player:Kick(reason)

Type	Parameter	Description
string	`reason`

`Possess`

Makes a Player to possess and control a Character

my_player:Possess(new_character, blend_time, exp)

Type	Parameter	Description
Character	`new_character`
number	`blend_time`	`0`
number	`exp`	`0`

`SetCameraLocation`

Sets the Player's Camera Location (only works if not possessing any Character)

my_player:SetCameraLocation(location)

Type	Parameter	Default	Description
Vector	`location`

`SetCameraRotation`

Sets the Player's Camera Rotation

my_player:SetCameraRotation(rotation)

Type	Parameter	Default	Description
Rotator	`rotation`

`TranslateCameraTo`

Smoothly moves the Player's Camera Location (only works if not possessing any Character)

my_player:TranslateCameraTo(location, time, exp)

Type	Parameter	Default	Description
Vector	`location`
number	`time`		Time to interp from current camera location to target location
number	`exp`	`0`	Exponential used to smooth interp, use `0` for linear movement

`RotateCameraTo`

Smoothly moves the Player's Camera Rotation

my_player:RotateCameraTo(rotation, time, exp)

Type	Parameter	Default	Description
Rotator	`rotation`
number	`time`		Time to interp from current camera rotation to target rotation
number	`exp`	`0`	Exponential used to smooth interp, use `0` for linear movement

`SetCameraSocketOffset`

Sets the Player’s Camera Socket Offset (Spring Arm Offset)

my_player:SetCameraSocketOffset(socket_offset)

Type	Parameter	Default	Description
Vector	`socket_offset`

`SetCameraArmLength`

Sets the Player’s Camera Arm Length (Spring Arm length)

my_player:SetCameraArmLength(length)

Type	Parameter	Default	Description
number	`length`

`AttachCameraTo`

Attaches the Player`s Camera to an Actor

my_player:AttachCameraTo(actor, socket_offset, blend_speed)

Type	Parameter	Default	Description
Actor	`actor`
Vector	`socket_offset`
number	`blend_speed`

`ResetCamera`

Resets the Camera to default state (Unspectate and Detaches)

my_player:ResetCamera()

`Spectate`

Spectates other Player

my_player:Spectate(player, blend_speed)

Type	Parameter	Default	Description
Player	`player`
number	`blend_speed`

`SetName`

Sets the player's name

my_player:SetName(new_name)

Type	Parameter	Description
string	`new_name`

`SetValue`

Sets a value in this entity, which can be accessed by any package (optionally sync on clients if called from server)
Please refer to Entity Values for more information

my_player:SetValue(key, value, sync_on_clients)

Type	Parameter	Default Value	Description
string	`key`		Key
any	`value`		Valeur
boolean	`sync_on_clients`	`false`	Server side parameter, if enabled will sync this value through all clients

`SetVOIPChannel`

Sets the VOIP Channel of this Player (will only communicate with other players in the same channel)

my_player:SetVOIPChannel(channel)

Type	Parameter	Description
number	`channel`

`SetVOIPSetting`

Configure les paramètres VOIP du joueur

my_player:SetVOIPSetting(setting)

Type	Parameter	Description
VOIPSetting	`setting`

`SetVOIPVolume`

Change le volume VOIP du joueur

my_player:SetVOIPSetting(volume)

Type	Parameter	Description
number	`volume`

`UnPossess`

Release the Player from the :ref:Character

my_player:UnPossess()

`GetSteamID`

Accéder au Steam ID
Returns string

my_player:GetSteamID()

`GetAccountID`

Accéder à l'ID du compte nanos world
Returns string

my_player:GetAccountID()

`GetAccountName`

Accéder au nom du compte nanos world
Returns string

my_player:GetAccountName()

`GetCameraLocation`

Gets the Player's Camera Location
Returns Vector

my_player:GetCameraLocation()

`GetCameraRotation`

Gets the Player's Camera Rotation
Returns Rotator

my_player:GetCameraRotation()

`GetControlledCharacter`

Returns the character of the player. If the player has not yet been assigned a character, nil is returned
Returns Character or nil

my_player:GetControlledCharacter()

`GetID`

Gets the network ID of this entity (same in both client and server)
Returns number

my_player:GetID()

`GetIP`

Gets the IP of this Player
Returns string

my_player:GetIP()

`GetName`

Returns the player's name
Returns string

my_player:GetName()

`GetPing`

Returns the ping of a player
Returns number

my_player:GetPing()

`GetType`

Returns the type of this Actor
Returns string

my_player:GetType()

`GetVOIPChannel`

Returns the VOIP Channel of this Player
Valeur retournée VOIPChannel

my_player:GetVOIPChannel()

`GetValue`

Gets a value given a key. Please refer to Entity Values for more information
Returns any

my_player:GetValue(key, fallback)

Type	Parameter	Default Value	Description
string	`key`		Key
any	`fallback`		Fallback Value if key doesn't exist

`IsHost`

Returns if this Player started the server from New Game menu
Returns boolean

my_player:IsHost()

`IsLocalPlayer`

Returns if this is the LocalPlayer
Returns boolean

my_player:IsLocalPlayer()

`IsValid`

Returns if this entity is valid (i.e. wasn't destroyed and points to a valid entity)
Returns boolean

my_player:IsValid()

`GetVOIPSetting`

Returns this Player VOIP Setting
Valeur retournée VOIPSetting

my_player:GetVOIPSetting()

`Subscribe`

Subscribes for an Event
Returns the function callback itself

my_player:Subscribe(event_name, callback)

Type	Parameter	Default Value	Description
string	`event_name`
function	`function`

`Unsubscribe`

Unsubscribes from all subscribed Events in this Entity and in this Package, optionally passing the function to unsubscribe only that callback

my_player:Unsubscribe(event_name, callback)

Type	Parameter	Default Value	Description
string	`event_name`
function	`function`	`nil`

Events Detailed

`Destroy`

Triggered when Player disconnects from the server

Player.Subscribe("Destroy", function(self)

end)

Type	Parameter	Description
Player	`self`

`Possess`

A Player is now controlling a Character

Player.Subscribe("Possess", function(self, character)

end)

Type	Parameter	Description
Player	`self`
Character	`character`

`Spawn`

Triggered when Player connects to the server

Player.Subscribe("Spawn", function(self)

end)

Type	Parameter	Description
Player	`self`

`Ready`

Triggered when Player is ready (the client fully joined, loaded the map and all entities and is ready to play)

Player.Subscribe("Ready", function(self)

end)

Type	Parameter	Description
Player	`self`

`UnPossess`

A Character was released from the Player

Player.Subscribe("UnPossess", function(self, character)

end)

Type	Parameter	Description
Player	`self`
Character	`character`

`VOIP`

When a Player starts/ends using VOIP

Player.Subscribe("VOIP", function(self, is_talking)

end)

Type	Parameter	Description
Player	`self`
boolean	`is_talking`

info

Utilisation​

Functions​

Events​

Functions Detailed​

Ban​

Connect​

Kick​

Possess​

SetCameraLocation​

SetCameraRotation​

TranslateCameraTo​

RotateCameraTo​

SetCameraSocketOffset​

SetCameraArmLength​

AttachCameraTo​

ResetCamera​

Spectate​

SetName​

SetValue​

SetVOIPChannel​

SetVOIPSetting​

SetVOIPVolume​

UnPossess​

GetSteamID​

GetAccountID​

GetAccountName​

GetCameraLocation​

GetCameraRotation​

GetControlledCharacter​

GetID​

GetIP​

GetName​

GetPing​

GetType​

GetVOIPChannel​

GetValue​

IsHost​

IsLocalPlayer​

IsValid​

GetVOIPSetting​

Subscribe​

Unsubscribe​

Events Detailed​

Destroy​

Possess​

Spawn​

Ready​

UnPossess​

VOIP​

Utilisation

Functions

Events

Functions Detailed

`Ban`

`Connect`

`Kick`

`Possess`

`SetCameraLocation`

`SetCameraRotation`

`TranslateCameraTo`

`RotateCameraTo`

`SetCameraSocketOffset`

`SetCameraArmLength`

`AttachCameraTo`

`ResetCamera`

`Spectate`

`SetName`

`SetValue`

`SetVOIPChannel`

`SetVOIPSetting`

`SetVOIPVolume`

`UnPossess`

`GetSteamID`

`GetAccountID`

`GetAccountName`

`GetCameraLocation`

`GetCameraRotation`

`GetControlledCharacter`

`GetID`

`GetIP`

`GetName`

`GetPing`

`GetType`

`GetVOIPChannel`

`GetValue`

`IsHost`

`IsLocalPlayer`

`IsValid`

`GetVOIPSetting`

`Subscribe`

`Unsubscribe`

Events Detailed

`Destroy`

`Possess`

`Spawn`

`Ready`

`UnPossess`

`VOIP`