|
Broke Protocol Game API Reference
1.39
Code reference for server and client scripting
|
Public Member Functions | |
| bool | GetConnectAtStartup (out string hostname, out ushort port) |
| void | UpdateFogSetting (bool setting) |
| bool | HasPermissionClient (PermEnum p) |
| void | GetProfileImage (RawImage image, string profile) |
| void | GetImage (RawImage image, string URL) |
| void | ReadSettings () |
| void | WriteSettings () |
| IEnumerator | TargetLockedLoop () |
| bool | IsTyping () |
| void | ToggleCursor () |
| void | HandleInput () |
| void | SendEquipable (int equipableIndex) |
| IEnumerator | CacheCheck () |
| void | AddEntity () |
| void | UpdateMapCamera () |
| void | RenderMap () |
| void | UpdateAmmo (int delta, int ammoIndex) |
| void | ConnectToServer (string hostname, ushort port) |
| void | SendToServer (PacketFlags channel, SvPacket packet, params object[] args) |
| IEnumerator | ConnectOfflineModeDelay (string map, Dictionary< string, bool > pluginSettings) |
| void | ToggleHUD () |
| void | ToggleInterface () |
| void | ShowMainMenu () |
| void | LoadActions () |
| void | ClearHighlightEntity () |
| EntityActionMenu | EntityActionMenu () |
| ButtonActionMenu | ButtonActionMenu (ClActionable target) |
| void | StartHUD () |
| MobileInput | InstantiateMobileInput () |
| void | DestroyText (string id) |
| void | ShowVotePanel (int voteIndex, int ID) |
| void | ShowTimeScaleMenu () |
| void | ShowPlayerRecordsMenu (string jsonRecords) |
| void | ShowBanRecordsMenu (string jsonRecords) |
| void | ShowEquipmentInventory () |
| void | ShowFurnitureInventory () |
| void | ShowViewInventory () |
| void | ShowShoppingingInventory () |
| void | ShowSearchedInventory () |
| void | ShowTradeInventory () |
| void | ShowPlayersMenu () |
| void | ShowAppsMenu (int entityID, string time) |
| void | ShowAppContactsMenu (int entityID, string time, string jsonString) |
| void | ShowAppBlockedMenu (int entityID, string time, string jsonString) |
| void | ShowAppCallsMenu (int entityID, string time, string jsonString) |
| void | ShowAppInboxMenu (int entityID, string time, string jsonString) |
| void | ShowAppServicesMenu (int entityID, string time) |
| void | ShowAppDepositMenu (int entityID, string time, int bankBalance, string transactions) |
| void | ShowAppWithdrawMenu (int entityID, string time, int bankBalance, string transactions) |
| void | ShowAppRadioMenu (int entityID, string time, string jsonString) |
| void | ShowAppMessageMenu (int entityID, string time, string jsonString) |
| void | AppAddMessage (string chatName, int senderID, int unreadCount, string jsonString) |
| void | ShowCallPanel (int ID, bool incoming) |
| void | DisplayName () |
| void | AnimatorEnabled () |
| void | AnimatorFloat () |
| void | AnimatorInt () |
| void | AnimatorBool () |
| void | AnimatorTrigger () |
| void | AnimatorState () |
| void | VideoPlay () |
| void | AddDynamicAction () |
| void | RemoveDynamicAction () |
| IEnumerator | Connect () |
| void | ShowChatMenu (bool local) |
| void | ShowMessage (string message) |
| void | ShowGameMessage (string message) |
| void | ShowInventoryMessage (int itemIndex, int amount) |
| void | ShowHealthMenu (ShPlayer player) |
| void | ShowProcessMenu (ShProcessor processor) |
| void | ShowPauseMenu () |
| void | ShowFeedbackMenu () |
| void | ShowCommandsMenu () |
| void | ShowControlsMenu () |
| void | ShowCustomizeMenu () |
| void | ShowSettingsMenu () |
| T | GetVisualElement< T > (string elementName) |
| VisualElement | GetVisualElement (string elementName) |
| void | VisualTreeAssetClone (string visualTreeAssetName, string parentVisualElementName) |
| void | VisualElementRemove (string element) |
| void | VisualElementOpacity (string element, float setting) |
| void | VisualElementDisplay (string element, bool setting) |
| void | VisualElementVisibility (string element, bool setting) |
| void | VisualElementOverflow (string element, bool setting) |
| void | AddButtonClickedEvent (string element, string eventName) |
| void | GetTextFieldText (string element, string eventName) |
| void | SetTextElementText (string element, string text) |
| void | GetSliderValue (string element, string eventName) |
| void | SetSliderValue (string element, float value) |
| void | SetProgressBarValue (string element, float value) |
| void | GetToggleValue (string element, string eventName) |
| void | SetToggleValue (string element, bool value) |
| void | GetRadioButtonGroupValue (string element, string eventName) |
| void | SetRadioButtonGroupValue (string element, int value) |
| void | SetRadioButtonGroupChoices (string element, string choicesData) |
| void | GetDropdownFieldValue (string element, string eventName) |
| void | SetDropdownFieldValue (string element, int value) |
| void | SetDropdownFieldChoices (string element, string choicesData) |
| void | ShowTextMenu (float xMin, float yMin, float xMax, float yMax, string id, string title, string text) |
| void | ShowOptionMenu (float xMin, float yMin, float xMax, float yMax, string id, string title, int targetID, string optionData, string actionData) |
| void | ShowInputMenu (float xMin, float yMin, float xMax, float yMax, string id, string title, int targetID, InputField.ContentType contentType, int characterLimit) |
| void | ShowTextPanel (string id, string text, string options, int initialOptionIndex) |
| void | DestroyTextPanel (string id) |
| void | ShowHackingMenu (string title, int targetID, string menuData, string optionID, float difficulty) |
| void | ShowCrackingMenu (string title, int targetID, string menuData, string optionID, float difficulty) |
| void | ShowChatHistoryMenu () |
| void | ShowOpenURLMenu (string url, string title) |
| void | ShowPlayerKickMenu (ShPlayer targetPlayer) |
| void | ShowPlayerBanMenu (ShPlayer targetPlayer) |
| void | ShowPlayerBanRecordMenu (PlayerRecord playerRecord) |
| void | RefreshListMenu< T > (params object[] args) |
| void | ShowMenu (Menu menu, params object[] args) |
| void | DestroyActionMenu () |
| void | DestroyMenu (string id=Util.defaultID) |
| bool | GetButton (InputType index, bool thisFrame=false) |
| void | StartDamageMarker (float angle) |
Static Public Attributes | |
| const float | sampleDuration = 60f / 1000f |
| const int | sampleSize = (int)(Util.sampleRate * sampleDuration) |
| static float[] | sampleBuffer = new float[sampleSize] |
| static uint | disconnectIndex = DisconnectTypes.Normal |
| static int | languageIndex |
| static string | inputDevice |
| static int | shaderLevel |
Protected Member Functions | |
| override void | Awake () |
Properties | |
| bool | StartAsServer [get] |
| int | FramerateLimit [get, set] |
| float | MasterVolume [get, set] |
| float | MusicVolume [get, set] |
| static float | VoiceVolume [get, set] |
| bool | AllowHUD [get, set] |
| bool | Fog [get, set] |
| Menu | CurrentMenu [get] |
| Menu | TopMenu [get] |
Properties inherited from BrokeProtocol.Utility.MonoBehaviourSingleton< ClManager > | |
| virtual bool | DontDestroy [get] |
| static T | Instance [get] |
Additional Inherited Members | |
Static Public Member Functions inherited from BrokeProtocol.Utility.MonoBehaviourSingleton< ClManager > | |
| static void | Instantiate () |
| void BrokeProtocol.Managers.ClManager.AddButtonClickedEvent | ( | string | element, |
| string | eventName ) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inlineprotectedvirtual |
Reimplemented from BrokeProtocol.Utility.MonoBehaviourSingleton< ClManager >.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| VisualElement BrokeProtocol.Managers.ClManager.GetVisualElement | ( | string | elementName | ) |
| T BrokeProtocol.Managers.ClManager.GetVisualElement< T > | ( | string | elementName | ) |
| T | : | VisualElement |
|
inline |
| bool BrokeProtocol.Managers.ClManager.HasPermissionClient | ( | PermEnum | p | ) |
| MobileInput BrokeProtocol.Managers.ClManager.InstantiateMobileInput | ( | ) |
|
inline |
|
inline |
|
inline |
|
inline |
| T | : | ListMenu |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| void BrokeProtocol.Managers.ClManager.SetDropdownFieldValue | ( | string | element, |
| int | value ) |
| void BrokeProtocol.Managers.ClManager.SetProgressBarValue | ( | string | element, |
| float | value ) |
|
inline |
| void BrokeProtocol.Managers.ClManager.SetRadioButtonGroupValue | ( | string | element, |
| int | value ) |
| void BrokeProtocol.Managers.ClManager.SetSliderValue | ( | string | element, |
| float | value ) |
| void BrokeProtocol.Managers.ClManager.SetTextElementText | ( | string | element, |
| string | text ) |
| void BrokeProtocol.Managers.ClManager.SetToggleValue | ( | string | element, |
| bool | value ) |
| void BrokeProtocol.Managers.ClManager.ShowAppBlockedMenu | ( | int | entityID, |
| string | time, | ||
| string | jsonString ) |
| void BrokeProtocol.Managers.ClManager.ShowAppCallsMenu | ( | int | entityID, |
| string | time, | ||
| string | jsonString ) |
| void BrokeProtocol.Managers.ClManager.ShowAppContactsMenu | ( | int | entityID, |
| string | time, | ||
| string | jsonString ) |
| void BrokeProtocol.Managers.ClManager.ShowAppDepositMenu | ( | int | entityID, |
| string | time, | ||
| int | bankBalance, | ||
| string | transactions ) |
| void BrokeProtocol.Managers.ClManager.ShowAppInboxMenu | ( | int | entityID, |
| string | time, | ||
| string | jsonString ) |
| void BrokeProtocol.Managers.ClManager.ShowAppMessageMenu | ( | int | entityID, |
| string | time, | ||
| string | jsonString ) |
| void BrokeProtocol.Managers.ClManager.ShowAppRadioMenu | ( | int | entityID, |
| string | time, | ||
| string | jsonString ) |
| void BrokeProtocol.Managers.ClManager.ShowAppServicesMenu | ( | int | entityID, |
| string | time ) |
| void BrokeProtocol.Managers.ClManager.ShowAppsMenu | ( | int | entityID, |
| string | time ) |
| void BrokeProtocol.Managers.ClManager.ShowAppWithdrawMenu | ( | int | entityID, |
| string | time, | ||
| int | bankBalance, | ||
| string | transactions ) |
|
inline |
|
inline |
| void BrokeProtocol.Managers.ClManager.ShowChatHistoryMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowChatMenu | ( | bool | local | ) |
| void BrokeProtocol.Managers.ClManager.ShowCommandsMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowControlsMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowCrackingMenu | ( | string | title, |
| int | targetID, | ||
| string | menuData, | ||
| string | optionID, | ||
| float | difficulty ) |
| void BrokeProtocol.Managers.ClManager.ShowCustomizeMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowEquipmentInventory | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowFeedbackMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowFurnitureInventory | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowGameMessage | ( | string | message | ) |
| void BrokeProtocol.Managers.ClManager.ShowHackingMenu | ( | string | title, |
| int | targetID, | ||
| string | menuData, | ||
| string | optionID, | ||
| float | difficulty ) |
| void BrokeProtocol.Managers.ClManager.ShowHealthMenu | ( | ShPlayer | player | ) |
| void BrokeProtocol.Managers.ClManager.ShowInputMenu | ( | float | xMin, |
| float | yMin, | ||
| float | xMax, | ||
| float | yMax, | ||
| string | id, | ||
| string | title, | ||
| int | targetID, | ||
| InputField.ContentType | contentType, | ||
| int | characterLimit ) |
|
inline |
| void BrokeProtocol.Managers.ClManager.ShowMainMenu | ( | ) |
|
inline |
|
inline |
| void BrokeProtocol.Managers.ClManager.ShowOpenURLMenu | ( | string | url, |
| string | title ) |
| void BrokeProtocol.Managers.ClManager.ShowOptionMenu | ( | float | xMin, |
| float | yMin, | ||
| float | xMax, | ||
| float | yMax, | ||
| string | id, | ||
| string | title, | ||
| int | targetID, | ||
| string | optionData, | ||
| string | actionData ) |
| void BrokeProtocol.Managers.ClManager.ShowPauseMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowPlayerBanMenu | ( | ShPlayer | targetPlayer | ) |
| void BrokeProtocol.Managers.ClManager.ShowPlayerBanRecordMenu | ( | PlayerRecord | playerRecord | ) |
| void BrokeProtocol.Managers.ClManager.ShowPlayerKickMenu | ( | ShPlayer | targetPlayer | ) |
|
inline |
| void BrokeProtocol.Managers.ClManager.ShowPlayersMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowProcessMenu | ( | ShProcessor | processor | ) |
| void BrokeProtocol.Managers.ClManager.ShowSearchedInventory | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowSettingsMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowShoppingingInventory | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowTextMenu | ( | float | xMin, |
| float | yMin, | ||
| float | xMax, | ||
| float | yMax, | ||
| string | id, | ||
| string | title, | ||
| string | text ) |
|
inline |
| void BrokeProtocol.Managers.ClManager.ShowTimeScaleMenu | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowTradeInventory | ( | ) |
| void BrokeProtocol.Managers.ClManager.ShowViewInventory | ( | ) |
|
inline |
| void BrokeProtocol.Managers.ClManager.StartDamageMarker | ( | float | angle | ) |
|
inline |
|
inline |
|
inline |
| void BrokeProtocol.Managers.ClManager.ToggleHUD | ( | ) |
| void BrokeProtocol.Managers.ClManager.ToggleInterface | ( | ) |
|
inline |
|
inline |
|
inline |
|
inline |
| void BrokeProtocol.Managers.ClManager.VisualElementDisplay | ( | string | element, |
| bool | setting ) |
| void BrokeProtocol.Managers.ClManager.VisualElementOpacity | ( | string | element, |
| float | setting ) |
| void BrokeProtocol.Managers.ClManager.VisualElementOverflow | ( | string | element, |
| bool | setting ) |
| void BrokeProtocol.Managers.ClManager.VisualElementRemove | ( | string | element | ) |
| void BrokeProtocol.Managers.ClManager.VisualElementVisibility | ( | string | element, |
| bool | setting ) |
|
inline |
| void BrokeProtocol.Managers.ClManager.WriteSettings | ( | ) |
| ActionInfo [] BrokeProtocol.Managers.ClManager.actions |
| Transform BrokeProtocol.Managers.ClManager.activateParent |
| ShPlayer BrokeProtocol.Managers.ClManager.aimTarget |
| SvPacket [] BrokeProtocol.Managers.ClManager.appPackets |
| bool BrokeProtocol.Managers.ClManager.autoaim |
| Material BrokeProtocol.Managers.ClManager.badMaterial |
| List<Ban> BrokeProtocol.Managers.ClManager.banRecords |
| InputButton [] BrokeProtocol.Managers.ClManager.buttonInput |
| ActionableButtons [] BrokeProtocol.Managers.ClManager.buttons |
| Canvas BrokeProtocol.Managers.ClManager.canvas |
| Text BrokeProtocol.Managers.ClManager.chatChannelText |
| Text BrokeProtocol.Managers.ClManager.chatModeText |
| ChatVoiceLabel BrokeProtocol.Managers.ClManager.chatVoiceLabel = null |
| Dictionary<int, ChatVoiceLabel> BrokeProtocol.Managers.ClManager.chatVoiceLabels = new() |
| Peer BrokeProtocol.Managers.ClManager.connection |
| ActionMenu BrokeProtocol.Managers.ClManager.currentActionMenu |
| bool BrokeProtocol.Managers.ClManager.customProfilesVideos |
|
static |
| GameObject [] BrokeProtocol.Managers.ClManager.effectPrefabs |
| OpusEncoder BrokeProtocol.Managers.ClManager.encoder |
| bool BrokeProtocol.Managers.ClManager.fire |
| Dictionary<string, AudioClip[]> BrokeProtocol.Managers.ClManager.footsteps = new() |
| Material BrokeProtocol.Managers.ClManager.goodMaterial |
| Action [] BrokeProtocol.Managers.ClManager.handler |
| ShEntity BrokeProtocol.Managers.ClManager.highlightEntity |
| HUD BrokeProtocol.Managers.ClManager.hud |
| Canvas BrokeProtocol.Managers.ClManager.hudCanvas |
|
static |
| InputSystemUIInputModule BrokeProtocol.Managers.ClManager.inputSystem |
| Dictionary<string, (string, byte, string)> BrokeProtocol.Managers.ClManager.inventoryActions = new() |
| List<JobInfoShared> BrokeProtocol.Managers.ClManager.jobs |
|
static |
| Vector3 BrokeProtocol.Managers.ClManager.lastInput |
| byte BrokeProtocol.Managers.ClManager.lastMode |
| Texture2D BrokeProtocol.Managers.ClManager.loadingTexture |
| Vector2 BrokeProtocol.Managers.ClManager.lookInput |
| ShManager BrokeProtocol.Managers.ClManager.manager |
| SpriteRenderer BrokeProtocol.Managers.ClManager.mapMarkerPrefab |
| RectTransform BrokeProtocol.Managers.ClManager.menuRect |
| Dictionary<string, Menu> BrokeProtocol.Managers.ClManager.menus = new() |
| int BrokeProtocol.Managers.ClManager.myID |
| ShPlayer BrokeProtocol.Managers.ClManager.myPlayer |
| ENet.Event BrokeProtocol.Managers.ClManager.netEvent |
| bool BrokeProtocol.Managers.ClManager.offlineConsole |
| byte [] BrokeProtocol.Managers.ClManager.permissions |
| PersistentSettings BrokeProtocol.Managers.ClManager.persistentSettings |
| AudioClip BrokeProtocol.Managers.ClManager.playerHeal |
| AudioClip BrokeProtocol.Managers.ClManager.playerHealMinor |
| AudioClip BrokeProtocol.Managers.ClManager.playerHurt |
| AudioClip BrokeProtocol.Managers.ClManager.playerHurtMinor |
| List<PlayerRecord> BrokeProtocol.Managers.ClManager.playerRecords |
| PlayerRenderer BrokeProtocol.Managers.ClManager.playerRendererPrefab |
| string BrokeProtocol.Managers.ClManager.profileURL |
| Transform BrokeProtocol.Managers.ClManager.radioBarT = null |
|
static |
|
static |
|
static |
| Dictionary<string, string> BrokeProtocol.Managers.ClManager.selfActions = new() |
| Vector2 BrokeProtocol.Managers.ClManager.sensitivity |
|
static |
| Dictionary<string, AudioClip> BrokeProtocol.Managers.ClManager.skid = new() |
| Dictionary<string, TextDisplay> BrokeProtocol.Managers.ClManager.texts = new() |
| bool BrokeProtocol.Managers.ClManager.toggleCursor |
| Dictionary<string, (string, string)> BrokeProtocol.Managers.ClManager.typeActions = new() |
| RenderTexture BrokeProtocol.Managers.ClManager.videoTexture |
| Voice BrokeProtocol.Managers.ClManager.voicePrefab |
|
getset |
|
get |
|
getset |
|
getset |
|
getset |
|
getset |
|
get |
|
get |
|
staticgetset |