Broke Protocol Game API Reference  1.39
Code reference for server and client scripting
Loading...
Searching...
No Matches
Public Member Functions | List of all members
BrokeProtocol.API.PlayerEvents Class Reference
Inheritance diagram for BrokeProtocol.API.PlayerEvents:
BrokeProtocol.API.MovableEvents BrokeProtocol.API.PhysicalEvents BrokeProtocol.API.DestroyableEvents BrokeProtocol.API.MountableEvents BrokeProtocol.API.DamageableEvents BrokeProtocol.API.EntityEvents BrokeProtocol.API.BaseEvents

Public Member Functions

override bool Initialize (ShEntity entity)
 
override bool Destroy (ShEntity entity)
 
virtual bool Command (ShPlayer player, string message)
 
virtual bool ChatGlobal (ShPlayer player, string message)
 
virtual bool ChatLocal (ShPlayer player, string message)
 
virtual bool ChatVoice (ShPlayer player, byte[] voiceData)
 
virtual bool SetChatMode (ShPlayer player, ChatMode chatMode)
 
virtual bool SetChatChannel (ShPlayer player, ushort channel)
 
virtual bool BuyApartment (ShPlayer player, ShApartment apartment)
 
virtual bool SellApartment (ShPlayer player, ShApartment apartment)
 
virtual bool Invite (ShPlayer player, ShPlayer other)
 
virtual bool KickOut (ShPlayer player, ShPlayer other)
 
override bool Respawn (ShEntity entity)
 
virtual bool Reward (ShPlayer player, int experienceDelta, int moneyDelta)
 
virtual bool Collect (ShPlayer player, ShEntity e, bool consume)
 
virtual bool StopInventory (ShPlayer player, bool sendToSelf)
 
virtual bool ViewInventory (ShPlayer player, ShEntity searchee, bool force)
 
virtual bool Kick (ShPlayer player, ShPlayer other, string reason)
 
virtual bool Ban (ShPlayer player, ShPlayer other, string reason)
 
override bool AddItem (ShEntity entity, int itemIndex, int amount, bool dispatch)
 
override bool RemoveItem (ShEntity entity, int itemIndex, int amount, bool dispatch)
 
virtual bool RemoveItemsDeath (ShPlayer player, bool dropItems)
 
virtual bool Load (ShPlayer player)
 
virtual bool Save (ShPlayer player)
 
virtual bool Injury (ShPlayer player, BodyPart part, BodyEffect effect, byte amount)
 
virtual bool Restrain (ShPlayer player, ShPlayer initiator, ShRestrained restrained)
 
virtual bool Unrestrain (ShPlayer player, ShPlayer initiator)
 
virtual bool ServerInfo (ShPlayer player)
 
virtual bool DisplayName (ShPlayer player, string username)
 
virtual bool EnterDoor (ShPlayer player, ShDoor door, ShPlayer sender, bool forceEnter)
 
virtual bool Follower (ShPlayer player, ShPlayer other)
 
virtual bool OptionAction (ShPlayer player, int targetID, string id, string optionID, string actionID)
 
virtual bool SubmitInput (ShPlayer player, int targetID, string id, string input)
 
virtual bool Ready (ShPlayer player)
 
virtual bool Point (ShPlayer player, bool pointing)
 
virtual bool Alert (ShPlayer player)
 
virtual bool MinigameFinished (ShPlayer player, bool successful, int targetID, string id, string optionID)
 
override bool DestroySelf (ShDestroyable destroyable)
 
override bool TransferItem (ShEntity entity, byte deltaType, int itemIndex, int amount, bool dispatch)
 
virtual bool MenuClosed (ShPlayer player, string id)
 
virtual bool SecurityPanel (ShPlayer player, ShApartment apartment)
 
virtual bool VideoPanel (ShPlayer player, ShEntity entity)
 
virtual bool TextPanelButton (ShPlayer player, string id, string optionID)
 
virtual bool SetEquipable (ShPlayer player, ShEquipable equipable)
 
virtual bool CrackStart (ShPlayer player, int entityID)
 
virtual bool Mount (ShPlayer player, ShMountable mount, byte seat)
 
virtual bool Dismount (ShPlayer player)
 
override bool Spawn (ShEntity entity)
 
virtual bool PlaceItem (ShPlayer player, ShEntity placeableEntity, Vector3 position, Quaternion rotation, float spawnDelay)
 
virtual bool ResetAI (ShPlayer player)
 
virtual bool SetWearable (ShPlayer player, ShWearable wearable)
 
virtual bool RestrainOther (ShPlayer player, ShPlayer hitPlayer, ShRestraint restraint)
 
virtual bool Deposit (ShPlayer player, int entityID, int amount)
 
virtual bool Withdraw (ShPlayer player, int entityID, int amount)
 
virtual bool TryGetJob (ShPlayer player, ShPlayer employer)
 
virtual bool Bomb (ShPlayer player, ShVault vault)
 
virtual bool Repair (ShPlayer player, ShTransport transport)
 
virtual bool Lockpick (ShPlayer player, ShTransport transport)
 
virtual bool Consume (ShPlayer player, ShConsumable consumable, ShPlayer healer)
 
virtual bool TransferShop (ShPlayer player, byte deltaType, int itemIndex, int amount)
 
virtual bool TransferTrade (ShPlayer player, byte deltaType, int itemIndex, int amount)
 
override bool NewSector (ShEntity entity, List< Sector > newSectors)
 
override bool SameSector (ShEntity entity)
 
virtual bool Fire (ShPlayer player)
 
override bool SetParent (ShEntity entity, Transform parent)
 
override bool Damage (ShDamageable damageable, DamageIndex damageIndex, float amount, ShPlayer attacker, Collider collider, Vector3 hitPoint, Vector3 hitNormal)
 
override bool Death (ShDestroyable destroyable, ShPlayer attacker)
 
virtual bool UpdateTextDisplay (ShPlayer player, ShTextDisplay textDisplay)
 
virtual bool SetJob (ShPlayer player, JobInfo newJob, int rank, bool addItems, bool collectCost)
 
virtual bool Park (ShPlayer player, ShTransport transport)
 
virtual bool Tow (ShPlayer player, bool setting)
 
- Public Member Functions inherited from BrokeProtocol.API.DestroyableEvents
virtual bool Heal (ShDestroyable destroyable, float amount, ShPlayer healer)
 
- Public Member Functions inherited from BrokeProtocol.API.EntityEvents
virtual bool SecurityTrigger (ShEntity entity, Collider other)
 
virtual bool MissileLocked (ShEntity entity, ShThrown missile)
 

Member Function Documentation

◆ AddItem()

override bool BrokeProtocol.API.PlayerEvents.AddItem ( ShEntity entity,
int itemIndex,
int amount,
bool dispatch )
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ Alert()

virtual bool BrokeProtocol.API.PlayerEvents.Alert ( ShPlayer player)
virtual

◆ Ban()

virtual bool BrokeProtocol.API.PlayerEvents.Ban ( ShPlayer player,
ShPlayer other,
string reason )
virtual

◆ Bomb()

virtual bool BrokeProtocol.API.PlayerEvents.Bomb ( ShPlayer player,
ShVault vault )
virtual

◆ BuyApartment()

virtual bool BrokeProtocol.API.PlayerEvents.BuyApartment ( ShPlayer player,
ShApartment apartment )
virtual

◆ ChatGlobal()

virtual bool BrokeProtocol.API.PlayerEvents.ChatGlobal ( ShPlayer player,
string message )
virtual

◆ ChatLocal()

virtual bool BrokeProtocol.API.PlayerEvents.ChatLocal ( ShPlayer player,
string message )
virtual

◆ ChatVoice()

virtual bool BrokeProtocol.API.PlayerEvents.ChatVoice ( ShPlayer player,
byte[] voiceData )
virtual

◆ Collect()

virtual bool BrokeProtocol.API.PlayerEvents.Collect ( ShPlayer player,
ShEntity e,
bool consume )
virtual

◆ Command()

virtual bool BrokeProtocol.API.PlayerEvents.Command ( ShPlayer player,
string message )
virtual

◆ Consume()

virtual bool BrokeProtocol.API.PlayerEvents.Consume ( ShPlayer player,
ShConsumable consumable,
ShPlayer healer )
virtual

◆ CrackStart()

virtual bool BrokeProtocol.API.PlayerEvents.CrackStart ( ShPlayer player,
int entityID )
virtual

◆ Damage()

override bool BrokeProtocol.API.PlayerEvents.Damage ( ShDamageable damageable,
DamageIndex damageIndex,
float amount,
ShPlayer attacker,
Collider collider,
Vector3 hitPoint,
Vector3 hitNormal )
virtual

Reimplemented from BrokeProtocol.API.MovableEvents.

◆ Death()

override bool BrokeProtocol.API.PlayerEvents.Death ( ShDestroyable destroyable,
ShPlayer attacker )
virtual

Reimplemented from BrokeProtocol.API.MovableEvents.

◆ Deposit()

virtual bool BrokeProtocol.API.PlayerEvents.Deposit ( ShPlayer player,
int entityID,
int amount )
virtual

◆ Destroy()

override bool BrokeProtocol.API.PlayerEvents.Destroy ( ShEntity entity)
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ DestroySelf()

override bool BrokeProtocol.API.PlayerEvents.DestroySelf ( ShDestroyable destroyable)
virtual

◆ Dismount()

virtual bool BrokeProtocol.API.PlayerEvents.Dismount ( ShPlayer player)
virtual

◆ DisplayName()

virtual bool BrokeProtocol.API.PlayerEvents.DisplayName ( ShPlayer player,
string username )
virtual

◆ EnterDoor()

virtual bool BrokeProtocol.API.PlayerEvents.EnterDoor ( ShPlayer player,
ShDoor door,
ShPlayer sender,
bool forceEnter )
virtual

◆ Fire()

virtual bool BrokeProtocol.API.PlayerEvents.Fire ( ShPlayer player)
virtual

◆ Follower()

virtual bool BrokeProtocol.API.PlayerEvents.Follower ( ShPlayer player,
ShPlayer other )
virtual

◆ Initialize()

override bool BrokeProtocol.API.PlayerEvents.Initialize ( ShEntity entity)
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ Injury()

virtual bool BrokeProtocol.API.PlayerEvents.Injury ( ShPlayer player,
BodyPart part,
BodyEffect effect,
byte amount )
virtual

◆ Invite()

virtual bool BrokeProtocol.API.PlayerEvents.Invite ( ShPlayer player,
ShPlayer other )
virtual

◆ Kick()

virtual bool BrokeProtocol.API.PlayerEvents.Kick ( ShPlayer player,
ShPlayer other,
string reason )
virtual

◆ KickOut()

virtual bool BrokeProtocol.API.PlayerEvents.KickOut ( ShPlayer player,
ShPlayer other )
virtual

◆ Load()

virtual bool BrokeProtocol.API.PlayerEvents.Load ( ShPlayer player)
virtual

◆ Lockpick()

virtual bool BrokeProtocol.API.PlayerEvents.Lockpick ( ShPlayer player,
ShTransport transport )
virtual

◆ MenuClosed()

virtual bool BrokeProtocol.API.PlayerEvents.MenuClosed ( ShPlayer player,
string id )
virtual

◆ MinigameFinished()

virtual bool BrokeProtocol.API.PlayerEvents.MinigameFinished ( ShPlayer player,
bool successful,
int targetID,
string id,
string optionID )
virtual

◆ Mount()

virtual bool BrokeProtocol.API.PlayerEvents.Mount ( ShPlayer player,
ShMountable mount,
byte seat )
virtual

◆ NewSector()

override bool BrokeProtocol.API.PlayerEvents.NewSector ( ShEntity entity,
List< Sector > newSectors )
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ OptionAction()

virtual bool BrokeProtocol.API.PlayerEvents.OptionAction ( ShPlayer player,
int targetID,
string id,
string optionID,
string actionID )
virtual

◆ Park()

virtual bool BrokeProtocol.API.PlayerEvents.Park ( ShPlayer player,
ShTransport transport )
virtual

◆ PlaceItem()

virtual bool BrokeProtocol.API.PlayerEvents.PlaceItem ( ShPlayer player,
ShEntity placeableEntity,
Vector3 position,
Quaternion rotation,
float spawnDelay )
virtual

◆ Point()

virtual bool BrokeProtocol.API.PlayerEvents.Point ( ShPlayer player,
bool pointing )
virtual

◆ Ready()

virtual bool BrokeProtocol.API.PlayerEvents.Ready ( ShPlayer player)
virtual

◆ RemoveItem()

override bool BrokeProtocol.API.PlayerEvents.RemoveItem ( ShEntity entity,
int itemIndex,
int amount,
bool dispatch )
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ RemoveItemsDeath()

virtual bool BrokeProtocol.API.PlayerEvents.RemoveItemsDeath ( ShPlayer player,
bool dropItems )
virtual

◆ Repair()

virtual bool BrokeProtocol.API.PlayerEvents.Repair ( ShPlayer player,
ShTransport transport )
virtual

◆ ResetAI()

virtual bool BrokeProtocol.API.PlayerEvents.ResetAI ( ShPlayer player)
virtual

◆ Respawn()

override bool BrokeProtocol.API.PlayerEvents.Respawn ( ShEntity entity)
virtual

Reimplemented from BrokeProtocol.API.MovableEvents.

◆ Restrain()

virtual bool BrokeProtocol.API.PlayerEvents.Restrain ( ShPlayer player,
ShPlayer initiator,
ShRestrained restrained )
virtual

◆ RestrainOther()

virtual bool BrokeProtocol.API.PlayerEvents.RestrainOther ( ShPlayer player,
ShPlayer hitPlayer,
ShRestraint restraint )
virtual

◆ Reward()

virtual bool BrokeProtocol.API.PlayerEvents.Reward ( ShPlayer player,
int experienceDelta,
int moneyDelta )
virtual

◆ SameSector()

override bool BrokeProtocol.API.PlayerEvents.SameSector ( ShEntity entity)
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ Save()

virtual bool BrokeProtocol.API.PlayerEvents.Save ( ShPlayer player)
virtual

◆ SecurityPanel()

virtual bool BrokeProtocol.API.PlayerEvents.SecurityPanel ( ShPlayer player,
ShApartment apartment )
virtual

◆ SellApartment()

virtual bool BrokeProtocol.API.PlayerEvents.SellApartment ( ShPlayer player,
ShApartment apartment )
virtual

◆ ServerInfo()

virtual bool BrokeProtocol.API.PlayerEvents.ServerInfo ( ShPlayer player)
virtual

◆ SetChatChannel()

virtual bool BrokeProtocol.API.PlayerEvents.SetChatChannel ( ShPlayer player,
ushort channel )
virtual

◆ SetChatMode()

virtual bool BrokeProtocol.API.PlayerEvents.SetChatMode ( ShPlayer player,
ChatMode chatMode )
virtual

◆ SetEquipable()

virtual bool BrokeProtocol.API.PlayerEvents.SetEquipable ( ShPlayer player,
ShEquipable equipable )
virtual

◆ SetJob()

virtual bool BrokeProtocol.API.PlayerEvents.SetJob ( ShPlayer player,
JobInfo newJob,
int rank,
bool addItems,
bool collectCost )
virtual

◆ SetParent()

override bool BrokeProtocol.API.PlayerEvents.SetParent ( ShEntity entity,
Transform parent )
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ SetWearable()

virtual bool BrokeProtocol.API.PlayerEvents.SetWearable ( ShPlayer player,
ShWearable wearable )
virtual

◆ Spawn()

override bool BrokeProtocol.API.PlayerEvents.Spawn ( ShEntity entity)
virtual

Reimplemented from BrokeProtocol.API.MovableEvents.

◆ StopInventory()

virtual bool BrokeProtocol.API.PlayerEvents.StopInventory ( ShPlayer player,
bool sendToSelf )
virtual

◆ SubmitInput()

virtual bool BrokeProtocol.API.PlayerEvents.SubmitInput ( ShPlayer player,
int targetID,
string id,
string input )
virtual

◆ TextPanelButton()

virtual bool BrokeProtocol.API.PlayerEvents.TextPanelButton ( ShPlayer player,
string id,
string optionID )
virtual

◆ Tow()

virtual bool BrokeProtocol.API.PlayerEvents.Tow ( ShPlayer player,
bool setting )
virtual

◆ TransferItem()

override bool BrokeProtocol.API.PlayerEvents.TransferItem ( ShEntity entity,
byte deltaType,
int itemIndex,
int amount,
bool dispatch )
virtual

Reimplemented from BrokeProtocol.API.EntityEvents.

◆ TransferShop()

virtual bool BrokeProtocol.API.PlayerEvents.TransferShop ( ShPlayer player,
byte deltaType,
int itemIndex,
int amount )
virtual

◆ TransferTrade()

virtual bool BrokeProtocol.API.PlayerEvents.TransferTrade ( ShPlayer player,
byte deltaType,
int itemIndex,
int amount )
virtual

◆ TryGetJob()

virtual bool BrokeProtocol.API.PlayerEvents.TryGetJob ( ShPlayer player,
ShPlayer employer )
virtual

◆ Unrestrain()

virtual bool BrokeProtocol.API.PlayerEvents.Unrestrain ( ShPlayer player,
ShPlayer initiator )
virtual

◆ UpdateTextDisplay()

virtual bool BrokeProtocol.API.PlayerEvents.UpdateTextDisplay ( ShPlayer player,
ShTextDisplay textDisplay )
virtual

◆ VideoPanel()

virtual bool BrokeProtocol.API.PlayerEvents.VideoPanel ( ShPlayer player,
ShEntity entity )
virtual

◆ ViewInventory()

virtual bool BrokeProtocol.API.PlayerEvents.ViewInventory ( ShPlayer player,
ShEntity searchee,
bool force )
virtual

◆ Withdraw()

virtual bool BrokeProtocol.API.PlayerEvents.Withdraw ( ShPlayer player,
int entityID,
int amount )
virtual

The documentation for this class was generated from the following file: