Classes
Player
Players are Entities that represents the individual behind the mouse and keyboard. Players are spawned automatically when connected to the server.
56 own 35 inherited
Inherits from
EntityPlayer
Static functions 1
Functions 48
- AttachCameraTo Attaches the Player`s Camera to an Actor
- Ban Bans the player from the server
- Connect Redirects the player to another server
- GetAccountIconURL Return a URL which can be used through WebUI and Widgets to display the Player's Steam Avatar (64x64)
- GetAccountID
- GetAccountName
- GetCameraArmLength
- GetCameraLocation
- GetCameraRotation
- GetControlledCharacter
- GetDimension Gets this Player's dimension
- GetIP
- GetName
- GetPing
- GetSteamID
- GetVOIPListeningChannels Returns a list of VOIP channels this player is listening to
- GetVOIPSpeakingChannels Returns a list of VOIP channels this player is currently speaking to
- IsHost
- IsLocalPlayer
- IsVOIPMuted Returns whether VOIP is muted for this player
- Kick Kicks the player from the server
- Possess Makes a Player to possess and control a Pawn (Character)
- ResetCamera Resets the Camera to default state (Unspectate and Detaches)
- RotateCameraTo Smoothly moves the Player's Camera Rotation
- SetCameraArmLength Sets the Player's Camera Arm Length (Spring Arm length)
- SetCameraFOV Sets the Player's Camera FOV (if not possessing a Character)
- SetCameraLocation Sets the Player's Camera Location (only works if not possessing any Character)
- SetCameraRotation Sets the Player's Camera Rotation
- SetCameraSocketOffset Sets the Player's Camera Socket Offset (Spring Arm Offset)
- SetCameraSpeedSettings Sets the Player's Camera Speed Settings (if not possessing a Character)
- SetDimension Sets this Player's dimension
- SetDistanceOptimizationMultiplier Sets this Player's distance optimization multiplier
- SetManualCameraFade Turns on camera fading at the given opacity
- SetName Sets the player's name
- SetVOIPGlobalAllChannelsSetting Sets the VOIP setting for all global channels
- SetVOIPGlobalChannelSetting Sets the VOIP setting for a specific global channel
- SetVOIPGlobalHighPassFilter Sets the global VOIP high-pass filter threshold frequency
- SetVOIPGlobalLowPassFilter Sets the global VOIP low-pass filter threshold frequency
- SetVOIPGlobalVolume Sets the global VOIP volume. It only affects the global channels
- SetVOIPLocalMaxDistance Sets the local/proximity VOIP max distance. This also affects networking usage
- SetVOIPLocalSetting Sets the VOIP setting for the local/proximity
- SetVOIPLocalVolume Sets the local/proximity VOIP input/output volume. It only affects the local/proximity channel
- SetVOIPMuted Mutes or unmutes VOIP for this player
- Spectate Spectates other Player
- StartCameraFade Does a camera fade to/from a solid color
- StopCameraFade Stops camera fading.
- TranslateCameraTo Smoothly moves the Player's Camera Location (only works if not possessing any Character)
- UnPossess Release the Player from the Character
Events 7
- DimensionChange Triggered when a Player changes its dimension
- Possess Triggered when Player starts controlling a Pawn (Character)
- Ready Triggered when Player is ready (the client fully joined, loaded the map and all entities and is ready to play)
- UnPossess A Pawn (Character) was unpossessed from the Player
- VOIP When a Player starts/ends using VOIP
- VOIPGlobalChannelSettingChange Triggered when a global VOIP channel setting changes for this player
- VOIPLocalSettingChange Triggered when the local VOIP setting changes for this player
Inherited members 35
Entity 35
- GetAll Returns a table containing all Entities of the class this is called on
- GetByIndex Returns a specific Entity of this class at an index
- GetCount Returns how many Entities of this class exist
- GetInheritedClasses Gets a list of all directly inherited classes from this Class created with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- GetPairs Returns an iterator with all Entities of this class to be used with <code>pairs()</code>
- GetParentClass Gets the parent class if this Class was created with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- Inherit Inherits this class with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- IsChildOf Gets if this Class is child of another class if this Class was created with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- Subscribe Subscribes to an <a href='/docs/core-concepts/scripting/events-guide'>Event</a> for all entities of this Class
- SubscribeRemote Subscribes to a custom event called from server
- Unsubscribe Unsubscribes all callbacks from this <a href='/docs/core-concepts/scripting/events-guide'>Event</a> in this Class within this Package, or only the callback passed
- BroadcastRemoteEvent Calls a custom remote event directly on this entity to all Players
- BroadcastRemoteInRadiusEvent Calls a custom remote event directly on this entity to all Players in a radius
- CallRemoteEvent Calls a custom remote event directly on this entity
- CallRemotePlayersEvent Calls a custom remote event directly on this entity to a list of Players
- Destroy Destroys this Entity
- FinishSpawn Finish the spawning process and send the entity to clients if it was spawned with a deferred <code>spawn_mode</code>
- GetAllValuesKeys Gets a list of all values keys
- GetClass Gets the class of this entity
- GetID Gets the universal network ID of this Entity (same on both client and server)
- GetValue Gets a <a href='/docs/core-concepts/scripting/entity-values'>Value</a> stored on this Entity at the given key
- HasAuthority Gets if the local context has authority over this Entity (true if spawned by the client, false if spawned by the server)
- IsA Recursively checks if this entity is <a href='/docs/core-concepts/scripting/inheriting-classes'>inherited</a> from a Class
- IsBeingDestroyed Returns true if this Entity is being destroyed
- IsSpawned Gets if this Entity finished spawning
- IsValid Returns true if this Entity is valid (i.e. wasn't destroyed and points to a valid Entity)
- SetSpawnMode Overrides when this Entity finishes spawning, from the Constructor of an Inherited Class
- SetValue Sets a <a href='/docs/core-concepts/scripting/entity-values'>Value</a> in this Entity
- Subscribe Subscribes to an <a href='/docs/core-concepts/scripting/events-guide'>Event</a> on this specific entity
- SubscribeRemote Subscribes to a custom event called from server on this specific entity
- Unsubscribe Unsubscribes all callbacks from this <a href='/docs/core-concepts/scripting/events-guide'>Event</a> in this Entity within this Package, or only the callback passed
- ClassRegister Triggered when a new Class is registered with the <a href='/docs/core-concepts/scripting/inheriting-classes'>Inheriting System</a>
- Destroy Triggered when an Entity is destroyed
- Spawn Triggered when an Entity is spawned/created
- ValueChange Triggered when an Entity has a value changed with <code>:SetValue()</code>