Opaque code representing various reasons for ending gameplay. More...

Inheritance diagram for KickCauseCode:

Public Member Functions
proto external KickCauseGroup	GetGroup ()

proto external int	GetReason ()

Public Member Functions inherited from pointer
proto string	ToString ()

Static Public Member Functions
static proto KickCauseCode	NewCode (KickCauseGroup group, int reason)

Static Public Attributes
static KickCauseCode	NONE = null

Detailed Description

Opaque code representing various reasons for ending gameplay.

It consists of two parts: category and reason. Categories differentiate various systems and each system should provide it's own list of possible reasons that could cause gameplay to end.

Member Function Documentation

◆ GetGroup()

proto external KickCauseGroup KickCauseCode.GetGroup ( )

◆ GetReason()

proto external int KickCauseCode.GetReason ( )

◆ NewCode()

static proto KickCauseCode KickCauseCode.NewCode	(	KickCauseGroup	group,
		int	reason )

static

Member Data Documentation

◆ NONE

KickCauseCode KickCauseCode.NONE = null

static

The documentation for this interface was generated from the following file:

GameLib/generated/KickCauseCode.c

Public Member Functions

Static Public Member Functions