Quantum.FrameContextUser Class Reference

Use this class to extend the Core.FrameContext class. More...

Inheritance diagram for Quantum.FrameContextUser:

Public Member Functions
	FrameContextUser (Args args)
	Frame context user constructor. More...
override sealed void	Dispose ()
	Dispose user systems and memory. More...
Public Member Functions inherited from Quantum.Core.FrameContext
	FrameContext (Args args)
	Create a new instance of the FrameContext using the . More...
T	AcquireEvent< T > (int id)
	Creates a new event object from the pool. More...
Boolean	InPredictionArea (DeterministicFrame frame, FPVector2 position)
virtual Boolean	InPredictionArea (DeterministicFrame frame, FPVector3 position)
	This method determines if a position is inside the prediction area. More...
bool	IsLocalPlayer (PlayerRef player)
	Don't use this in the simulation that affect the state because it is different on each client and will lead to desyncs. More...
void	OnFrameSimulationBegin (FrameBase f)
	Forwards frame simulation begin event to internal subsystems. More...
void	OnFrameSimulationEnd ()
	Forwards frame simulation end event to internal subsystems. More...
void	OnGameStart (DeterministicFrame f)
	Callback required to start the heap tracking. More...
void	OnSimulationBegin ()
	Forwards simulation begin event to internal subsystems. More...
void	OnSimulationEnd ()
	Forwards simulation end event to internal subsystems. More...
void	ReleaseEvent (EventBase evnt)
	Release an event object and return it to the pool More...
void	SetPredictionArea (FPVector3 center, FP radius)
	Sets the prediction area. Entities outside this area are culled from predicted frames. More...
void *	TempAllocate (int size, int alignment=8)
	Allocates memory that is released during OnFrameSimulationEnd. More...
void *	TempAllocateAndClear (int size, int alignment=8)
	.

Additional Inherited Members
Public Attributes inherited from Quantum.Core.FrameContext
AssetDB	AssetDB => new AssetDB(_resourceManager)
	Obsolete. Use ResourceManager instead. More...
PhysicsCommon.Config	PhysicsConfig => _physicsConfig
	Access the global physics configuration. More...
Properties inherited from Quantum.Core.FrameContext
Native.Allocator	Allocator [get]
	Access the native allocator. More...
IAssetSerializer	AssetSerializer [get]
	Access the the asset serializer. More...
DeterministicCommandSerializer	CommandSerializer [get]
	Access the command serializer. More...
FrameBase.Culling	Culling [get]
	Access the culling subsystem. More...
EventList	Events [get]
	Access the current stored events. More...
IHeapAllocationTracker	HeapTracker [get]
	Access the heap tracker. More...
HeapTrackingMode	HeapTrackingMode [get]
	Return the heap tracking mode that the FrameContext was created with. More...
bool	IsServer [get]
	Returns true if the FrameContext was started with Args.IsServer enabled. More...
Physics2D.PhysicsEngine2D	Physics2D [get]
	Access the 2D physics API. More...
Physics3D.PhysicsEngine3D	Physics3D [get]
	Access the 3D physics API. More...
FPVector3	PredictionAreaCenter [get]
	Return the current prediction culling circle area center. More...
FP	PredictionAreaRadius [get]
	Return the current prediction culling circle area radius. More...
Profiling.ProfilerContext	ProfilerContext [get]
	Access the profiler context. More...
IResourceManager	ResourceManager [get]
	Access the resource manager. More...
FrameSerializer	SharedChecksumSerializer [get]
	Access the shared checksum serializer. More...
TaskContext	TaskContext [get]
	Access the task context. More...
bool	UseSharedChecksumSerializer [get]
	Returns true is Args.UseSharedChecksumSerialized was set. More...

Detailed Description

Use this class to extend the Core.FrameContext class.

Constructor & Destructor Documentation

FrameContextUser()

Quantum.FrameContextUser.FrameContextUser ( Args  args )

inline

Frame context user constructor.

Member Function Documentation

Dispose()

override sealed void Quantum.FrameContextUser.Dispose ( )

inlinevirtual

Dispose user systems and memory.

Reimplemented from Quantum.Core.FrameContext.