ScoreFlash MethodsScoreFlash API Documentation V4.6.0
The ScoreFlash type exposes the following members.
Methods

  NameDescription
Public methodCleanup
Immediately cleans up all messages currently on screen.
Public methodCreateDesignerMessage
Creates a ScoreMessage to be used in the designer.
(Overrides ScoreFlashBase CreateDesignerMessage(String).)
Public methodStatic memberGetAlignBasedOffset
Calculates a pixel offset based on msg.Alignment.ScreenAlign.
Public methodStatic memberPush(Object)
Shows msg nicely. This is the one method you need to know. Usually, you'll use ScoreFlash.Push(object msg) from anywhere in your code.
Public methodStatic memberPush(Object, Color)
Shows msg nicely in the given color!
Public methodStatic memberPush(Object, GUIStyle)
Shows msg using style regardless of normal density or high density screen. It's up to you to make sure that style works correctly. It is recommended that it has alignment set to UpperCenter and wordWrap set to false (word wrap is automatically activated if the message is too long to be properly displayed on screen with minPaddingX.
Public methodStatic memberPush(Object, GUIStyle, GUIStyle)
Shows msg using style or styleHighDensity depending on whether we are on a normal density or high density screen (determined using IsHighDensityDisplay. It's up to you to make sure that style works correctly. It is recommended that it has alignment set to UpperCenter and wordWrap set to false (word wrap is automatically activated if the message is too long to be properly displayed on screen with minPaddingX.
Public methodPushFromInspector
This is just a helper to be able to send messages directly from the inspector. If calling ScoreFlash.Push(...) directly from there, the Screen.width is taken from the inspector window which is not exactly what we want ;-)
Public methodPushLocal(Object)
Public methodPushLocal(Object, Color)
Public methodPushLocal(Object, GUIStyle)
Public methodPushLocal(Object, Color, Int32)
Public methodPushLocal(Object, GUIStyle, GUIStyle)
Public methodPushLocal(Object, GUIStyle, GUIStyle, Int32)
Public methodPushScreen(Vector2, Object)
Public methodPushScreen(Vector2, Object, Color)
Public methodPushScreen(Vector2, Object, GUIStyle)
Public methodPushScreen(Vector2, Object, Color, Int32)
Public methodPushScreen(Vector2, Object, GUIStyle, GUIStyle)
Public methodPushScreen(Vector2, Object, GUIStyle, GUIStyle, Int32)
Public methodPushWorld(ScoreFlashFollow3D, Object)
Public methodPushWorld(Vector3, Vector2, Object)
Public methodPushWorld(ScoreFlashFollow3D, Object, Color)
Public methodPushWorld(ScoreFlashFollow3D, Object, GUIStyle)
Public methodPushWorld(Vector3, Vector2, Object, Color)
Public methodPushWorld(Vector3, Vector2, Object, GUIStyle)
Public methodPushWorld(ScoreFlashFollow3D, Object, GUIStyle, GUIStyle)
Public methodPushWorld(Vector3, Vector2, Object, Color, Int32)
Public methodPushWorld(Vector3, Vector2, Object, GUIStyle, GUIStyle)
Public methodPushWorld(Vector3, Vector2, Object, GUIStyle, GUIStyle, Int32)
Public methodShowObsolete.
Legacy method - no longer recommended. Use ScoreFlash.Instance.PushLocal(object) (PushLocal(Object)) instead.
Public methodUpgradeCheck
Performs a couple of checks to ensure that everything is set up correctly after an upgrade to a new version.
(Overrides ScoreFlashBase UpgradeCheck .)
Back to Top
See Also