Frictional Game Wiki

<h2>iWidget</h2> <div class="level2"> </div> <h3>Fields</h3> <div class="level3"> <p> iWidget has no public fields. </p> </div> <h3>Functions</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0"> Return Type </th><th class="col1"> Function Name </th><th class="col2"> Parameters </th><th class="col3"> Description </th> </tr> </thead> <tr class="row1"> <td class="col0"> void </td><td class="col1"> Update </td><td class="col2"> float afTimeStep </td><td class="leftalign"> </td> </tr> <tr class="row2"> <td class="col0"> bool </td><td class="col1"> ProcessMessage </td><td class="col2"> <a href="/doku.php?id=hpl3:community:scripting:classes:eguimessage" class="wikilink1" title="hpl3:community:scripting:classes:eguimessage">eGuiMessage</a> aMessage, <br/> const <a href="/doku.php?id=hpl3:community:scripting:classes:cguimessagedata" class="wikilink1" title="hpl3:community:scripting:classes:cguimessagedata">cGuiMessageData</a> &in aData, <br/> <em>bool abSkipVisCheck = false</em>, <br/> <em>bool abSkipEnabledCheck = false</em> </td><td class="leftalign"> </td> </tr> <tr class="row3"> <td class="col0"> <a href="/doku.php?id=hpl3:community:scripting:classes:ewidgettype" class="wikilink1" title="hpl3:community:scripting:classes:ewidgettype">eWidgetType</a> </td><td class="col1"> GetType </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row4"> <td class="col0"> void </td><td class="col1"> Init </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row5"> <td class="col0"> <a href="/doku.php?id=hpl3:community:scripting:classes:cguiglobalshortcut" class="wikilink1" title="hpl3:community:scripting:classes:cguiglobalshortcut">cGuiGlobalShortcut</a>@ </td><td class="col1"> AddShortcut </td><td class="col2"> int alKeyModifiers, <br/> <a href="/doku.php?id=hpl3:community:scripting:classes:ekey" class="wikilink1" title="hpl3:community:scripting:classes:ekey">eKey</a> aKey, <br/> <em><a href="/doku.php?id=hpl3:community:scripting:classes:eguimessage" class="wikilink1" title="hpl3:community:scripting:classes:eguimessage">eGuiMessage</a> aMsg = eGuiMessage_ButtonPressed</em>, <br/> <em>const <a href="/doku.php?id=hpl3:community:scripting:classes:cguimessagedata" class="wikilink1" title="hpl3:community:scripting:classes:cguimessagedata">cGuiMessageData</a> &in aData = cGuiMessageData</em>, <br/> <em>bool abBypassVisibility = true</em>, <br/> <em>bool abBypassEnabled = true</em> </td><td class="leftalign"> </td> </tr> <tr class="row6"> <td class="col0"> void </td><td class="col1"> SetToolTip </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:twstring" class="wikilink1" title="hpl3:community:scripting:classes:twstring">tWString</a> &in asToolTip </td><td class="leftalign"> </td> </tr> <tr class="row7"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:twstring" class="wikilink1" title="hpl3:community:scripting:classes:twstring">tWString</a>& </td><td class="col1"> GetToolTip </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row8"> <td class="col0"> void </td><td class="col1"> SetToolTipEnabled </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row9"> <td class="col0"> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ </td><td class="col1"> GetToolTipWidget </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row10"> <td class="col0"> bool </td><td class="col1"> PointIsInside </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector2f" class="wikilink1" title="hpl3:community:scripting:classes:cvector2f">cVector2f</a> &in avPoint, <br/> bool abOnlyClipped </td><td class="leftalign"> </td> </tr> <tr class="row11"> <td class="col0"> void </td><td class="col1"> AttachChild </td><td class="col2"> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ apChild </td><td class="leftalign"> </td> </tr> <tr class="row12"> <td class="col0"> void </td><td class="col1"> RemoveChild </td><td class="col2"> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ apChild </td><td class="leftalign"> </td> </tr> <tr class="row13"> <td class="col0"> <a href="/doku.php?id=hpl3:community:scripting:classes:cguiset" class="wikilink1" title="hpl3:community:scripting:classes:cguiset">cGuiSet</a>@ </td><td class="col1"> GetSet </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row14"> <td class="col0"> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ </td><td class="col1"> GetParent </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row15"> <td class="col0"> void </td><td class="col1"> SetEnabled </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row16"> <td class="col0"> bool </td><td class="col1"> IsEnabled </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row17"> <td class="col0"> void </td><td class="col1"> SetVisible </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row18"> <td class="col0"> bool </td><td class="col1"> IsVisible </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row19"> <td class="col0"> bool </td><td class="col1"> HasFocus </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row20"> <td class="col0"> bool </td><td class="col1"> IsRightUnderMouse </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row21"> <td class="col0"> void </td><td class="col1"> SetName </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:tstring" class="wikilink1" title="hpl3:community:scripting:classes:tstring">tString</a> &in asName </td><td class="leftalign"> </td> </tr> <tr class="row22"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:tstring" class="wikilink1" title="hpl3:community:scripting:classes:tstring">tString</a>& </td><td class="col1"> GetName </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row23"> <td class="col0"> void </td><td class="col1"> SetText </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:twstring" class="wikilink1" title="hpl3:community:scripting:classes:twstring">tWString</a> &in asText </td><td class="leftalign"> </td> </tr> <tr class="row24"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:twstring" class="wikilink1" title="hpl3:community:scripting:classes:twstring">tWString</a>& </td><td class="col1"> GetText </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row25"> <td class="col0"> <a href="/doku.php?id=hpl3:community:scripting:classes:ifontdata" class="wikilink1" title="hpl3:community:scripting:classes:ifontdata">iFontData</a>@ </td><td class="col1"> GetDefaultFontType </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row26"> <td class="col0"> void </td><td class="col1"> SetDefaultFontType </td><td class="col2"> <a href="/doku.php?id=hpl3:community:scripting:classes:ifontdata" class="wikilink1" title="hpl3:community:scripting:classes:ifontdata">iFontData</a>@ apFont </td><td class="leftalign"> </td> </tr> <tr class="row27"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:ccolor" class="wikilink1" title="hpl3:community:scripting:classes:ccolor">cColor</a>& </td><td class="col1"> GetDefaultFontColor </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row28"> <td class="col0"> void </td><td class="col1"> SetDefaultFontColor </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:ccolor" class="wikilink1" title="hpl3:community:scripting:classes:ccolor">cColor</a> &in aColor </td><td class="leftalign"> </td> </tr> <tr class="row29"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector2f" class="wikilink1" title="hpl3:community:scripting:classes:cvector2f">cVector2f</a>& </td><td class="col1"> GetDefaultFontSize </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row30"> <td class="col0"> void </td><td class="col1"> SetDefaultFontSize </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector2f" class="wikilink1" title="hpl3:community:scripting:classes:cvector2f">cVector2f</a> &in avSize </td><td class="leftalign"> </td> </tr> <tr class="row31"> <td class="col0"> void </td><td class="col1"> SetClipActive </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row32"> <td class="col0"> bool </td><td class="col1"> GetClipActive </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row33"> <td class="col0"> void </td><td class="col1"> SetPosition </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a> &in avPos </td><td class="leftalign"> </td> </tr> <tr class="row34"> <td class="col0"> void </td><td class="col1"> SetGlobalPosition </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a> &in avPos </td><td class="leftalign"> </td> </tr> <tr class="row35"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a>& </td><td class="col1"> GetLocalPosition </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row36"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a>& </td><td class="col1"> GetGlobalPosition </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row37"> <td class="col0"> void </td><td class="col1"> SetChildrenOffset </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a> &in </td><td class="leftalign"> </td> </tr> <tr class="row38"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a>& </td><td class="col1"> GetChildrenOffset </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row39"> <td class="col0"> void </td><td class="col1"> SetAffectedByScroll </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row40"> <td class="col0"> void </td><td class="col1"> SetScrollAmount </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a> &in avX </td><td class="leftalign"> </td> </tr> <tr class="row41"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector3f" class="wikilink1" title="hpl3:community:scripting:classes:cvector3f">cVector3f</a>& </td><td class="col1"> GetScrollAmount </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row42"> <td class="col0"> void </td><td class="col1"> CenterGlobalPositionInSet </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row43"> <td class="col0"> void </td><td class="col1"> SetSize </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector2f" class="wikilink1" title="hpl3:community:scripting:classes:cvector2f">cVector2f</a> &in avSize </td><td class="leftalign"> </td> </tr> <tr class="row44"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:cvector2f" class="wikilink1" title="hpl3:community:scripting:classes:cvector2f">cVector2f</a>& </td><td class="col1"> GetSize </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row45"> <td class="col0"> void </td><td class="col1"> SetColorMul </td><td class="col2"> const <a href="/doku.php?id=hpl3:community:scripting:classes:ccolor" class="wikilink1" title="hpl3:community:scripting:classes:ccolor">cColor</a> &in aColor </td><td class="leftalign"> </td> </tr> <tr class="row46"> <td class="col0"> const <a href="/doku.php?id=hpl3:community:scripting:classes:ccolor" class="wikilink1" title="hpl3:community:scripting:classes:ccolor">cColor</a>& </td><td class="col1"> GetColorMul </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row47"> <td class="col0"> bool </td><td class="col1"> ClipsGraphics </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row48"> <td class="col0"> bool </td><td class="col1"> GetMouseIsOver </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row49"> <td class="col0"> bool </td><td class="col1"> IsConnectedTo </td><td class="col2"> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ apWidget, <br/> <em>bool abIsStartWidget = true</em> </td><td class="leftalign"> </td> </tr> <tr class="row50"> <td class="col0"> bool </td><td class="col1"> IsConnectedToChildren </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row51"> <td class="col0"> void </td><td class="col1"> SetConnectedToChildren </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row52"> <td class="col0"> <a href="/doku.php?id=hpl3:community:scripting:classes:cguigfxelement" class="wikilink1" title="hpl3:community:scripting:classes:cguigfxelement">cGuiGfxElement</a>@ </td><td class="col1"> GetPointerGfx </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row53"> <td class="col0"> void </td><td class="col1"> SetGlobalKeyPressListener </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row54"> <td class="col0"> bool </td><td class="col1"> IsGlobalKeyPressListener </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row55"> <td class="col0"> void </td><td class="col1"> SetUserValue </td><td class="col2"> int alX </td><td class="leftalign"> </td> </tr> <tr class="row56"> <td class="col0"> int </td><td class="col1"> GetUserValue </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row57"> <td class="col0"> void </td><td class="col1"> SetCallbacksDisabled </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row58"> <td class="col0"> bool </td><td class="col1"> GetCallbacksDisabled </td><td class="col2"> const </td><td class="leftalign"> </td> </tr> <tr class="row59"> <td class="col0"> void </td><td class="col1"> SetFocusNavigation </td><td class="col2"> <a href="/doku.php?id=hpl3:community:scripting:classes:euiarrow" class="wikilink1" title="hpl3:community:scripting:classes:euiarrow">eUIArrow</a> aDir, <br/> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ apWidget </td><td class="leftalign"> </td> </tr> <tr class="row60"> <td class="col0"> <span class="curid"><a href="/doku.php?id=hpl3:community:scripting:classes:iwidget" class="wikilink1" title="hpl3:community:scripting:classes:iwidget">iWidget</a></span>@ </td><td class="col1"> GetFocusNavigation </td><td class="col2"> <a href="/doku.php?id=hpl3:community:scripting:classes:euiarrow" class="wikilink1" title="hpl3:community:scripting:classes:euiarrow">eUIArrow</a> aDir </td><td class="leftalign"> </td> </tr> <tr class="row61"> <td class="col0"> bool </td><td class="col1"> HasFocusNavigation </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> <tr class="row62"> <td class="col0"> void </td><td class="col1"> SetGlobalUIInputListener </td><td class="col2"> bool abX </td><td class="leftalign"> </td> </tr> <tr class="row63"> <td class="col0"> bool </td><td class="col1"> IsGlobalUIInputListener </td><td class="leftalign"> </td><td class="leftalign"> </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h3>Remarks</h3> <div class="level3"> <p> Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki! </p> </div>