 |
Photon Unity Networking 2
2.12
|
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12345]
| ▼NPhoton | |
| ▼NChat | |
| CAuthenticationValues | Container for user authentication in Photon. Set AuthValues before you connect - all else is handled. |
| CChannelCreationOptions | |
| CChannelWellKnownProperties | |
| CChatChannel | A channel of communication in Photon Chat, updated by ChatClient and provided as READ ONLY. |
| CChatClient | Central class of the Photon Chat API to connect, handle channels and messages. |
| CChatEventCode | Wraps up internally used constants in Photon Chat events. You don't have to use them directly usually. |
| CChatOperationCode | Wraps up codes for operations used internally in Photon Chat. You don't have to use them directly usually. |
| CChatParameterCode | Wraps up codes for parameters (in operations and events) used internally in Photon Chat. You don't have to use them directly usually. |
| CChatPeer | Provides basic operations of the Photon Chat server. This internal class is used by public ChatClient. |
| CChatUserStatus | Contains commonly used status values for SetOnlineStatus. You can define your own. |
| CErrorCode | ErrorCode defines the default codes associated with Photon client/server communication. |
| CIChatClientListener | Callback interface for Chat client side. Contains callback methods to notify your app about updates. Must be provided to new ChatClient in constructor |
| CParameterCode | Class for constants. Codes for parameters of Operations and Events. |
| ▼NPun | |
| ►NUtilityScripts | |
| CButtonInsideScrollList | Button inside scroll list will stop scrolling ability of scrollRect container, so that when pressing down on a button and draggin up and down will not affect scrolling. this doesn't do anything if no scrollRect component found in Parent Hierarchy. |
| CCellTree | Represents the tree accessible from its root node. |
| CCellTreeNode | Represents a single node of the tree. |
| CConnectAndJoinRandom | Simple component to call ConnectUsingSettings and to get into a PUN room easily. |
| CCountdownTimer | This is a basic CountdownTimer. In order to start the timer, the MasterClient can add a certain entry to the Custom Room Properties, which contains the property's name 'StartTime' and the actual start time describing the moment, the timer has been started. To have a synchronized timer, the best practice is to use PhotonNetwork.Time. In order to subscribe to the CountdownTimerHasExpired event you can call CountdownTimer.OnCountdownTimerHasExpired += OnCountdownTimerIsExpired; from Unity's OnEnable function for example. For unsubscribing simply call CountdownTimer.OnCountdownTimerHasExpired -= OnCountdownTimerIsExpired;. You can do this from Unity's OnDisable function for example. |
| CCullArea | Represents the cull area used for network culling. |
| CCullingHandler | Handles the network culling. |
| CEventSystemSpawner | Event system spawner. Will add an EventSystem GameObject with an EventSystem component and a StandaloneInputModule component Use this in additive scene loading context where you would otherwise get a "Multiple eventsystem in scene... this is not supported" error from Unity |
| CGraphicToggleIsOnTransition | Use this on toggles texts to have some color transition on the text depending on the isOn State. |
| CIPunTurnManagerCallbacks | |
| CMoveByKeys | Very basic component to move a GameObject by WASD and Space. |
| COnClickDestroy | Destroys the networked GameObject either by PhotonNetwork.Destroy or by sending an RPC which calls Object.Destroy(). |
| COnClickInstantiate | Instantiates a networked GameObject on click. |
| COnClickRpc | This component will instantiate a network GameObject when in a room and the user click on that component's GameObject. Uses PhysicsRaycaster for positioning. |
| COnEscapeQuit | This component will quit the application when escape key is pressed |
| COnJoinedInstantiate | This component will instantiate a network GameObject when a room is joined |
| COnPointerOverTooltip | Set focus to a given photonView when pointed is over |
| COnStartDelete | This component will destroy the GameObject it is attached to (in Start()). |
| CPhotonLagSimulationGui | This MonoBehaviour is a basic GUI for the Photon client's network-simulation feature. It can modify lag (fixed delay), jitter (random lag) and packet loss. |
| CPhotonStatsGui | Basic GUI to show traffic and health statistics of the connection to Photon, toggled by shift+tab. |
| CPlayerNumbering | Implements consistent numbering in a room/game with help of room properties. Access them by Player.GetPlayerNumber() extension. |
| CPlayerNumberingExtensions | Extension used for PlayerRoomIndexing and Player class. |
| CPointedAtGameObjectInfo | Display ViewId, OwnerActorNr, IsCeneView and IsMine when clicked. |
| CPunPlayerScores | Scoring system for PhotonPlayer |
| CPunTeams | Implements teams in a room/game with help of player properties. Access them by Player.GetTeam extension. |
| CPunTurnManager | Pun turnBased Game manager. Provides an Interface (IPunTurnManagerCallbacks) for the typical turn flow and logic, between players Provides Extensions for Player, Room and RoomInfo to feature dedicated api for TurnBased Needs |
| CScoreExtensions | |
| CSmoothSyncMovement | Smoothed out movement for network gameobjects |
| CStatesGui | Output detailed information about Pun Current states, using the old Unity UI framework. |
| ►CTabViewManager | Tab view manager. Handles Tab views activation and deactivation, and provides a Unity Event Callback when a tab was selected. |
| CTab | |
| CTabChangeEvent | Tab change event. |
| CTeamExtensions | Extension used for PunTeams and Player class. Wraps access to the player's custom property. |
| CTextButtonTransition | Use this on Button texts to have some color transition on the text as well without corrupting button's behaviour. |
| CTextToggleIsOnTransition | Use this on toggles texts to have some color transition on the text depending on the isOn State. |
| CTurnExtensions | |
| CDefaultPool | The default implementation of a PrefabPool for PUN, which actually Instantiates and Destroys GameObjects but pools a resource. |
| CInstantiateParameters | |
| CIPunInstantiateMagicCallback | |
| CIPunObservable | Defines the OnPhotonSerializeView method to make it easy to implement correctly for observable scripts. |
| CIPunOwnershipCallbacks | This interface is used as definition of all callback methods of PUN, except OnPhotonSerializeView. Preferably, implement them individually. |
| CIPunPrefabPool | Defines an interface for object pooling, used in PhotonNetwork.Instantiate and PhotonNetwork.Destroy. |
| CMonoBehaviourPun | This class adds the property photonView, while logging a warning when your game still uses the networkView. |
| CMonoBehaviourPunCallbacks | This class provides a .photonView and all callbacks/events that PUN can call. Override the events/methods you want to use. |
| ►CPhotonAnimatorView | This class helps you to synchronize Mecanim animations Simply add the component to your GameObject and make sure that the PhotonAnimatorView is added to the list of observed components |
| CSynchronizedLayer | |
| CSynchronizedParameter | |
| CPhotonMessageInfo | Container class for info about a particular message, RPC or update. |
| CPhotonNetwork | The main class to use the PhotonNetwork plugin. This class is static. |
| CPhotonRigidbody2DView | |
| CPhotonRigidbodyView | |
| CPhotonStream | This container is used in OnPhotonSerializeView() to either provide incoming data of a PhotonView or for you to provide it. |
| CPhotonStreamQueue | The PhotonStreamQueue helps you poll object states at higher frequencies than what PhotonNetwork.SendRate dictates and then sends all those states at once when Serialize() is called. On the receiving end you can call Deserialize() and then the stream will roll out the received object states in the same order and timeStep they were recorded in. |
| CPhotonTransformView | |
| CPhotonTransformViewClassic | This class helps you to synchronize position, rotation and scale of a GameObject. It also gives you many different options to make the synchronized values appear smooth, even when the data is only send a couple of times per second. Simply add the component to your GameObject and make sure that the PhotonTransformViewClassic is added to the list of observed components |
| CPhotonTransformViewPositionControl | |
| CPhotonTransformViewPositionModel | |
| CPhotonTransformViewRotationControl | |
| CPhotonTransformViewRotationModel | |
| CPhotonTransformViewScaleControl | |
| CPhotonTransformViewScaleModel | |
| CPhotonView | A PhotonView identifies an object across the network (viewID) and configures how the controlling client updates remote instances. |
| CPunExtensions | Small number of extension methods that make it easier for PUN to work cross-Unity-versions. |
| CPunRPC | Replacement for RPC attribute with different name. Used to flag methods as remote-callable. |
| CSceneManagerHelper | |
| CServerSettings | Collection of connection-relevant settings, used internally by PhotonNetwork.ConnectUsingSettings. |
| ▼NRealtime | |
| CActorProperties | Class for constants. These (byte) values define "well known" properties for an Actor / Player. |
| CAppSettings | Settings for Photon application(s) and the server to connect to. |
| CAuthenticationValues | Container for user authentication in Photon. Set AuthValues before you connect - all else is handled. |
| CConnectionCallbacksContainer | Container type for callbacks defined by IConnectionCallbacks. See LoadBalancingCallbackTargets. |
| CConnectionHandler | |
| CEncryptionDataParameters | |
| CEnterRoomParams | |
| CErrorCode | ErrorCode defines the default codes associated with Photon client/server communication. |
| CEventCode | Class for constants. These values are for events defined by Photon Loadbalancing. |
| CEventExt | |
| CExtensions | This static class defines some useful extension methods for several existing classes (e.g. Vector3, float and others). |
| CFriendInfo | Used to store info about a friend's online state and in which room he/she is. |
| CGamePropertyKey | Class for constants. These (byte) values are for "well known" room/game properties used in Photon Loadbalancing. |
| CIConnectionCallbacks | Collection of "organizational" callbacks for the Realtime Api to cover: Connection and Regions. |
| CIInRoomCallbacks | Collection of "in room" callbacks for the Realtime Api to cover: Players entering or leaving, property updates and Master Client switching. |
| CILobbyCallbacks | Collection of "organizational" callbacks for the Realtime Api to cover the Lobby. |
| CIMatchmakingCallbacks | Collection of "organizational" callbacks for the Realtime Api to cover Matchmaking. |
| CIOnEventCallback | Event callback for the Realtime Api. Covers events from the server and those sent by clients via OpRaiseEvent. |
| CIWebRpcCallback | Interface for "WebRpc" callbacks for the Realtime Api. Currently includes only responses for Web RPCs. |
| CLoadBalancingClient | This class implements the Photon LoadBalancing workflow by using a LoadBalancingPeer. It keeps a state and will automatically execute transitions between the Master and Game Servers. |
| CLoadBalancingPeer | A LoadbalancingPeer provides the operations and enum definitions needed to use the loadbalancing server application which is also used in Photon Cloud. |
| CMatchMakingCallbacksContainer | Container type for callbacks defined by IMatchmakingCallbacks. See MatchMakingCallbackTargets. |
| COperationCode | Class for constants. Contains operation codes. Pun uses these constants internally. |
| COpJoinRandomRoomParams | |
| CParameterCode | Class for constants. Codes for parameters of Operations and Events. |
| CPhotonPing | |
| CPingMono | Uses C# Socket class from System.Net.Sockets (as Unity usually does). |
| CPlayer | Summarizes a "player" within a room, identified (in that room) by ID (or "actorNumber"). |
| CRaiseEventOptions | Aggregates several less-often used options for operation RaiseEvent. See field descriptions for usage details. |
| CRegion | |
| CRegionHandler | Provides methods to work with Photon's regions (Photon Cloud) and can be use to find the one with best ping. |
| CRegionPinger | |
| CRoom | This class represents a room a client joins/joined. |
| CRoomInfo | A simplified room with just the info required to list and join, used for the room listing in the lobby. The properties are not settable (IsOpen, MaxPlayers, etc). |
| CRoomOptions | Wraps up common room properties needed when you create rooms. Read the individual entries for more details. |
| CSupportLogger | Helper class to debug log basic information about Photon client and vital traffic statistics. |
| CTypedLobby | Refers to a specific lobby (and type) on the server. |
| CTypedLobbyInfo | |
| CWebFlags | Optional flags to be used in Photon client SDKs with Op RaiseEvent and Op SetProperties. Introduced mainly for webhooks 1.2 to control behavior of forwarded HTTP requests. |
| CWebRpcResponse | Reads an operation response of a WebRpc and provides convenient access to most common values. |