Search Results for

    Show / Hide Table of Contents

    Class Screen

    Methods to handle UI actions that affect the whole screen.

    Inheritance
    System.Object
    Screen
    Inherited Members
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: GTA.UI
    Assembly: ScriptHookVDotNet3.dll
    Syntax
    public static class Screen

    Fields

    Name Description
    Height

    The base height of the screen used for all UI Calculations

    Width

    The base width of the screen used for all UI Calculations, unless ScaledDraw is used

    Properties

    Name Description
    AspectRatio

    Gets the current screen aspect ratio

    IsFadedIn

    Gets a value indicating whether the screen is faded in.

    IsFadedOut

    Gets a value indicating whether the screen is faded out.

    IsFadingIn

    Gets a value indicating whether the screen is fading in.

    IsFadingOut

    Gets a value indicating whether the screen is fading out.

    Resolution

    Gets the actual screen resolution the game is being rendered at

    ScaledWidth

    Gets the screen width scaled against a 720pixel height base.

    Methods

    Name Description
    FadeIn(Int32)

    Fades the screen in over a specific time, useful for transitioning

    FadeOut(Int32)

    Fades the screen out over a specific time, useful for transitioning

    IsEffectActive(ScreenEffect)

    Gets a value indicating whether the specific screen effect is running.

    ShowHelpTextThisFrame(String)

    Displays a help message in the top corner of the screen this frame. Beeping sound will be played.

    ShowHelpTextThisFrame(String, Boolean)

    Displays a help message in the top corner of the screen this frame. Specify whether beeping sound plays.

    ShowSubtitle(String, Int32)

    Shows a subtitle at the bottom of the screen for a given time

    StartEffect(ScreenEffect, Int32, Boolean)

    Starts applying the specified effect to the screen.

    StopEffect(ScreenEffect)

    Stops applying the specified effect to the screen.

    StopEffects()

    Stops all currently running effects.

    WorldToScreen(Vector3, Boolean)

    Translates a point in WorldSpace to its given Coordinates on the Screen

    ☀
    ☾
    Back to top Copyright (C) 2015 crosire - zlib
    Generated with DocFX