Difference between revisions of "HPL3/SOMA/Scripting/Scripting Api/Logging"

From Frictional Wiki
< HPL3‎ | SOMA‎ | Scripting‎ | Scripting Api
Jump to navigation Jump to search
(Created page with "{{ScriptingStub}} Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! ==Summary== {{CodeDocSummaryTop}} {{CodeDocSummaryIte...")
 
 
(One intermediate revision by the same user not shown)
Line 13: Line 13:
 
{{CodeDocSummaryItem|void|[[#Log|Log]](const [[../../tString|tString]] &in asString, uint aLabel)|}}
 
{{CodeDocSummaryItem|void|[[#Log|Log]](const [[../../tString|tString]] &in asString, uint aLabel)|}}
 
{{CodeDocSummaryItem|void|[[#LogNewLine|LogNewLine]](const [[../../tString|tString]] &in asString)|}}
 
{{CodeDocSummaryItem|void|[[#LogNewLine|LogNewLine]](const [[../../tString|tString]] &in asString)|}}
 +
{{CodeDocSummaryItem|void|[[#Warning|Warning]](const [[../../tString|tString]] &in asString)|}}
 +
{{CodeDocSummaryItem|void|[[#Warning|Warning]](uint aLabel, int alWarningLevel, const [[../../tString|tString]] &in asString)|}}
 +
{{CodeDocSummaryItem|void|[[#Warning|Warning]](const [[../../tString|tString]] &in asString, uint aLabel, int alWarningLevel)|}}
 
{{CodeDocSummaryBottom}}
 
{{CodeDocSummaryBottom}}
  
Line 85: Line 88:
 
{{CodeDocDetailParamStart}}
 
{{CodeDocDetailParamStart}}
 
{{CodeDocDetailParam|asString|[[../../tString|tString]]|}}
 
{{CodeDocDetailParam|asString|[[../../tString|tString]]|}}
 +
{{CodeDocDetailReturn|void|}}
 +
{{CodeDocDetailBottom}}
 +
 +
{{CodeDocDetailTop|Warning}}
 +
<syntaxhighlight lang="c++">void Warning(const tString &in asString)</syntaxhighlight>
 +
{{CodeDocDetailBody|}}
 +
{{CodeDocDetailParamStart}}
 +
{{CodeDocDetailParam|asString|[[../../tString|tString]]|}}
 +
{{CodeDocDetailReturn|void|}}
 +
{{CodeDocDetailBottom}}
 +
 +
{{CodeDocDetailTop|Warning}}
 +
<syntaxhighlight lang="c++">void Warning(uint aLabel,
 +
            int alWarningLevel,
 +
            const tString &in asString)</syntaxhighlight>
 +
{{CodeDocDetailBody|}}
 +
{{CodeDocDetailParamStart}}
 +
{{CodeDocDetailParam|aLabel|uint|}}
 +
{{CodeDocDetailParam|alWarningLevel|int|}}
 +
{{CodeDocDetailParam|asString|[[../../tString|tString]]|}}
 +
{{CodeDocDetailReturn|void|}}
 +
{{CodeDocDetailBottom}}
 +
 +
{{CodeDocDetailTop|Warning}}
 +
<syntaxhighlight lang="c++">void Warning(const tString &in asString,
 +
            uint aLabel,
 +
            int alWarningLevel)</syntaxhighlight>
 +
{{CodeDocDetailBody|}}
 +
{{CodeDocDetailParamStart}}
 +
{{CodeDocDetailParam|asString|[[../../tString|tString]]|}}
 +
{{CodeDocDetailParam|aLabel|uint|}}
 +
{{CodeDocDetailParam|alWarningLevel|int|}}
 
{{CodeDocDetailReturn|void|}}
 
{{CodeDocDetailReturn|void|}}
 
{{CodeDocDetailBottom}}
 
{{CodeDocDetailBottom}}

Latest revision as of 22:05, 24 August 2020

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type Function and Description
void Error(const tString &in asString)
void Error(uint aLabel, const tString &in asString)
void Error(const tString &in asString, uint aLabel)
void FatalError(const tString &in asString)
void Log(const tString &in asString)
void Log(uint aLabel, const tString &in asString)
void Log(const tString &in asString, uint aLabel)
void LogNewLine(const tString &in asString)
void Warning(const tString &in asString)
void Warning(uint aLabel, int alWarningLevel, const tString &in asString)
void Warning(const tString &in asString, uint aLabel, int alWarningLevel)

Function Detail

Error

void Error(const tString &in asString)


Parameters

Returns:

  • void

Error

void Error(uint aLabel,
           const tString &in asString)


Parameters

  • aLabel (uint) —
  • asString (tString) —

Returns:

  • void

Error

void Error(const tString &in asString,
           uint aLabel)


Parameters

  • asString (tString) —
  • aLabel (uint) —

Returns:

  • void

FatalError

void FatalError(const tString &in asString)


Parameters

Returns:

  • void

Log

void Log(const tString &in asString)


Parameters

Returns:

  • void

Log

void Log(uint aLabel,
         const tString &in asString)


Parameters

  • aLabel (uint) —
  • asString (tString) —

Returns:

  • void

Log

void Log(const tString &in asString,
         uint aLabel)


Parameters

  • asString (tString) —
  • aLabel (uint) —

Returns:

  • void

LogNewLine

void LogNewLine(const tString &in asString)


Parameters

Returns:

  • void

Warning

void Warning(const tString &in asString)


Parameters

Returns:

  • void

Warning

void Warning(uint aLabel,
             int alWarningLevel,
             const tString &in asString)


Parameters

  • aLabel (uint) —
  • alWarningLevel (int) —
  • asString (tString) —

Returns:

  • void

Warning

void Warning(const tString &in asString,
             uint aLabel,
             int alWarningLevel)


Parameters

  • asString (tString) —
  • aLabel (uint) —
  • alWarningLevel (int) —

Returns:

  • void