Garry's Mod Wiki Discussion

[Rubat]

[QUOTE=JasonMan34;52228173]Could someone that understands the bit library make the description a little bit more in-depth for its methods? More specifically [img]http://wiki.garrysmod.com/favicon.ico[/img] [url=http://wiki.garrysmod.com/page/bit/bor]bit.bor[/url] [img]http://wiki.garrysmod.com/favicon.ico[/img] [url=http://wiki.garrysmod.com/page/bit/bnot]bit.bnot[/url] [img]http://wiki.garrysmod.com/favicon.ico[/img] [url=http://wiki.garrysmod.com/page/bit/bxor]bit.bxor[/url] and [img]http://wiki.garrysmod.com/favicon.ico[/img] [url=http://wiki.garrysmod.com/page/bit/band]bit.band[/url], which tells me (ignorant when it comes to this) nothing[/QUOTE]

[url]https://code.tutsplus.com/articles/understanding-bitwise-operators--active-11301[/url]

[Rubat]

FYI I expanded the searching on the wiki so you can specify what realm you want to see functions from.

[img]http://i.imgur.com/O33tsB4.png[/img]

just add "realm:x" into your search (separate with a space from your search terms) and it should filter out anything that isn't what you specified.

X can be:
sv/server - Serverside only ( Does not include shared )
cl/client - Clientside only ( Does not include shared )
sh/shared - Shared only
all/shared_m - Functions only available in all realms ( menu, server, client )
mn/menu - menu Only ( does not include "all" or "client & menu" )
client_m - Functions only available in both menu and client realms

You can also enter a raw Enum and it will pull up that enum in the search:
[img]http://i.imgur.com/TiCzqFq.png[/img]

[NeatNit]

[url]http://wiki.garrysmod.com/page/File:addon_menu_numbered.png[/url]

[img]http://i.imgur.com/GTXho7L.png[/img]

Why is this happening?! :scream:

[Hnaknaw]

[QUOTE=NeatNit;52308052][URL]http://wiki.garrysmod.com/page/File:addon_menu_numbered.png[/URL]

[IMG]http://i.imgur.com/GTXho7L.png[/IMG]

Why is this happening?! :scream:[/QUOTE]

Lol

I thought I could remove, but then I set that image as the default :what:

I set the main image back though :cat:

[SirRanjid]

The only thing that has bugged me ever since in the new wiki. The search doesn't show what the sidebar finds.

I'd also like to have the results from the sidebar listed there because from the search page it's easier to navigate.
Ever hit enter in the search of the sidebar?

Or make the sidebar save the last entry upon clicking a result so the filter wont reset itself.

[img]http://i.imgur.com/OZc9OE4.png[/img]
[img]http://i.imgur.com/8xkSKLb.png[/img] [img]http://i.imgur.com/Mxz4U77.png[/img]

[Rubat]

The MediaWiki search is unrelated to the sidebar search in any way, the mediawiki search will not be changed.

But I guess I could make the sidebar take the value from the search page if its open.

[SirRanjid]

I would have just given you some cool rating but I dunno why I can't so: Thanks :)

[Bobblehead]

lal is Panel:GWEN_SetHorizonta[B]lAl[/B]ign

EDIT:
Oh I get what you mean.

[Rubat]

It should work now:
[url]http://wiki.garrysmod.com/page/Special:Search?search=lal&fulltext=Search[/url]

Sidebar should have 'lal' autoentered.

[YourStalker]

Not sure what can be done about this but thought it was worth reporting.

Not underscore:
[IMG]http://i.imgur.com/dILhpQo.png[/IMG]

With underscore:
[IMG]http://i.imgur.com/bvqDw8w.png[/IMG]

Same results when I hit enter to search.

[Rubat]

Should be fixed whenever JS updates.

[JasonMan]

Is there any documentation of flags16? [URL="https://facepunch.com/showthread.php?t=1374457&p=45348502&viewfull=1#post45348502"]Well except for this :v:[/URL]

[Rubat]

Do we need to "document" textures that are shipped with the game?

[JasonMan]

[QUOTE=Robotboy655;52387157]Do we need to "document" textures that are shipped with the game?[/QUOTE]

I mean there's [URL="http://wiki.garrysmod.com/page/Silkicons"]this page[/URL], so why not flags16?
Besides it's useful to know. I wanted to use flags and had no idea they exist already.

[Bobblehead]

[QUOTE=JasonMan34;52387190]I mean there's [URL="http://wiki.garrysmod.com/page/Silkicons"]this page[/URL], so why not flags16?
Besides it's useful to know. I wanted to use flags and had no idea they exist already.[/QUOTE]

Feel free to add flags to that page.

The wiki is open for anyone to edit, guys.

[MysteryPancake]

Is it considered okay to post GitHub links related to things on the wiki? For example, I'm thinking of posting a link to my [URL="https://github.com/Mysterypancake1/GMod-Rainbows"]rainbow functions[/URL] on the [url=http://wiki.garrysmod.com/page/Global/HSVToColor]HSVToColor[/url] page. Is this okay to do, or is plain code preferred?

[Rubat]

I'd say it's better to put the code itself, for such cases when the link eventually dies.

In your case I think that putting all those functions to examples is a bad idea, only one of them might be fine.

[MysteryPancake]

:snip: useless reply why did i post this where is the delete button help

[MysteryPancake]

Sorry to bump this thread again, but I'd like to find out how much of Garry's Mod is undocumented.

[URL="https://facepunch.com/showthread.php?t=1250533&p=49691273&viewfull=1#post49691273"]It seems that a lot of panel functions aren't documented[/URL], and I'm wondering how much else is missing.

Also, if things are undocumented, wouldn't it at least be worth auto-creating a page for each thing until someone fills it in?

You could even encourage people by slapping a big green progress bar somewhere on the wiki that gets a bit more filled every time something gets documentation.

[Deathking15]

[QUOTE=MPan1;52864878]Sorry to bump this thread again, but I'd like to find out how much of Garry's Mod is undocumented.

[URL="https://facepunch.com/showthread.php?t=1250533&p=49691273&viewfull=1#post49691273"]It seems that a lot of panel functions aren't documented[/URL], and I'm wondering how much else is missing.

Also, if things are undocumented, wouldn't it at least be worth auto-creating a page for each thing until someone fills it in?

You could even encourage people by slapping a big green progress bar somewhere on the wiki that gets a bit more filled every time something gets documentation.[/QUOTE]

This guy right here as the game's best intentions at heart, always helping people in every thread he comments in.

I agree, I'm in the middle of creating a menu for a gamemode, and it's frustrating discovering new functions I could have utilized earlier. Many function names are self-explanatory, and don't require much explanation, so even [I]knowing[/I] about them would have been useful.

[c👌de_g🎷]

[QUOTE=MPan1;52864878]Sorry to bump this thread again, but I'd like to find out how much of Garry's Mod is undocumented.

[URL="https://facepunch.com/showthread.php?t=1250533&p=49691273&viewfull=1#post49691273"]It seems that a lot of panel functions aren't documented[/URL], and I'm wondering how much else is missing.

Also, if things are undocumented, wouldn't it at least be worth auto-creating a page for each thing until someone fills it in?

You could even encourage people by slapping a big green progress bar somewhere on the wiki that gets a bit more filled every time something gets documentation.[/QUOTE]

Panel functions are the only ones fully undocumented. [URL="http://wiki.garrysmod.com/page/Category:Stub_Pages"]Undescribed functions at least have pages created for them[/URL], but it's different for panels since functions for registered types aren't added to the registry or any other table of functions - perhaps you could override vgui.Register and compare the added functions to the panel metatable/a hard-coded list of callbacks. I'll finish up Entity and its inheritants' functions at least.

[MysteryPancake]

[QUOTE=Deathking15;52866430]This guy right here as the game's best intentions at heart, always helping people in every thread he comments in[/QUOTE]
No, i HATE everyone and Garry's Mod

[URL="https://wiki.garrysmod.com/page/Special:RecentChanges"]It seems Robotboy created a ton of pages[/URL], so I'm excited to fill stuff in

[Rubat]

This is taking a lot of time and reminds me of how poorly thought out the vgui elements all are.

[editline]8th November 2017[/editline]

Like why is [url]http://wiki.garrysmod.com/page/Category:DHorizontalDivider[/url] named HORIZONTAL while the divider is vertical...

[MysteryPancake]

[QUOTE=Robotboy655;52867632]This is taking a lot of time and reminds me of how poorly thought out the vgui elements all are.[/QUOTE]
I could try to make a script to auto-add pages if you want.

[editline]8th November 2017[/editline]

[QUOTE=Robotboy655;52867632]Like why is [url]http://wiki.garrysmod.com/page/Category:DHorizontalDivider[/url] named HORIZONTAL while the divider is vertical...[/QUOTE]
Maybe because it divides panels that are placed horizontally. I guess all panels are horizontal though.

[YourStalker]

To an extent, is it really that important to have a dedicated page for each minor sub-VGUI element? Certain elements used exclusively for one larger element could just have a one line description in the wiki page for the parent element. It gets to the point where you’re putting implementation on the wiki rather than interface.

[MysteryPancake]

[QUOTE=YourStalker;52868220]To an extent, is it really that important to have a dedicated page for each minor sub-VGUI element? Certain elements used exclusively for one larger element could just have a one line description in the wiki page for the parent element. It gets to the point where you’re putting implementation on the wiki rather than interface.[/QUOTE]

I still think it's important to have as much documented as possible.
There are lots of examples of very minor elements having very helpful methods that most people don't know about.

[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/lua/vgui/dvscrollbar.lua#L69"]For example, the DVScrollbar has a method to hide its buttons which works far better than removing them[/URL].
I found this a while ago when someone asked about it, but I had no clue it existed because the wiki never even mentions it anywhere.

Besides, extra documentation doesn't get in the way, you can still navigate and search for whatever you want.
If the problem is that it takes too long to make pages and populate, then I could try doing it myself. I like derma.

[c👌de_g🎷]

[QUOTE=YourStalker;52868220]To an extent, is it really that important to have a dedicated page for each minor sub-VGUI element? Certain elements used exclusively for one larger element could just have a one line description in the wiki page for the parent element. It gets to the point where you’re putting implementation on the wiki rather than interface.[/QUOTE]

Each element needs to have a documented interface for people to use it without having to hunt in the source code.

[Rubat]

[QUOTE=MPan1;52868227]I still think it's important to have as much documented as possible.
There are lots of examples of very minor elements having very helpful methods that most people don't know about.

[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/lua/vgui/dvscrollbar.lua#L69"]For example, the DVScrollbar has a method to hide its buttons which works far better than removing them[/URL].
I found this a while ago when someone asked about it, but I had no clue it existed because the wiki never even mentions it anywhere.

Besides, extra documentation doesn't get in the way, you can still navigate and search for whatever you want.
If the problem is that it takes too long to make pages and populate, then I could try doing it myself. I like derma.[/QUOTE]

Yeah I needed that for my Lua menu so I added it.

As for automatically creating the pages, I don't think there's much point to it considering they still need to be manually filled with content anyway.

[MysteryPancake]

Also, I noticed a few hooks that are added but are left unmentioned. For example:
[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/sandbox/gamemode/spawnmenu/creationmenu/content/contenttypes/entities.lua#L2"]PopulateEntities[/URL]
[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/sandbox/gamemode/spawnmenu/creationmenu/content/contenttypes/postprocess.lua#L2"]PopulatePostProcess[/URL]
[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/sandbox/gamemode/spawnmenu/creationmenu/content/contenttypes/npcs.lua#L2"]PopulateNPCs[/URL]
[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/sandbox/gamemode/spawnmenu/creationmenu/content/contenttypes/vehicles.lua#L2"]PopulateVehicles[/URL]
[URL="https://github.com/Facepunch/garrysmod/blob/master/garrysmod/gamemodes/sandbox/gamemode/spawnmenu/creationmenu/content/contenttypes/weapons.lua#L2"]PopulateWeapons[/URL]

I get that these are only for sandbox and that there's literally no other use for them anywhere, but I'm just worried that nobody has checked through all the code in Garry's Mod yet.
There may be other things missing, unless this was intentional.

[editline]8th November 2017[/editline]

[QUOTE=Robotboy655;52868243]As for automatically creating the pages, I don't think there's much point to it considering they still need to be manually filled with content anyway.[/QUOTE]
I was just thinking that a lot of pages follow the same pattern.
They have a description, they list the arguments, and list the return values.
Most of them don't have examples.

I don't think it'd be that hard to make a generator that goes through every panel method and gets the names of the function, arguments, and return values.
Of course, you'd still have to fill in the description and types, but it'd be a lot faster.

I'll try something later to see if it's easier.

[MPan1 banned]

Has anyone noticed the wiki is now broken thanks to the forum update?
If you try to use the link button on the wiki it now breaks the new forum
For example:
[img]http://wiki.garrysmod.com/favicon.ico[/img] [url=http://wiki.garrysmod.com/page/GM/OnPlayerChat]GM:OnPlayerChat[/url]
Doesn't that look great