Broke Protocol Game API Reference  1.39
Code reference for server and client scripting
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
BrokeProtocol.Entities.ShMountable Class Reference
Inheritance diagram for BrokeProtocol.Entities.ShMountable:
BrokeProtocol.Entities.ShDamageable BrokeProtocol.Entities.ShEntity BrokeProtocol.Entities.Serialized BrokeProtocol.Entities.ShDestroyable BrokeProtocol.Entities.ShItem BrokeProtocol.Entities.ShDamage BrokeProtocol.Entities.ShPhysical BrokeProtocol.Entities.ShAttachment BrokeProtocol.Entities.ShEquipable BrokeProtocol.Entities.ShWearable BrokeProtocol.Entities.ShFire BrokeProtocol.Entities.ShMovable BrokeProtocol.Entities.ShThrown BrokeProtocol.Entities.ShMuzzle BrokeProtocol.Entities.ShSight BrokeProtocol.Entities.ShUnderbarrel BrokeProtocol.Entities.ShLight BrokeProtocol.Entities.ShShield BrokeProtocol.Entities.ShUsable

Public Member Functions

virtual void Reload ()
 
void UpdatePrimaryAmmo (int delta)
 
void UpdateSecondaryAmmo (int delta)
 
virtual bool CanUse ()
 
override void PreInitialize (int ID)
 
override void Initialize ()
 
virtual Vector3 GetWeaponPosition ()
 
virtual Vector3 GetWeaponVector ()
 
virtual void ResetAmmo ()
 
override void Spawn (Vector3 position, Quaternion rotation, Transform placeT)
 
void Rearm (float amount)
 
virtual void Mounted (ShPlayer occupant, int enterSeat)
 
virtual bool IsAccessible (ShPlayer attempter, bool checkOwner)
 
virtual void ResetInputs ()
 
override void Restore (Vector3 position, Quaternion rotation, Transform placeT)
 
void IncrementFireTime (float delay)
 
void MountFire ()
 
override void CleanUp ()
 
- Public Member Functions inherited from BrokeProtocol.Entities.ShDamageable
virtual void HitEffect (Collider collider, DamageIndex damageIndex, Vector3 point, Vector3 normal)
 
- Public Member Functions inherited from BrokeProtocol.Entities.ShEntity
Bounds GetWorldBounds ()
 
override void CheckSave ()
 
float GetLocalY (Vector3 worldPosition)
 
float GetFlatAngle (Vector3 v)
 
virtual bool InActionRange (ShEntity e)
 
bool CanSeeEntity (ShEntity other, bool checkInFront=false, float viewRange=Util.visibleRange)
 
bool GetOverlapEntity< T > (Vector3 position, Quaternion rotation, int maskIndex, float extentsMultiplier, Predicate< T > predicate, out T entity)
 
bool CanSpawn (Vector3 position, Quaternion rotation, ShEntity[] ignoreArray)
 
bool CanSee (Vector3 position)
 
float Distance (ShEntity other)
 
float DistanceSqr (ShEntity other)
 
float DistanceSqr2D (ShEntity other)
 
float DistanceSqr2D (Vector3 other)
 
float Distance (Vector3 other)
 
float DistanceSqr (Vector3 other)
 
virtual void DestroyExtras ()
 
void SetParent (Transform parent)
 
void SetPosition (Vector3 position)
 
virtual void SetRotation (Quaternion rotation)
 
void SetPositionSafe (Vector3 targetPosition)
 
virtual void Destroy ()
 
void DeactivateEntity ()
 
void IgnoreCollision (ShPlayer p, bool ignore)
 
IEnumerator ResetCollisions (ShPlayer p)
 
virtual void SetTransform (Vector3 position, Quaternion rotation, bool zeroVelocity)
 
int InventoryValue ()
 
int GetMyItemValue (ShItem item, bool markup)
 
void SendViewerDelta (byte delta, int itemIndex, int amount, ShPlayer ignorePlayer)
 
void TransferMoney (byte deltaType, int amount=1, bool dispatch=true)
 
void TransferItem (byte deltaType, ShItem item, int amount=1, bool dispatch=true)
 
bool ValidTransfer (int itemIndex, int amount)
 
virtual void TransferItem (byte deltaType, int itemIndex, int amount=1, bool dispatch=true)
 
byte[] SerializeMyItems ()
 
SizedArray SerializeShop ()
 
void DeserializeMyItems (byte[] inventoryArray)
 
void DeserializeShop (byte[] inventoryArray)
 
virtual void AddToMyItems (int itemIndex, int amount, bool dispatch)
 
void AddToTradeItems (int itemIndex, int amount)
 
virtual void RemoveFromMyItems (int itemIndex, int amount, bool dispatch)
 
void RemoveFromTradeItems (int itemIndex, int amount)
 
virtual bool CanBeSearched (ShPlayer p)
 
bool CanBeCracked (ShPlayer p)
 
int ItemCount (Dictionary< int, InventoryItem > inventory, int itemIndex)
 
bool HasItem (ShItem item)
 
bool HasItem (int itemIndex)
 
int MyItemCount (ShEntity item)
 
int TradeItemCount (ShEntity item)
 
int MyItemCount (int itemIndex)
 
int TradeItemCount (int itemIndex)
 
void ClearAllViewers ()
 
void RemoveViewer (ShPlayer viewer)
 
bool ShopCanBuy (ShItem item)
 
- Public Member Functions inherited from BrokeProtocol.Entities.Serialized
virtual void InitializeEditor ()
 
virtual void BoundsHighlightAdd ()
 
virtual void BoundsHighlightRemove ()
 
void Trigger (Collider collider, string eventName, bool enter)
 

Public Attributes

ClMountable clMountable
 
SvMountable svMountable
 
Seat[] seats
 
Transform[] exitTransforms
 
float viewAngleLimit = 89f
 
Transform turretT
 
Transform barrelT
 
WeaponSet[] weaponSets
 
int weaponIndex
 
Vector2 recoilP
 
Vector2 recoilV
 
ShPlayer[] occupants
 
float nextFire
 
- Public Attributes inherited from BrokeProtocol.Entities.ShDamageable
SvDamageable svDamageable
 
- Public Attributes inherited from BrokeProtocol.Entities.ShEntity
ClEntity clEntity
 
SvEntity svEntity
 
Animator animator
 
bool syncAnimator
 
ShPlayer controller
 
Dictionary< string, string > dynamicActions = new ()
 
bool isHuman
 
float videoStartTime
 
string profile = string.Empty
 
bool isWorldEntity
 
Renderer[] renderers
 
AppIndex[] availableApps
 
InventoryType inventoryType
 
Dictionary< int, InventoryItem > myItems = new ()
 
Dictionary< int, InventoryItem > tradeItems = new ()
 
HashSet< ShPlayer > viewers = new ()
 
HashSet< Collider > colliders
 
int ID
 
int index
 
ShManager manager
 
int value
 
int respawnFrame
 
Vector3 relativeVelocity
 
Bounds bounds
 
- Public Attributes inherited from BrokeProtocol.Entities.Serialized
string referencePrefab
 
GameObject go
 
Transform mainT
 
string data
 
BoundsHighlight highlight
 

Protected Member Functions

void DeltaClip (int delta)
 
IEnumerator RearmLoop ()
 
IEnumerator MoveTurret ()
 
- Protected Member Functions inherited from BrokeProtocol.Entities.ShEntity
virtual void UpdateMainColliders ()
 
InventoryItem DeserializeItem (byte[] itemArray)
 
InventoryItem DeserializeShopItem (byte[] itemArray)
 
void AddToInventory (Dictionary< int, InventoryItem > inventory, int itemIndex, int amount)
 
void RemoveFromInventory (Dictionary< int, InventoryItem > inventory, int itemIndex, int amount)
 

Properties

float NormalizedRecoilAmount [get]
 
virtual bool UsePathfinding [get]
 
WeaponSet WeaponSet [get]
 
virtual int ClipSize [get]
 
virtual int CurrentClip [get, set]
 
virtual bool CanReload [get]
 
virtual bool ServersideAmmo [get]
 
virtual ShItem AmmoItem [get]
 
int AmmoTotal [get]
 
virtual bool UseClips [get]
 
virtual bool MustAim [get]
 
virtual float Range [get]
 
virtual float Damage [get]
 
virtual bool CanLockOn [get]
 
bool ThrownHasGuidance [get]
 
virtual float CameraDistance [get]
 
override ShMountable GetMount [get]
 
bool CheckHitscans [get]
 
virtual bool ServersidePhysics [get]
 
bool IsSimulated [get]
 
bool HasWeapons [get]
 
virtual float WeaponVelocity [get]
 
float WeaponGravity [get]
 
float ThrownVelocity [get]
 
virtual float UseDelay [get]
 
- Properties inherited from BrokeProtocol.Entities.ShEntity
virtual bool IsDead [get]
 
virtual bool SyncTransform [get]
 
virtual Collider Ground [get]
 
virtual ShEntity SpecEntity [get]
 
bool SpecSelf [get]
 
override SerializedParameters Parameters [get]
 
override Type EditorType [get]
 
virtual ShMountable GetMount [get]
 
virtual ShPlayer Player [get]
 
virtual Vector3 Velocity [get, set]
 
virtual Vector3 GetOrigin [get]
 
virtual float MountHealth [get]
 
override bool SendInitial [get]
 
virtual InventoryStruct[] CollectedItems [get]
 
bool IsClientMain [get]
 
virtual float ProcessDuration [get]
 
Bounds ScaledBounds [get]
 
Vector3 CenterBounds [get]
 
bool HasInventory [get]
 
bool Shop [get]
 
int MyMoneyCount [get]
 
int TradeMoneyCount [get]
 
- Properties inherited from BrokeProtocol.Entities.Serialized
virtual bool SendInitial [get]
 
virtual SerializedParameters Parameters [get]
 
virtual Type EditorType [get]
 
ChildIndex GetChildIndex [get]
 
virtual Transform GetRotationT [get]
 
virtual Quaternion GetRotation [get]
 
Transform GetParent [get]
 
bool IsOutside [get]
 
int GetPlaceIndex [get]
 
Place GetPlace [get]
 
Vector3 GetPosition [get]
 
string LogPosition [get]
 
virtual Vector3 CenterBuoyancy [get]
 
virtual bool InWater [get]
 

Member Function Documentation

◆ CanUse()

virtual bool BrokeProtocol.Entities.ShMountable.CanUse ( )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShGun.

◆ CleanUp()

override void BrokeProtocol.Entities.ShMountable.CleanUp ( )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ShEntity.

Reimplemented in BrokeProtocol.Entities.ShPlayer, and BrokeProtocol.Entities.ShTransport.

◆ DeltaClip()

void BrokeProtocol.Entities.ShMountable.DeltaClip ( int delta)
protected

◆ GetWeaponPosition()

virtual Vector3 BrokeProtocol.Entities.ShMountable.GetWeaponPosition ( )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShEquipable.

◆ GetWeaponVector()

virtual Vector3 BrokeProtocol.Entities.ShMountable.GetWeaponVector ( )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShEquipable.

◆ IncrementFireTime()

void BrokeProtocol.Entities.ShMountable.IncrementFireTime ( float delay)
inline

◆ Initialize()

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

Reimplemented from BrokeProtocol.Entities.ShEntity.

Reimplemented in BrokeProtocol.Entities.ShPlayer, BrokeProtocol.Entities.ShTransport, BrokeProtocol.Entities.ShVehicle, BrokeProtocol.Entities.ShPhysical, BrokeProtocol.Entities.ShThrown, and BrokeProtocol.Entities.ShWearable.

◆ IsAccessible()

virtual bool BrokeProtocol.Entities.ShMountable.IsAccessible ( ShPlayer attempter,
bool checkOwner )
virtual

Reimplemented in BrokeProtocol.Entities.ShPlayer, and BrokeProtocol.Entities.ShTransport.

◆ Mounted()

virtual void BrokeProtocol.Entities.ShMountable.Mounted ( ShPlayer occupant,
int enterSeat )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShPlayer.

◆ MountFire()

void BrokeProtocol.Entities.ShMountable.MountFire ( )
inline

◆ MoveTurret()

IEnumerator BrokeProtocol.Entities.ShMountable.MoveTurret ( )
inlineprotected

◆ PreInitialize()

override void BrokeProtocol.Entities.ShMountable.PreInitialize ( int ID)
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ShEntity.

Reimplemented in BrokeProtocol.Entities.ShPlayer.

◆ Rearm()

void BrokeProtocol.Entities.ShMountable.Rearm ( float amount)
inline

◆ RearmLoop()

IEnumerator BrokeProtocol.Entities.ShMountable.RearmLoop ( )
inlineprotected

◆ Reload()

virtual void BrokeProtocol.Entities.ShMountable.Reload ( )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShGun.

◆ ResetAmmo()

virtual void BrokeProtocol.Entities.ShMountable.ResetAmmo ( )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShUnderbarrel, and BrokeProtocol.Entities.ShEquipable.

◆ ResetInputs()

virtual void BrokeProtocol.Entities.ShMountable.ResetInputs ( )
inlinevirtual

Reimplemented in BrokeProtocol.Entities.ShPlayer, BrokeProtocol.Entities.ShTransport, BrokeProtocol.Entities.ShBike, and BrokeProtocol.Entities.ShVehicle.

◆ Restore()

override void BrokeProtocol.Entities.ShMountable.Restore ( Vector3 position,
Quaternion rotation,
Transform placeT )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ShEntity.

Reimplemented in BrokeProtocol.Entities.ShPlayer, BrokeProtocol.Entities.ShTransport, and BrokeProtocol.Entities.ShPhysical.

◆ Spawn()

override void BrokeProtocol.Entities.ShMountable.Spawn ( Vector3 position,
Quaternion rotation,
Transform placeT )
inlinevirtual

Reimplemented from BrokeProtocol.Entities.ShEntity.

Reimplemented in BrokeProtocol.Entities.ShPlayer, BrokeProtocol.Entities.ShTransport, BrokeProtocol.Entities.ShPhysical, and BrokeProtocol.Entities.ShThrown.

◆ UpdatePrimaryAmmo()

void BrokeProtocol.Entities.ShMountable.UpdatePrimaryAmmo ( int delta)
inline

◆ UpdateSecondaryAmmo()

void BrokeProtocol.Entities.ShMountable.UpdateSecondaryAmmo ( int delta)
inline

Member Data Documentation

◆ barrelT

Transform BrokeProtocol.Entities.ShMountable.barrelT

◆ clMountable

ClMountable BrokeProtocol.Entities.ShMountable.clMountable

◆ exitTransforms

Transform [] BrokeProtocol.Entities.ShMountable.exitTransforms

◆ nextFire

float BrokeProtocol.Entities.ShMountable.nextFire

◆ occupants

ShPlayer [] BrokeProtocol.Entities.ShMountable.occupants

◆ recoilP

Vector2 BrokeProtocol.Entities.ShMountable.recoilP

◆ recoilV

Vector2 BrokeProtocol.Entities.ShMountable.recoilV

◆ seats

Seat [] BrokeProtocol.Entities.ShMountable.seats

◆ svMountable

SvMountable BrokeProtocol.Entities.ShMountable.svMountable

◆ turretT

Transform BrokeProtocol.Entities.ShMountable.turretT

◆ viewAngleLimit

float BrokeProtocol.Entities.ShMountable.viewAngleLimit = 89f

◆ weaponIndex

int BrokeProtocol.Entities.ShMountable.weaponIndex

◆ weaponSets

WeaponSet [] BrokeProtocol.Entities.ShMountable.weaponSets

Property Documentation

◆ AmmoItem

virtual ShItem BrokeProtocol.Entities.ShMountable.AmmoItem
get

◆ AmmoTotal

int BrokeProtocol.Entities.ShMountable.AmmoTotal
get

◆ CameraDistance

virtual float BrokeProtocol.Entities.ShMountable.CameraDistance
get

◆ CanLockOn

virtual bool BrokeProtocol.Entities.ShMountable.CanLockOn
get

◆ CanReload

virtual bool BrokeProtocol.Entities.ShMountable.CanReload
get

◆ CheckHitscans

bool BrokeProtocol.Entities.ShMountable.CheckHitscans
get

◆ ClipSize

virtual int BrokeProtocol.Entities.ShMountable.ClipSize
get

◆ CurrentClip

virtual int BrokeProtocol.Entities.ShMountable.CurrentClip
getset

◆ Damage

virtual float BrokeProtocol.Entities.ShMountable.Damage
get

◆ GetMount

override ShMountable BrokeProtocol.Entities.ShMountable.GetMount
get

◆ HasWeapons

bool BrokeProtocol.Entities.ShMountable.HasWeapons
get

◆ IsSimulated

bool BrokeProtocol.Entities.ShMountable.IsSimulated
get

◆ MustAim

virtual bool BrokeProtocol.Entities.ShMountable.MustAim
get

◆ NormalizedRecoilAmount

float BrokeProtocol.Entities.ShMountable.NormalizedRecoilAmount
get

◆ Range

virtual float BrokeProtocol.Entities.ShMountable.Range
get

◆ ServersideAmmo

virtual bool BrokeProtocol.Entities.ShMountable.ServersideAmmo
get

◆ ServersidePhysics

virtual bool BrokeProtocol.Entities.ShMountable.ServersidePhysics
get

◆ ThrownHasGuidance

bool BrokeProtocol.Entities.ShMountable.ThrownHasGuidance
get

◆ ThrownVelocity

float BrokeProtocol.Entities.ShMountable.ThrownVelocity
get

◆ UseClips

virtual bool BrokeProtocol.Entities.ShMountable.UseClips
getprotected

◆ UseDelay

virtual float BrokeProtocol.Entities.ShMountable.UseDelay
get

◆ UsePathfinding

virtual bool BrokeProtocol.Entities.ShMountable.UsePathfinding
get

◆ WeaponGravity

float BrokeProtocol.Entities.ShMountable.WeaponGravity
get

◆ WeaponSet

WeaponSet BrokeProtocol.Entities.ShMountable.WeaponSet
get

◆ WeaponVelocity

virtual float BrokeProtocol.Entities.ShMountable.WeaponVelocity
get
The documentation for this class was generated from the following file: