Graphics::drawText: Difference between revisions

Latest revision as of 20:33, 22 August 2020

Syntax

mp.game.graphics.drawText(text, [x, y [, z]], { font, color, scale, outline, centre });

Required Arguments

text: String: structured text to show (utilizes Fonts_and_Colors and Control Characters)
x: Float: X position in the screen (0.0 to 1.0)
y: Float: Y position in the screen (0.0 to 1.0)
z: Float: Include Z parameter when rendering to a 3D space (change X and Y to world co-ordinates)
font: Int: font id
color: Array: Color of the text plus alpha
scale: Array ([x, y]): scale of the text (1.0 is a good value)
outline: Bool: Text has borders or not

Return value

Unknown

Example

Client-Side

mp.events.add('render', () => {
    // Draw to screen.
    mp.game.graphics.drawText("Text at the top of the screen", [0.5, 0.005], { 
      font: 7, 
      color: [255, 255, 255, 185], 
      scale: [1.2, 1.2], 
      outline: true
    });

    // Draw to world.
    mp.game.graphics.drawText("Text in the world", [-1234, 1337, 15], { 
      font: 7, 
      color: [255, 255, 255, 185], 
      scale: [1.2, 1.2], 
      outline: true,
      centre: true
    });

    // Draw to screen using red color on a next line.
    mp.game.graphics.drawText("Text at the top of the screen\n~r~Next line in red color", [0.5, 0.005], { 
      font: 7, 
      color: [255, 255, 255, 185], 
      scale: [1.2, 1.2], 
      outline: true
    });
});