For the complete documentation index, see llms.txt. This page is also available as Markdown.

KS.Reactor.Client.Unity.Editor

Classes

ksPublishService.ImageInfo

Contains information about a Reactor image.

ksAnimationSyncEditor

Custom editor for ksAnimationSync.

ksAssetDrawer

Property drawer for scriptable objects with the ksAssetAttribute. Provides a ScriptableObject browser with an asset tab and no scene tab as scriptable objects are never in the scene.

ksAssetIdData

An editor asset that stores a persistent mapping of assets to ids. Some assets use Unity classes as proxies instead of deriving from ksProxyScriptAsset. Since these assets cannot store there own asset id like our proxy assets, they must save their asset ids in this map.

ksAutoSpawnEditor

Custom editor for ksAutoSpawn.

ksBoolVectorDrawer

Property drawer for int vectors tagged with the ksBoolVectorAttribute.

ksBoxColliderEditor

ksBuildEvents

Reactor config and runtime build event manager. This class can be used by developers to invoke code during different stages of building. Examples: A pre-build-server event can be registered by a developer to write scripts which convert a list of strings in the UI to a script containing enums for those strings prior to compiling the KSServerRuntime assembly.

A pre-build-config event can be registered by a developer to extract and write scene navigation data to 
the project directory to be loaded by a server script.

ksBuildUtils

Build utility for iterating prefab and scene objects.

ksCapsuleColliderEditor

ksCharacterControllerEditor

A class that used to override Unity character controller editor. This class appends extra collider data used by Reactor to the Unity character controller in the inspector.

ksClientScriptTemplate

Template for generating client scripts.

ksColliderDataEditor

Inspector editor for ksColliderData. Sets the hideflags to hide the component.

ksColliderEditor

Base class used to override Unity collider editors. This class appends extra collider data used by Reactor to the Unity collider in the inspector.

ksCollisionFilterAssetEditor

Inspector editor for ksCollisionFilterAsset.

ksConeColliderEditor

Inspector editor for ksConeCollider.

ksConfigWriter

Performs compile/build operations and writes game and scene JSON config files and geometry data.

ksConnectEditor

Editor used for rendering the the ksConnect component in inspector or editor windows.

ksConvergingInputPredictorEditor

Custom inspector for ksConvergingInputPredictorAsset.

ksCylinderColliderEditor

Inspector editor for ksCylinderCollider.

ksDisplayNameDrawer

Property drawer for fields tagged with ksDisplayNameAttribute to change the display name of the field.

ksEntityComponentEditor

Inspector editor for ksEntityComponent.

ksEntityScriptEditor

Inspector editor for ksEntityScript.

ksEnumDrawer

Property drawer for enums with the ksEnumAttribute. Converts our naming standard (ENUM_VALUE) to a more readable display name (Enum Value).

ksFlagsDrawer

Property drawer for enum flag masks using the ksFlagsAttribute. Converts names using our naming standard (ENUM_VALUE) to a more readable format (Enum Value). Composite flag values are not shown.

ksGettingStarted

Popup screen with Reactor Multiplayer getting started instructions. This screen will appear when opening unity and the last loaded version and the current version are different or when the show getting started config value is true.

ksHierarchyPreserver

Provides methods for storing and restoring the state of all hierarchy windows. The state consists of which scenes are loaded, which scenes/objects are expanded, and which objects are selected. Useful for preserving hierarchy state after loading different scenes during publishing.

ksIconManager

Load icons and associates them with Reactor scripts.

ksInitializer

Performs initialization logic when the Unity editor loads.

  • Loads Reactor configs.

  • Checks Reactor package versions.

  • Prepares caches.

  • Attaches Reactor scripts to game objects.

  • Initializes UI windows.

ksInspectorNames

Utility class for registering delegates to override the name of Unity objects in the inspector title bar. Delegates are registered with a type. When drawing an object's name in the inspector, it will first check the object's type for a delegate, and if none is found, it will check the base types recursively.

ksLocalServer

Tracks a local Reactor or Cluster server instance and provides methods for starting and stopping it.

ksLocalServerData

Holds a list of running local servers to serialize during Unity serialization.

ksLocalServerManager

Tracks local Reactor server instances.

ksLocalServerMenu

A utility window for launching Reactor clusters.

ksLoginMenu

Kinematicsoup Service Login GUI.

ksMeshColliderEditor

ksMonoScriptEditor<Parent, Script>

Inspector editor for client scripts.

ksMultiTypeDrawer

Property drawer for ksMultiType. Shows a message saying to change the field type to ksSerializableMultiType

ksNetStatsMonitorEditor

Custom editor for ksNetStatsMonitor.

ksNewClientEntityScriptEditor

Custom editor that opens a new client entity script dialog and deletes the target scripts.

ksNewClientPlayerScriptEditor

Custom editor that opens a new client player script dialog and deletes the target scripts.

ksNewClientRoomScriptEditor

Custom editor that opens a new client room script dialog and deletes the target scripts.

ksNewPrefabWatcher

Detects when a new prefab is created and clears asset and shape IDs on the prefab. This is to prevent ID collisions when a new prefab is created from another prefab.

ksNewScriptMenu

Editor window for creating scripts from a template.

ksNewServerEntityScriptEditor

Custom editor that opens a new server entity script dialog and deletes the target scripts.

ksNewServerPlayerScriptEditor

Custom editor that opens a new server player script dialog and deletes the target scripts.

ksNewServerRoomScriptEditor

Custom editor that opens a new server room script dialog and deletes the target scripts.

ksOptionalMethod

Data for the UI about an optional method a ksIScriptTemplate can generate.

ksOwnershipScriptManagerEditor

Custom editor for ksOwnershipScriptManager.

ksPackageUpdater

Checks for Reactor package updates and prompts users to apply the update.

ksPathBox

A text box element with a button to open a file browser.

ksPaths

Provides static access to paths used throughout the project.

ksPhysicsSettingsEditor

Inspector editor for ksPhysicsSettings.

ksPlayerControllerTemplate

Template for generating player controllers.

ksPlayerScriptEditor

Inspector editor for ksPlayerScript.

ksPredictionBehaviourDrawer

Property drawer for ksPredictionBehaviour.

ksPredictorTemplate

Template for generating predictor scripts.

ksProxyScriptEditor

Inspector editor for ksProxyScript.

ksProxyScriptRedirector

Intercepts open asset events for proxy scripts so we can instead attempt to load the server script for the proxy.

ksPublishMenu

Reactor publishing GUI. Allows for project selection, image lists, and new/updated image publishing.

ksPublishService

Manage state for publishing and running images.

ksReactorConfigEditor

Inspector editor for ksReactorConfig.

ksReactorMenu

This class is responsible for the file menu and context menu GUIs.

ksResourceRangeDrawer

Property drawer for floats with the ksResourceRangeAttribute.

ksRigidBodyEditor

Override editor for the Unity RigidbodyEditor. Editor appends GUIs for extra physics data used in Reactor ksRigidBody scripts from the ksEntityComponent.

ksRoomScriptEditor

Inspector editor for ksRoomScript.

ksRoomTypeEditor

ksSceneTracker

Track scene and asset modification times.

ksScriptAssetReferenceDrawer

Property drawer for ksScriptAssetReference%601.

ksScriptAssetTemplate

Template for generating script assets.

ksScriptGenerator

Provides methods for generating scripts that can be used by script templates.

ksScriptGuidUpdater

Utility for updating script GUIDs in Unity asset files to fix missing scripts when metafiles change. To use this, you must know the old file IDs and GUIDs that you want to replace, as well as the new file IDs and GUIDs. You must also set Unity's asset serialization mode (Edit > Project Settings > Editor > Asset Serialization > Mode) to Force Text BEFORE the metafiles change to the new GUIDs and scripts are missing. If you change it to Force Text after the metafiles change, Unity will be unable to serialize the prefabs that contain missing scripts, and we will be unable to update the GUIDs in those prefab files.

ksSerializableMultiTypeDrawer

Property drawer for ksSerializableMultiType.

ksServerInstaller

Provides methods for validating, downloading, and installing local Reactor test servers.

ksServerLogMenu

Menu for displaying local server logs.

ksServerProjectUpdater

Provides methods for updating and syncing the KSServerRuntime project with the file system.

ksServerProjectWatcher

Monitors the server runtime project. If it detects changes in .cs files, it will build the project when Unity has focus.

ksServerScriptCompiler

This class compiles the KSServerRuntime project.

ksServerScriptTemplate

Template for generating server scripts.

ksServersMenu

Menu for displaying the server list.

ksSphereColliderEditor

ksTerrainColliderEditor

ksTextBox

A text box element that detects enter key events and checks for text changes when it loses focus.

ksTextures

Provides access to Reactor texture assets.

Structs

ksBuildUtils.PrefabInfo

Stores a prefab with its path and asset bundle.

Interfaces

ksIScriptTemplate

Interface for templates from which scripts can be generated.

Enums

ksServerScriptCompiler.CompileResults

Compile results

ksServerScriptCompiler.Configurations

Build configurations

ksServerInstaller.FileStates

Server installation states.

ksServerScriptTemplate.ScriptType

Script types that can be generated.

ksClientScriptTemplate.ScriptType

Script types that can be generated.

ksPublishService.SortKey

Sorting methods for images.

Delegates

ksPublishService.BindImageCallback

Bind image callback.

ksServerScriptCompiler.CompileCompleteHandler

Compile complete handler.

ksServerScriptCompiler.CustomCompileCallback

Callback for custom compiling code.

ksBuildEvents.IncludeSceneCallback

Callback to check if a scene should be included in Reactor builds.

ksLocalServerData.Iterator

Iterator delegate

ksInspectorNames.NameGetter

Delegate to get the name of an object to display in the inspector.

ksInspectorNames.NameGetter<T>

Delegate to get the name of an object to display in the inspector.

ksBuildEvents.PostBuildCallback

Callback for post-build events called after all build process complete.

ksBuildEvents.PostBuildConfigCallback

Callback for post-build-config events called after common and scene configs are written.

ksBuildEvents.PostBuildServerCallback

Callback for post-build events called after the KSServerRuntime compile completes.

ksBuildEvents.PreBuildCallback

Callback for pre-build events called before any build process starts.

ksBuildEvents.PreBuildConfigCallback

Callback for pre-build-config events called before common and scene configs are written.

ksBuildEvents.PreBuildServerCallback

Callback for pre-build events called before the KSServerRuntime is compiled.

ksPublishService.PublishCallback

Image publishing callback.

ksPublishService.SelectProjectCallback

Project selection callback.

ksPublishService.StartServerCallback

Start server callback.

ksPublishService.StopServerCallback

Stop server callback.

ksPublishService.UpdateImagesCallback

Image list update callback.

ksPublishService.UpdateProjectsCallback

Project list update callback.

ksPublishService.UpdateServersCallback

Server list update callback.

ksPublishService.UpdateVirtualMachinesCallback

Virtual machine line update callback.

Last updated