Guide: Naming GUI Controls

[cbk1994]

I've seen a lot of people doing this lately, and I wanted to let them know that it should be done differently in nearly all cases.

Rather than naming your GUI windows (and other controls) such as

PHP Code:

new GuiWindowCtrl("Window") {
  // whatever
} 


put part of the thing you're creating it in

PHP Code:

new GuiWindowCtrl("JailInformation_Window") {
 // whatever
} 


The reason this matters is because if you name your buttons things like "Button1" and "Close", which I've seen a lot of people doing, any script that has

PHP Code:

function Button1.onAction() {
  triggerserver("gui", name, "summonAllPlayers");
} 


or any other function having to do with that button would be called, not just the script that created it.

Lesson's over, thanks for reading.

[Tigairius]

Stickied.

[fowlplay4]

I normally name the GuiWindowCtrl's or GuiBitmapBorderCtrl's after the main title for it.

I.e: JailInformation instead of JailInformation_Window

But everything below that uses your naming convention.

I.e Close button: JailInformation_Close

[Chompy]

Personal preference.

[xXziroXx]

Originally Posted by Chompy

Personal preference.

I disagree, more like coding standard.

[cbk1994]

Originally Posted by fowlplay4

I normally name the GuiWindowCtrl's or GuiBitmapBorderCtrl's after the main title for it.

I.e: JailInformation instead of JailInformation_Window

But everything below that uses your naming convention.

I.e Close button: JailInformation_Close

The reason I would add the _Window is so I can, for example, close all those windows.

PHP Code:

for (temp.control : GraalControl.controls) {
  if (control.name.starts("JailInformation_")) {
    control.destroy();
  }
} 


without picking up JailInformation2_Window or whatever for a completely different window.

I see what you mean, though.

Originally Posted by Chompy

Personal preference.

It's not really personal preference. If you name all your windows "Window", you're going to have problems.

[Skyld]

Originally Posted by Chompy

Personal preference.

Actually, it is completely common sense. If we all had scripts using generic GUI object names like "Window", then everyone's scripts would break everyone else's scripts. At least having the name of the script or something means that the chance of collision is much less likely.

It's actually quite funny how many times I came across this when I was a GST; people's scripts not working because they did the exact same thing and used generic object names, only to later find that the same object name had been used elsewhere and that they were going to conflict.

[LoneAngelIbesu]

Originally Posted by Chompy

Personal preference.

I believe Chompy is referring to this:

Originally Posted by fowlplay4

I normally name the GuiWindowCtrl's or GuiBitmapBorderCtrl's after the main title for it.

I.e: JailInformation instead of JailInformation_Window

But everything below that uses your naming convention.

I.e Close button: JailInformation_Close

... not to using descriptive names.

[Chompy]

Originally Posted by LoneAngelIbesu

I believe Chompy is referring to this:


... not to using descriptive names.

Indeed, forgot to quote Jerret. D:
Sorry.

[fowlplay4]

Originally Posted by khortez

Why am I naming my Gui's anything?

So your GUI has an ID that you can use to manipulate/debug it in your code. Properly labeled code is also much more readable.

Labeled incorrectly you would not know which button is the close or open button:

MyForm_Button_1
MyForm_Button_2

Labeled and used correctly you have a much better idea:

MyForm_Button_Open
MyForm_Button_Close

This can be applied to many other object types or GUIs.

[khortez]

Originally Posted by fowlplay4

So your GUI has an ID that you can use to manipulate/debug it in your code. Properly labeled code is also much more readable.

Labeled incorrectly you would not know which button is the close or open button:

MyForm_Button_1
MyForm_Button_2

Labeled and used correctly you have a much better idea:

MyForm_Button_Open
MyForm_Button_Close

This can be applied to many other object types or GUIs.

thanks, now how would i make a custom profile?

[fowlplay4]

Originally Posted by khortez

thanks, now how would i make a custom profile?

Search the forums and the wiki next time:
http://wiki.graal.net/index.php/Crea...g_GUI_Profiles

[khortez]

I have, even seen that link you gave me just now. But there is always a possibility I misinterpreted what i've read.



Edit: If there was anyone that can say they have searched everywhere or at least thoroughly for answers, it'd be me.