Difference between revisions of "DrawIconByName"

From King Arthur's Gold Wiki
Jump to: navigation, search
Line 4: Line 4:
  
 
As this is GUI-related it is client only - it should be wrapped in "if ( getNet().isClient() )" or be in a client-only script.
 
As this is GUI-related it is client only - it should be wrapped in "if ( getNet().isClient() )" or be in a client-only script.
 +
 +
This method is part of the GUI namespace so you need to prefix calls to it with 'GUI::'.
  
 
This method has two variants. They both specify the token name as a string and the position to draw the icon at with a [[position2d]]i but one also specifies a scale factor for the icon as a float.
 
This method has two variants. They both specify the token name as a string and the position to draw the icon at with a [[position2d]]i but one also specifies a scale factor for the icon as a float.
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
void DrawIconByName( const string &iconName, position2di pos )
+
void GUI::DrawIconByName( const string &iconName, position2di pos )
void DrawIconByName( const string &iconName, position2di pos, f32 scale )
+
void GUI::DrawIconByName( const string &iconName, position2di pos, f32 scale )
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
[[Category:Scripting]]
 
[[Category:Scripting]]
 
[[Category:Global Functions]]
 
[[Category:Global Functions]]

Revision as of 23:18, 6 September 2012

Draws an icon added by AddIconToken using its token name.


As this is GUI-related it is client only - it should be wrapped in "if ( getNet().isClient() )" or be in a client-only script.

This method is part of the GUI namespace so you need to prefix calls to it with 'GUI::'.

This method has two variants. They both specify the token name as a string and the position to draw the icon at with a position2di but one also specifies a scale factor for the icon as a float.

void GUI::DrawIconByName( const string &iconName, position2di pos )
void GUI::DrawIconByName( const string &iconName, position2di pos, f32 scale )