Draw XXL documentation


Draw Text.WriteList2D(...);

Draw a C# list as text table into the XY-2D-plane. Seven different datatypes as list content are available: bool, int, float, string, Vector2, Vector3 and Vector4.

Green parameters are required. Yellow parameters are optional, but have to be supplied in order.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfBool_in2D and drawListOfBool_in2D_func.

Parameters:
Type Parameter Name Description
List boolList
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfInt_in2D and drawListOfInt_in2D_func.

Parameters:
Type Parameter Name Description
List intList
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfFloat_in2D and drawListOfFloat_in2D_func.

Parameters:
Type Parameter Name Description
List floatList
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfString_in2D and drawListOfString_in2D_func.

Parameters:
Type Parameter Name Description
List stringList
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfVector2_in2D and drawListOfVector2_in2D_func.

Parameters:
Type Parameter Name Description
List vector2List
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfVector3_in2D and drawListOfVector3_in2D_func.

Parameters:
Type Parameter Name Description
List vector3List
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawText.WriteList2D(...);

Code snippet names: drawListOfVector4_in2D and drawListOfVector4_in2D_func.

Parameters:
Type Parameter Name Description
List vector4List
Vector2 position
Color color
string title
float textSize "textSize" defines the text size, specifically the width per letter. The overall size of the drawn table depends on the collection count, or can be forced with "forceHeightOfWholeTableBox", in which case this "textSize" parameter is ignored.
float forceHeightOfWholeTableBox This overwrites "textSize" if another value than the default value of 0 is used.
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
bool position_isTopLeft_notLowLeft Defines whether the position parameter anchors the top-left position of the table or the low-left position of the table.
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.