Garry's Mod Wiki

Revision Difference

DTextEntry:AllowInput#528435

<function name="AllowInput" parent="DTextEntry" type="panelfunc"> <ispanel>yes</ispanel> <description> Called whenever the value of the panel has been updated (whether by user input or otherwise). It allows you to determine whether a user can modify the <page>TextEntry</page>'s text. By default, this only checks whether the panel disallows numeric characters, preventing it from being edited if the value contains any. This is actually an engine hook that only works on <page>TextEntry</page> derived elements. </description> <realm>Client</realm> <file line="297">lua/vgui/dtextentry.lua</file> <file line="313-L319">lua/vgui/dtextentry.lua</file> <args> <arg name="char" type="string">The last character entered into the panel.</arg> </args> <rets> <ret name="" type="boolean">Return true to prevent the value from changing, false to allow it.</ret> <ret name="" type="boolean">Return `true` to prevent the value from changing, `false` to allow it.</ret> </rets> </function> <example> <description>Prevents the user from editing the text entirely.</description> <code> local TextEntry = vgui.Create( "DTextEntry" ) TextEntry.AllowInput = function( self, stringValue ) return true end </code> <output>The panel does not allow any alterations.</output> </example>