|
Broke Protocol Game API Reference
1.39
Code reference for server and client scripting
|
Public Member Functions | |
| T | GetEvents< T > () |
| void | InitializeSender () |
| void | UpdateDefaultItems () |
| virtual void | ResetOriginal () |
| virtual bool | CheckUpdatable () |
| void | SvAnimatorEnabled (bool enabled) |
| void | SvAnimatorFloat (string parameterName, float value) |
| void | SvAnimatorInt (string parameterName, int value) |
| void | SvAnimatorBool (string parameterName, bool value) |
| void | SvAnimatorTrigger (string parameterName) |
| void | SvStopVideo () |
| void | SvStartDefaultVideo (int index) |
| void | SvStartCustomVideo (string url) |
| bool | BuyEntity (ShPlayer buyer) |
| virtual void | SvSetParent (Transform parent) |
| void | SvRelocate (Transform t, Transform parent=null) |
| virtual void | SvRelocate (Vector3 position, Quaternion rotation, Transform parent=null) |
| virtual bool | IsValidTarget (ShPlayer chaser) |
| SizedArray | SerializeAnimator () |
| SizedArray | SerializeParameters () |
| virtual void | WriteActivateData () |
| void | SendActivateToOther (ShPlayer other) |
| void | SendDeactivateToOther (ShPlayer other) |
| virtual void | Initialize () |
| IEnumerator | SyncAnimator () |
| void | AddItemOptions (ItemOption[] options) |
| Sector | GetEntitySector () |
| bool | AddSubscribedPlayer (ShPlayer player, bool sendInitData=true) |
| void | RemoveSubscribedPlayer (ShPlayer player, bool dispatch) |
| void | SameSector () |
| void | NewSector (Sector newSector) |
| virtual void | Destroy () |
| virtual void | SvDestroyEffect () |
| void | SpawnOriginal () |
| void | SpawnFire () |
| HashSet< T > | GetLocalInRange< T > (float range) |
| void | ExplosionDamage (float range, float damage, ShPlayer attacker) |
| void | SvAddDynamicAction (string eventName, string label) |
| void | SvRemoveDynamicAction (string eventName) |
| virtual void | WriteInitData (ref object[] initializeArgs, bool isPlayer) |
| void | SvSetScale (Vector3 scale) |
| virtual void | InitializeSectors () |
| virtual void | Respawn () |
| virtual void | Deactivate (bool removeSectors) |
| virtual void | SvRestore (Vector3 position, Quaternion rotation, int placeIndex) |
| bool | LocalEntitiesOne (Func< ShEntity, bool > Test, Func< ShEntity, bool > Action) |
| void | LocalEntitiesAll (Func< ShEntity, bool > Test, Action< ShEntity > Action) |
| virtual void | Restock (float fraction=1f) |
| virtual void | Shop (ShPlayer customer) |
| void | Send (SvSendType sendType, PacketFlags channel, ClPacket packet, params object[] args) |
| void | Send (SvSendType sendType, PacketFlags channel) |
Public Attributes | |
| ShEntity | entity |
| ShPlayer | spawner |
| ShPlayer | instigator |
| IDCollection< ShPlayer > | subscribers |
| SvManager | svManager |
| Dictionary< ValueTuple< Place, Vector2Int >, Sector > | localSectors = new () |
| Sector | sector |
| bool | randomSpawn |
| bool | respawnable = true |
| string | videoURL = string.Empty |
| float | destroyAfter |
| bool | destroyEmpty |
| ItemOption[] | itemOptions |
| Dictionary< int, InventoryItem > | defaultItems |
| HashSet< ShPlayer > | spectators = new () |
| object[] | activateArgs |
| Vector3 | originalPosition |
| Quaternion | originalRotation |
| Transform | originalParent |
Static Public Attributes | |
| static readonly EntityEvents | events = new() |
Protected Member Functions | |
| void | RemoveSectors (bool sendDeactivate) |
| void | TryAddHuman (Sector s) |
| void | TryRemoveHuman (Sector s) |
| void | SendToPlayer (ShPlayer toPlayer, PacketFlags channel) |
| virtual void | SendToSelf (PacketFlags channel) |
| virtual void | SendToLocal (PacketFlags channel) |
| void | SendToLocalOthers (PacketFlags channel) |
| void | SendToAll (PacketFlags channel) |
| void | SendToAllOthers (PacketFlags channel) |
Protected Attributes | |
| readonly Dictionary< SvSendType, Action< PacketFlags > > | sender = new () |
| byte[] | animatorArray |
| byte[] | parameterArray |
Properties | |
| virtual EntityEvents | Events [get] |
| virtual WaypointType | WaypointProperty [get] |
| CustomData | CustomData = new () [get, set] |
| virtual float | RespawnTime [get] |
| virtual float | SpawnRate [get] |
| bool | OnOrigin [get] |
| ShDoor | GetDoor [get] |
| Vector3 | ExteriorPosition [get] |
|
inline |
|
inline |
|
inline |
|
virtual |
Reimplemented in BrokeProtocol.Entities.SvPhysical.
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer, and BrokeProtocol.Entities.SvTransport.
|
inlinevirtual |
|
inline |
|
inline |
| T BrokeProtocol.Entities.SvEntity.GetEvents< T > | ( | ) |
| T | : | EntityEvents |
|
inline |
| T | : | ShEntity |
|
inlinevirtual |
|
virtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
inline |
|
virtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
inline |
|
inline |
|
inline |
|
inlineprotected |
|
inline |
|
virtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
virtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer, and BrokeProtocol.Entities.SvMovable.
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
| void BrokeProtocol.Entities.SvEntity.SameSector | ( | ) |
| void BrokeProtocol.Entities.SvEntity.Send | ( | SvSendType | sendType, |
| PacketFlags | channel ) |
|
inline |
|
inline |
|
inline |
|
inlineprotected |
|
inlineprotected |
|
protectedvirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
inlineprotected |
|
inlineprotected |
|
inlineprotectedvirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
inline |
|
inline |
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvTransport, and BrokeProtocol.Entities.SvExplosion.
| void BrokeProtocol.Entities.SvEntity.SvRelocate | ( | Transform | t, |
| Transform | parent = null ) |
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer, and BrokeProtocol.Entities.SvPhysical.
|
inline |
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer.
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvMountable.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inlineprotected |
|
inlineprotected |
|
inline |
|
inlinevirtual |
Reimplemented in BrokeProtocol.Entities.SvPlayer, BrokeProtocol.Entities.SvTransport, BrokeProtocol.Entities.SvPhysical, BrokeProtocol.Entities.SvExplosion, BrokeProtocol.Entities.SvDestroyable, BrokeProtocol.Entities.SvTextDisplay, BrokeProtocol.Entities.SvTerritory, and BrokeProtocol.Entities.SvVault.
|
inlinevirtual |
| object [] BrokeProtocol.Entities.SvEntity.activateArgs |
|
protected |
| Dictionary<int, InventoryItem> BrokeProtocol.Entities.SvEntity.defaultItems |
| float BrokeProtocol.Entities.SvEntity.destroyAfter |
| bool BrokeProtocol.Entities.SvEntity.destroyEmpty |
| ShEntity BrokeProtocol.Entities.SvEntity.entity |
|
static |
| ShPlayer BrokeProtocol.Entities.SvEntity.instigator |
| ItemOption [] BrokeProtocol.Entities.SvEntity.itemOptions |
| Dictionary<ValueTuple<Place, Vector2Int>, Sector> BrokeProtocol.Entities.SvEntity.localSectors = new () |
| Transform BrokeProtocol.Entities.SvEntity.originalParent |
| Vector3 BrokeProtocol.Entities.SvEntity.originalPosition |
| Quaternion BrokeProtocol.Entities.SvEntity.originalRotation |
|
protected |
| bool BrokeProtocol.Entities.SvEntity.randomSpawn |
| bool BrokeProtocol.Entities.SvEntity.respawnable = true |
| Sector BrokeProtocol.Entities.SvEntity.sector |
|
protected |
| ShPlayer BrokeProtocol.Entities.SvEntity.spawner |
| HashSet<ShPlayer> BrokeProtocol.Entities.SvEntity.spectators = new () |
| IDCollection<ShPlayer> BrokeProtocol.Entities.SvEntity.subscribers |
| SvManager BrokeProtocol.Entities.SvEntity.svManager |
| string BrokeProtocol.Entities.SvEntity.videoURL = string.Empty |
|
getset |
|
get |
|
get |
|
get |
|
get |
|
get |
|
get |
|
get |