Broke Protocol Game API Reference  1.39
Code reference for server and client scripting
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
BrokeProtocol.Entities.ClPlayer Class Reference
Inheritance diagram for BrokeProtocol.Entities.ClPlayer:
BrokeProtocol.Entities.ClMovable BrokeProtocol.Entities.ClPhysical BrokeProtocol.Entities.ClDestroyable BrokeProtocol.Entities.ClMountable BrokeProtocol.Entities.ClDamageable BrokeProtocol.Entities.ClEntity BrokeProtocol.Client.Buttons.ClActionable

Classes

struct  Bone
 

Public Member Functions

void UpdateVoiceVolume ()
 
GameObject GetIdentity ()
 
void NameLoop (Text t)
 
void MessageLoop (Text t)
 
void IconLoop (SpriteRenderer r)
 
override void RefreshActions ()
 
void Jump ()
 
override void ClMove ()
 
void BuyApartment (int apartmentID, int placeIndex)
 
void SellApartment (int apartmentID)
 
void Experience (int experience, bool showMessage)
 
void Rank (int rank)
 
void SetStance (StanceIndex stanceIndex)
 
void SetJob (int jobIndex)
 
override void Initialize ()
 
override void Destroy ()
 
void ResetBones ()
 
IEnumerator Footsteps ()
 
override void ReadActivateData ()
 
IEnumerator SendUpdatesToServer ()
 
void AssignToActor (SkinnedMeshRenderer wearableRenderer)
 
void ChatVoice (int sourceID, byte[] data, ChatMode mode=ChatMode.Public)
 
void Spectate (int targetID)
 
void View (int entityID, byte[] inventoryArray)
 
void Shopping (int entityID, byte[] inventoryArray)
 
void ShowTradeInventory (int entityID)
 
void ShowSearchedInventory ()
 
void SetEquipable (int equipableIndex)
 
void LockButtons ()
 
void UnlockButtons (bool lockedTrade)
 
void FinishTrade (bool isGood)
 
void UpdateShopValue (int itemIndex, int newValue)
 
void UpdateMountAmmo (int ammoCount)
 
void Mount (int mountableID, byte enterSeat, int ammoCount=-1)
 
void Dismount ()
 
override void UpdateHealth (float newHealth, bool activate)
 
IEnumerator RaycastEntities ()
 
override void ReadInitData ()
 
void DisplayName (string displayName)
 
void DeserializeHealth (byte[] healthArray)
 
void DeserializeAttachments (byte[] attachmentArray)
 
void DeserializeWearables (byte[] wearableArray)
 
- Public Member Functions inherited from BrokeProtocol.Entities.ClPhysical
virtual void SetControlledPhysics (bool setting)
 
override void TurnOn ()
 
override void TurnOff ()
 
void UpdateLatestState (Vector3 position, Quaternion rotation)
 
void ForceLatestState ()
 
- Public Member Functions inherited from BrokeProtocol.Entities.ClMountable
void PlayAlert ()
 
- Public Member Functions inherited from BrokeProtocol.Entities.ClEntity
void DeserializeAnimator (byte[] stateArray)
 
void DeserializeParameters (byte[] stateArray)
 
bool TypeActionTest (string type)
 
virtual void Relocate (Vector3 position, Quaternion rotation, bool zeroVelocity)
 
void StartMapMarker (Color color)
 
void DestroyMapMarker ()
 
void VideoPlay (string videoURL, float startTime)
 
void VideoStop ()
 
void ClDestroyEffect (int destroyEffectIndex)
 
- Public Member Functions inherited from BrokeProtocol.Client.Buttons.ClActionable
virtual void FinishedActions ()
 

Public Attributes

JobInfoShared job
 
SkinnedMeshRenderer skinnedMeshRenderer
 
Transform headBone
 
AudioSource hurtSound
 
Voice voice
 
RectTransform textTransform
 
GameObject identityObject
 
float voiceVolume = 1f
 
- Public Attributes inherited from BrokeProtocol.Entities.ClPhysical
NetState latestState = new NetState()
 
NetState previousState = new NetState()
 
- Public Attributes inherited from BrokeProtocol.Entities.ClEntity
SpriteRenderer mapMarkerSprite
 
ClManager clManager
 
bool isMain
 
VideoPlayer videoPlayer
 
RawImage videoImage
 
- Public Attributes inherited from BrokeProtocol.Client.Buttons.ClActionable
List< ActionInfoactions
 

Protected Member Functions

void FollowerAction ()
 
bool InviteTest ()
 
void InviteAction ()
 
bool KickOutTest ()
 
void KickOutAction ()
 
override bool ShopTest ()
 
bool TradeTest ()
 
void TradeRequestAction ()
 
bool ActiveBossTest ()
 
bool GetJobTest ()
 
bool QuitJobTest ()
 
void GetJobAction ()
 
void QuitJobAction ()
 
bool FreeTest ()
 
void FreeAction ()
 
void ShowHealthAction ()
 
bool DisembarkTest ()
 
void DisembarkAction ()
 
void Update ()
 
void LateUpdate ()
 
override void SetVelocities ()
 
- Protected Member Functions inherited from BrokeProtocol.Entities.ClPhysical
void LinearVelocity ()
 
IEnumerator Resetter ()
 
void OnCollisionEnter (Collision collision)
 
- Protected Member Functions inherited from BrokeProtocol.Entities.ClMountable
bool MountTest ()
 
void MountAction ()
 
bool EmbarkTest ()
 
void EmbarkAction ()
 
- Protected Member Functions inherited from BrokeProtocol.Entities.ClEntity
void EventAction (string eventName)
 
virtual bool CollectTest ()
 
void CollectAction ()
 
void ShopAction ()
 
bool ViewTest ()
 
void ViewAction ()
 
virtual bool CrackTest ()
 
void CrackAction ()
 
virtual bool BuyEntityTest ()
 
void GetEntityValueAction ()
 
virtual bool AppsTest ()
 
void AppsAction ()
 
bool VideoPanelTest ()
 
void VideoPanelAction ()
 
bool VideoSyncTest ()
 
void VideoPlayerReady (VideoPlayer source)
 
void VideoSyncAction ()
 

Protected Attributes

ShPlayer player
 
Rigidbody[] ragdollBodies
 
Collider[] ragdollColliders
 
AudioSource footstepSource
 
float blendStartTime
 
Bone[] bones
 
Coroutine nameCoroutine
 
Coroutine messageCoroutine
 
Coroutine iconCoroutine
 
- Protected Attributes inherited from BrokeProtocol.Entities.ClMovable
ShMovable movable
 
- Protected Attributes inherited from BrokeProtocol.Entities.ClPhysical
ShPhysical physical
 
AudioClip[] collisionClips = null
 
AudioSource collisionSource = null
 
- Protected Attributes inherited from BrokeProtocol.Entities.ClDestroyable
ShDestroyable destroyable
 
- Protected Attributes inherited from BrokeProtocol.Entities.ClMountable
ShMountable mountable
 
AudioSource horn
 
- Protected Attributes inherited from BrokeProtocol.Entities.ClEntity
ShEntity entity
 
LabelID[] eventActions
 
bool videoReadyAndPlaying
 
RenderTexture renderTexture
 

Properties

bool SpecMain [get]
 
bool FirstPerson [get]
 
bool EquipmentAimed [get]
 
- Properties inherited from BrokeProtocol.Entities.ClMountable
virtual bool ClientController [get]
 
- Properties inherited from BrokeProtocol.Entities.ClEntity
bool InventoryTest [get]
 

Member Function Documentation

◆ ActiveBossTest()

bool BrokeProtocol.Entities.ClPlayer.ActiveBossTest ( )
protected

◆ AssignToActor()

void BrokeProtocol.Entities.ClPlayer.AssignToActor ( SkinnedMeshRenderer wearableRenderer)
inline

◆ BuyApartment()

void BrokeProtocol.Entities.ClPlayer.BuyApartment ( int apartmentID,
int placeIndex )
inline

◆ ChatVoice()

void BrokeProtocol.Entities.ClPlayer.ChatVoice ( int sourceID,
byte[] data,
ChatMode mode = ChatMode::Public )
inline

◆ ClMove()

override void BrokeProtocol.Entities.ClPlayer.ClMove ( )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ClPhysical.

◆ DeserializeAttachments()

void BrokeProtocol.Entities.ClPlayer.DeserializeAttachments ( byte[] attachmentArray)
inline

◆ DeserializeHealth()

void BrokeProtocol.Entities.ClPlayer.DeserializeHealth ( byte[] healthArray)
inline

◆ DeserializeWearables()

void BrokeProtocol.Entities.ClPlayer.DeserializeWearables ( byte[] wearableArray)
inline

◆ Destroy()

override void BrokeProtocol.Entities.ClPlayer.Destroy ( )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ClEntity.

◆ DisembarkAction()

void BrokeProtocol.Entities.ClPlayer.DisembarkAction ( )
protected

◆ DisembarkTest()

bool BrokeProtocol.Entities.ClPlayer.DisembarkTest ( )
protected

◆ Dismount()

void BrokeProtocol.Entities.ClPlayer.Dismount ( )
inline

◆ DisplayName()

void BrokeProtocol.Entities.ClPlayer.DisplayName ( string displayName)

◆ Experience()

void BrokeProtocol.Entities.ClPlayer.Experience ( int experience,
bool showMessage )
inline

◆ FinishTrade()

void BrokeProtocol.Entities.ClPlayer.FinishTrade ( bool isGood)
inline

◆ FollowerAction()

void BrokeProtocol.Entities.ClPlayer.FollowerAction ( )
protected

◆ Footsteps()

IEnumerator BrokeProtocol.Entities.ClPlayer.Footsteps ( )
inline

◆ FreeAction()

void BrokeProtocol.Entities.ClPlayer.FreeAction ( )
protected

◆ FreeTest()

bool BrokeProtocol.Entities.ClPlayer.FreeTest ( )
protected

◆ GetIdentity()

GameObject BrokeProtocol.Entities.ClPlayer.GetIdentity ( )
inline

◆ GetJobAction()

void BrokeProtocol.Entities.ClPlayer.GetJobAction ( )
protected

◆ GetJobTest()

bool BrokeProtocol.Entities.ClPlayer.GetJobTest ( )
protected

◆ IconLoop()

void BrokeProtocol.Entities.ClPlayer.IconLoop ( SpriteRenderer r)
inline

◆ Initialize()

override void BrokeProtocol.Entities.ClPlayer.Initialize ( )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ClPhysical.

◆ InviteAction()

void BrokeProtocol.Entities.ClPlayer.InviteAction ( )
protected

◆ InviteTest()

bool BrokeProtocol.Entities.ClPlayer.InviteTest ( )
inlineprotected

◆ Jump()

void BrokeProtocol.Entities.ClPlayer.Jump ( )
inline

◆ KickOutAction()

void BrokeProtocol.Entities.ClPlayer.KickOutAction ( )
protected

◆ KickOutTest()

bool BrokeProtocol.Entities.ClPlayer.KickOutTest ( )
protected

◆ LateUpdate()

void BrokeProtocol.Entities.ClPlayer.LateUpdate ( )
inlineprotected

◆ LockButtons()

void BrokeProtocol.Entities.ClPlayer.LockButtons ( )
inline

◆ MessageLoop()

void BrokeProtocol.Entities.ClPlayer.MessageLoop ( Text t)
inline

◆ Mount()

void BrokeProtocol.Entities.ClPlayer.Mount ( int mountableID,
byte enterSeat,
int ammoCount = -1 )
inline

◆ NameLoop()

void BrokeProtocol.Entities.ClPlayer.NameLoop ( Text t)
inline

◆ QuitJobAction()

void BrokeProtocol.Entities.ClPlayer.QuitJobAction ( )
protected

◆ QuitJobTest()

bool BrokeProtocol.Entities.ClPlayer.QuitJobTest ( )
protected

◆ Rank()

void BrokeProtocol.Entities.ClPlayer.Rank ( int rank)
inline

◆ RaycastEntities()

IEnumerator BrokeProtocol.Entities.ClPlayer.RaycastEntities ( )
inline

◆ ReadActivateData()

override void BrokeProtocol.Entities.ClPlayer.ReadActivateData ( )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ClPhysical.

◆ ReadInitData()

override void BrokeProtocol.Entities.ClPlayer.ReadInitData ( )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ClMovable.

◆ RefreshActions()

override void BrokeProtocol.Entities.ClPlayer.RefreshActions ( )
inlinevirtual

◆ ResetBones()

void BrokeProtocol.Entities.ClPlayer.ResetBones ( )
inline

◆ SellApartment()

void BrokeProtocol.Entities.ClPlayer.SellApartment ( int apartmentID)
inline

◆ SendUpdatesToServer()

IEnumerator BrokeProtocol.Entities.ClPlayer.SendUpdatesToServer ( )
inline

◆ SetEquipable()

void BrokeProtocol.Entities.ClPlayer.SetEquipable ( int equipableIndex)
inline

◆ SetJob()

void BrokeProtocol.Entities.ClPlayer.SetJob ( int jobIndex)
inline

◆ SetStance()

void BrokeProtocol.Entities.ClPlayer.SetStance ( StanceIndex stanceIndex)
inline

◆ SetVelocities()

override void BrokeProtocol.Entities.ClPlayer.SetVelocities ( )
inlineprotectedvirtual

Reimplemented from BrokeProtocol.Entities.ClPhysical.

◆ Shopping()

void BrokeProtocol.Entities.ClPlayer.Shopping ( int entityID,
byte[] inventoryArray )
inline

◆ ShopTest()

override bool BrokeProtocol.Entities.ClPlayer.ShopTest ( )
protectedvirtual

Reimplemented from BrokeProtocol.Entities.ClEntity.

◆ ShowHealthAction()

void BrokeProtocol.Entities.ClPlayer.ShowHealthAction ( )
protected

◆ ShowSearchedInventory()

void BrokeProtocol.Entities.ClPlayer.ShowSearchedInventory ( )

◆ ShowTradeInventory()

void BrokeProtocol.Entities.ClPlayer.ShowTradeInventory ( int entityID)
inline

◆ Spectate()

void BrokeProtocol.Entities.ClPlayer.Spectate ( int targetID)
inline

◆ TradeRequestAction()

void BrokeProtocol.Entities.ClPlayer.TradeRequestAction ( )
protected

◆ TradeTest()

bool BrokeProtocol.Entities.ClPlayer.TradeTest ( )
protected

◆ UnlockButtons()

void BrokeProtocol.Entities.ClPlayer.UnlockButtons ( bool lockedTrade)
inline

◆ Update()

void BrokeProtocol.Entities.ClPlayer.Update ( )
inlineprotected

◆ UpdateHealth()

override void BrokeProtocol.Entities.ClPlayer.UpdateHealth ( float newHealth,
bool activate )
inlinevirtual

◆ UpdateMountAmmo()

void BrokeProtocol.Entities.ClPlayer.UpdateMountAmmo ( int ammoCount)
inline

◆ UpdateShopValue()

void BrokeProtocol.Entities.ClPlayer.UpdateShopValue ( int itemIndex,
int newValue )
inline

◆ UpdateVoiceVolume()

void BrokeProtocol.Entities.ClPlayer.UpdateVoiceVolume ( )
inline

◆ View()

void BrokeProtocol.Entities.ClPlayer.View ( int entityID,
byte[] inventoryArray )
inline

Member Data Documentation

◆ blendStartTime

float BrokeProtocol.Entities.ClPlayer.blendStartTime
protected

◆ bones

Bone [] BrokeProtocol.Entities.ClPlayer.bones
protected

◆ footstepSource

AudioSource BrokeProtocol.Entities.ClPlayer.footstepSource
protected

◆ headBone

Transform BrokeProtocol.Entities.ClPlayer.headBone

◆ hurtSound

AudioSource BrokeProtocol.Entities.ClPlayer.hurtSound

◆ iconCoroutine

Coroutine BrokeProtocol.Entities.ClPlayer.iconCoroutine
protected

◆ identityObject

GameObject BrokeProtocol.Entities.ClPlayer.identityObject

◆ job

JobInfoShared BrokeProtocol.Entities.ClPlayer.job

◆ messageCoroutine

Coroutine BrokeProtocol.Entities.ClPlayer.messageCoroutine
protected

◆ nameCoroutine

Coroutine BrokeProtocol.Entities.ClPlayer.nameCoroutine
protected

◆ player

ShPlayer BrokeProtocol.Entities.ClPlayer.player
protected

◆ ragdollBodies

Rigidbody [] BrokeProtocol.Entities.ClPlayer.ragdollBodies
protected

◆ ragdollColliders

Collider [] BrokeProtocol.Entities.ClPlayer.ragdollColliders
protected

◆ skinnedMeshRenderer

SkinnedMeshRenderer BrokeProtocol.Entities.ClPlayer.skinnedMeshRenderer

◆ textTransform

RectTransform BrokeProtocol.Entities.ClPlayer.textTransform

◆ voice

Voice BrokeProtocol.Entities.ClPlayer.voice

◆ voiceVolume

float BrokeProtocol.Entities.ClPlayer.voiceVolume = 1f

Property Documentation

◆ EquipmentAimed

bool BrokeProtocol.Entities.ClPlayer.EquipmentAimed
get

◆ FirstPerson

bool BrokeProtocol.Entities.ClPlayer.FirstPerson
get

◆ SpecMain

bool BrokeProtocol.Entities.ClPlayer.SpecMain
get

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