ScoreMessage PropertiesScoreFlash API Documentation V4.6.0
The ScoreMessage type exposes the following members.
Properties

  NameDescription
Public propertyCurrentPhase
The current phase of this ScoreMessage, either FadeIn, Read or FadeOut.
Public propertyCurrentTextColor
Get the color the text should be displayed with. You need to use this in custom renderers. Read only!
Public propertyFollow3D
This can be used by 3D renders to get all relevant information.
Public propertyFollowLocation
Used internally. This can be used by 3D renders to get all relevant information.
Public propertyFreezeOnRead
If true, this will set LocalTimeScale to 0 when the message reaches its read state, resulting in the message becoming persistent.
Public propertyInnerAnchor
Gets or sets the anchor of the message itself. Usually, you should configure this in your ScoreFlash instance - but being able to set this from code may help in some situations. You need to check this when doing your own custom renderers!
Public propertyIsSceneView
Returns true if we are currently rendering in the scene view.
Public propertyIsVisible
Should this message currently be visible? You can set this; however, if using ScoreFlashFollow3D, this may override, if invisible (in other words: when the renderer of the ScoreFlashFollow3D is not visible, the message will never be visible even if you assign true!)
Public propertyLocalTimeScale
Get or set the local time scale of this message. Use this to make individual messages either move quicker (values above 1) or more slowly (values between 0 and 1). If you set this to 0, the message stops moving, so that way, you can make it "persistent".
Public propertyMaxWidth
Get the maximum width this score message is allowed to consume. Read only!
Public propertyOriginalPosition
The original position of the message without applying any translation. If using screen align, these are basically the 9 positions on screen (top left, top center etc.); when using ScoreFlashFollow3D, this is the location after the 3D translation has been applied, before the 2D translation is applied.
Public propertyOutlineColor
Get the color the outline should currently have. You need to use this in custom renderers. Read only!
Public propertyPosition
Get the current position of the message (in screen coordinates as used by UnityGUI, top-left is (0, 0)!). Read only!
Public propertyRotation
Get the current rotation in degrees. You need to use this in custom renderers. Read only!
Public propertyScale
Get the current scale - 1 means "original scale". You need to use this in custom renderers. Read only!
Public propertyScreenAlign
Gets or sets the screen alignment of this message. Usually, you should configure this in your ScoreFlash instance - but being able to set this from code may help in some situations. You need to check this when doing your own custom renderers!
Public propertyText
Get or set the current text of the message. Changing the text when the message is already floating may result in unexpected behavior! If isDebug is active, the text is ignored and a debug message is shown instead. See isDebugMode.
Back to Top
See Also