umsg.PoolString
From GMod Wiki
Revision as of 23:55, 21 October 2009 by Crazy Quebecer (Talk | contribs)
| Function | |
| Syntax |
umsg.PoolString( String value ) Where is this used? |
| Description: | |
| Pools a User Message name. This adds a string to a table that is shared between the client and server. This is useful for strings that are being sent often. | |
| Returns: | nil |
| Part of Library: | umsg |
| Realm: |
 |
| BBCode Link: | [b][url=http://wiki.garrysmod.com/?title=Umsg.PoolString]Umsg.PoolString [img]http://wiki.garrysmod.com/favicon.ico[/img][/url][/b] |
Examples
| Description | Pool the string "asdf." |
|---|---|
| Used on | |
| Code | --The string is pooled at the top of an entity's init file umsg.PoolString("asdf") function ENT:Use(activator,caller) --Make sure a player used this item if !activator:IsPlayer() then return false end --Send the player a usermessage umsg.Start("Hello",activator) umsg.String("asdf") umsg.End() end |
| Output | N/A |
Additional Notes
- You need to pool the string before you start the usermessage, it will only be pooled once.
- You only need to send the string in the usermessage, it will automatically replace the string with an identifier.
