Skip to content

Commit d21278e

Browse files
[NT-0] docs: Remove Transitional Notes from IRealtimeEngine (#802)
As title says, the transition is over, notes are gone.
1 parent 5fca140 commit d21278e

File tree

1 file changed

+0
-43
lines changed

1 file changed

+0
-43
lines changed

Library/include/CSP/Common/Interfaces/IRealtimeEngine.h

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -386,46 +386,3 @@ class CSP_API IRealtimeEngine
386386
EntityFetchCompleteCallback EntityFetchCompleteCallback = nullptr;
387387
};
388388
}
389-
390-
// The following doc is temporary for reference during the module migration effort.
391-
392-
/* As this interface is more or less a conversion from `OnlineRealtimeEngine`, what follows are
393-
* the methods that were public, but are no longer going to be public as far as the interface
394-
* is concerned. I've checked via searching the Magnopus org for uses of these, and initial findings
395-
* show these can be hidden, although some client validation wouldn't go amiss.
396-
* In reality, OnlineRealtimeEngine isn't going anywhere and will continue to exists behind the interface, so these
397-
* methods are not being deleted, they're just not being exposed to clients or CSP-core.
398-
* They'll still be called by methods internal to the module.
399-
*
400-
*
401-
* OnlineRealtimeEngine::AddEntity (We think only Ichabod uses this, we think incorrectly. _Definitely_ need to check this one. Potential full
402-
* deletion candidate) OnlineRealtimeEngine::LocalDestroyEntity OnlineRealtimeEngine::LockEntityUpdate OnlineRealtimeEngine::UnlockEntityUpdate
403-
* OnlineRealtimeEngine::SetConnection
404-
* OnlineRealtimeEngine::RegisterEntityScriptAsModule (Potential full deletion candidate)
405-
* OnlineRealtimeEngine::BindNewEntityToScript (Potential full deletion candidate)
406-
* OnlineRealtimeEngine::RetrieveAllEntities
407-
* OnlineRealtimeEngine::LocalDestroyAllEntities
408-
* OnlineRealtimeEngine::SetSelectionStateOfEntity (Covered by SpaceEntity Select/Deselect)
409-
* OnlineRealtimeEngine::CreateObjectInternal
410-
* OnlineRealtimeEngine::ResolveEntityHierarchy
411-
* OnlineRealtimeEngine::Initialise
412-
* OnlineRealtimeEngine::Shutdown
413-
* OnlineRealtimeEngine::GetPendingAdds
414-
* OnlineRealtimeEngine::CheckIfWeShouldRunScriptsLocally
415-
* OnlineRealtimeEngine::RunScriptRemotely (Public interface to this is EntityScript::RunScript)
416-
*/
417-
418-
/* These are the methods that have been removed from the base interface, but will exist publicly on the Multi User concretion.
419-
*
420-
* OnlineRealtimeEngine::GetEntityPatchRateLimitEnabled
421-
* OnlineRealtimeEngine::SetEntityPatchRateLimitEnabled
422-
* OnlineRealtimeEngine::EnableLeaderElection
423-
* OnlineRealtimeEngine::DisableLeaderElection
424-
* OnlineRealtimeEngine::IsLeaderElectionEnabled
425-
* OnlineRealtimeEngine::GetLeaderId
426-
* OnlineRealtimeEngine::ClaimScriptOwnership
427-
* OnlineRealtimeEngine::SetScriptSystemReadyCallback (Should rename to SetScriptLeaderReadyCallback)
428-
* OnlineRealtimeEngine::GetMultiplayerConnectionInstance
429-
* SystemsManager::GetEventBus (Rename EventBus -> NetworkEventBus)
430-
* OnlineRealtimeEngine::RefreshMultiplayerConnection
431-
*/

0 commit comments

Comments
 (0)