Difference between revisions of "WriteConsole"

From Soldat Community Wiki
Jump to: navigation, search
m (Formatted code)
 
Line 1: Line 1:
 
===From the Scripting Manual===
 
===From the Scripting Manual===
  ''procedure WriteConsole(ID: byte; Text: string; Colour: longint);''
+
  ''procedure WriteConsole(ID: Byte; Text: string; Colour: LongInt);''
 
   
 
   
 
  '''Parameter Info:'''
 
  '''Parameter Info:'''
 
   ID (Byte): Player ID to write text to. Set to 0 to write to all players!
 
   ID (Byte): Player ID to write text to. Set to 0 to write to all players!
   Text (String): Text to be written to the console.
+
   Text (string): Text to be written to the console.
   Colour (Longint): Colour the text should be when drawn to the console.
+
   Colour (LongInt): Colour the text should be when drawn to the console.
 
   
 
   
 
  '''Description:'''
 
  '''Description:'''
Line 13: Line 13:
 
==Examples==
 
==Examples==
 
<source lang="pascal">begin
 
<source lang="pascal">begin
     WriteConsole(0,'Pickled Onions are nice!',$EE81FAA1);
+
     WriteConsole(0, 'Pickled Onions are nice!', $EE81FAA1);
 
     // Will draw: "Pickled Onions are nice!" to ALL players consoles.
 
     // Will draw: "Pickled Onions are nice!" to ALL players consoles.
 
     // $EE81FAA1 is the colour, in AA RR GG BB format. (Alpha, Red, Green,Blue);
 
     // $EE81FAA1 is the colour, in AA RR GG BB format. (Alpha, Red, Green,Blue);

Latest revision as of 15:07, 10 September 2012

From the Scripting Manual

procedure WriteConsole(ID: Byte; Text: string; Colour: LongInt);

Parameter Info:
 ID (Byte): Player ID to write text to. Set to 0 to write to all players!
 Text (string): Text to be written to the console.
 Colour (LongInt): Colour the text should be when drawn to the console.

Description:
 This function will add text to the players(ID) console.
 Set ID to 0 to write the text to ALL Players in the server!

Examples

begin
    WriteConsole(0, 'Pickled Onions are nice!', $EE81FAA1);
    // Will draw: "Pickled Onions are nice!" to ALL players consoles.
    // $EE81FAA1 is the colour, in AA RR GG BB format. (Alpha, Red, Green,Blue);
end;


External Links