UI/Frame Types/DataRefFrame

From SC2Mapster Wiki
Jump to: navigation, search

DataRefFrame

Provides capability to reference values outside the scope of Layouts. Internally it relies on the same functionality as [d] text tag.


Argument 2 attributes: name [string] category --- val [string] actual value we want to reference.

PlayerId [uint8] [constant] if the referenced value can vary per player, we can explicitly choose the player by its number. If the field is omitted it defaults to current

RealVaue [fixed32] [readonly] referenced value as real

StringVaue [string] [readonly] referenced value as string

Structure

N/A

DataRefFrame Properties

DataRefFrame inherits from Frame and shares all of its properties. Additionally it has:


Argument
The is the argument value of a DataRefFrame


PlayerId
The is the argument value of a DataRefFrame


RealValue
The is the argument value of a DataRefFrame


StringValue
The is the argument value of a DataRefFrame

Examples

<Frame type="DataRefFrame" name="RefValue">
    <Anchor relative="$parent"/>
    <Argument name="GalaxyVar" val="gv_test1"/>
</Frame>
<!-- {RefValue/@StringValue} -->
<!-- {RefValue/@RealValue} -->
<Frame type="DataRefFrame" name="RefValue">
    <Anchor relative="$parent"/>
    <Argument name="GameValue" val="PlayerClanTag"/>
    <PlayerId val="1"/>
</Frame>
<Frame type="DataRefFrame" name="RefValue">
    <Anchor relative="$parent"/>
    <Argument name="score" val="UnitsKilledCount"/>
    <PlayerId val="1"/>
</Frame>