CPLog

org.cosplay.CPLog

trait CPLog

Game logging interface.

As CosPlay games are terminal-based they require a different approach to logging since CosPlay cannot use the standard terminal output (it will conflict the game rendering). All the log that goes through this interface always ends up in two places:

Built-in GUI-based log viewer that can be opened in any game by pressing Ctrl-l at any time.
In *.txt log files under ${USER_HOME}/.cosplay/log/xxx directory, where xxx is the name of the game.

The instance of this logger is available to any scene object via CPSceneObjectContext.getLog. You can also get a root logger at any time outside the frame update pass via CPEngine.rootLog method. Note that additionally to the standard familiar logging APIs this interface supports log throttling that's important in games since most of the game logic gets "touched" up to 30 times a second and log throttling is essential for not overflowing logging.

Underneath the implementation is using latest Log4j2 library. You can supply your own log4j2.xml file on the classpath of your game. Here's the default Log4j2 configuration:

<Configuration status="INFO" strict="true">
   <Appenders>
       <RollingFile
           name="file"
           fileName="${sys:user.home}/.cosplay/log/${sys:COSPLAY_GAME_ID}/log.txt"
           filePattern="${sys:user.home}/.cosplay/log/${sys:COSPLAY_GAME_ID}/$${date:yyyy-MM}/log-%d{MM-dd-yyyy}-%i.gz">
           <PatternLayout>
               <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>
           </PatternLayout>
           <Policies>
               <TimeBasedTriggeringPolicy />
               <SizeBasedTriggeringPolicy size="250 MB"/>
           </Policies>
       </RollingFile>
   </Appenders>
   <Loggers>
       <Root level="trace">
           <AppenderRef ref="file"/>
       </Root>
   </Loggers>
</Configuration>

Attributes

See also: CPSceneObjectContext.getLog

CPEngine.rootLog
Source: CPLog.scala
Graph
Supertypes: class Object

trait Matchable

class Any

Members list

Value members

Abstract methods

Gets category for this logger.

Attributes

Source: CPLog.scala

Gets a new logger for given category. New logger will inherit log levels and throttle value.

Value parameters

category: Category for new logger.

Attributes

Source: CPLog.scala

Logs given message with throttling and explicit category.

Value parameters

cat: Explicit log category.
ex: Exception to log. Can be null.
lvl: Log level.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Concrete methods

Logs object with CPLogLevel.DEBUG level.

Value parameters

ex: Optional exception to log. Default value is null.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.DEBUG level and throttling.

Value parameters

ex: Optional exception to log. Default value is null.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Disables given log level for logging.

Value parameters

lvls: Log levels to disable.

Attributes

Source: CPLog.scala

Enables given log level for logging.

Value parameters

lvls: Log levels to enable.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.ERROR level.

Value parameters

ex: Optional exception to log. Default value is null.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.ERROR level and throttling.

Value parameters

ex: Optional exception to log. Default value is null.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.FATAL level.

Value parameters

ex: Optional exception to log. Default value is null.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.FATAL level and throttling.

Value parameters

ex: Optional exception to log. Default value is null.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Gets current throttle value.

Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored. For example, setting throttling to 10 means that logging will happen only every 10th frame.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.INFO level.

Value parameters

ex: Optional exception to log. Default value is null.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.INFO level and throttling.

Value parameters

ex: Optional exception to log. Default value is null.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Attributes

Source: CPLog.scala

Tests whether given log level is enabled.

Value parameters

lvl: Log level to check.

Attributes

Source: CPLog.scala

Logs given message with throttling. This method will use this log's category.

Value parameters

ex: Optional exception to log. Default value is null.
lvl: Log level.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Sets the throttling value.

Value parameters

nthFrame: Throttle value.

Attributes

Source: CPLog.scala

Logs rendering performance snapshot, if available from the game engine.

When debugging a performance issue with the game, it is often useful to periodically log game engine performance metrics like actual FPS, LOW 1%, etc. to analyze them later in log files in correlation with other game activity. This is a convenient method to quickly log a snapshot of the current game engine performance numbers.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.TRACE level.

Value parameters

ex: Optional exception to log. Default value is null.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.TRACE level and throttling.

Value parameters

ex: Optional exception to log. Default value is null.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.WARN level.

Value parameters

ex: Optional exception to log. Default value is null.
obj: Object to log.

Attributes

Source: CPLog.scala

Logs object with CPLogLevel.WARN level and throttling.

Value parameters

ex: Optional exception to log. Default value is null.
nthFrame: Throttle value. Throttle value N simply means that actual logging will only happen for each Nth frame. Logging for all other frames will be ignored.
obj: Object to log.

Attributes

Source: CPLog.scala

In this article

Generated with