Public and Privates +rep

[TriggerHappy]

Well , ive seen many vJASS Systems and Spells using public and private functions. Ive also read some vJASS Tutorials and i dont really understand them. Could somebody please explain to me what they are and a good example use of them. + rep.

 

[Trollvottel]

public can be refered to from outside the scope/library

privates are only for the scope/library

should not be so hard to find a use for this, huh

 

[TriggerHappy]

Haha , im a vJASS newb and trying to learn it, im am also confused about scopes

EDIT : ok , another question i think i understand structs , Basicly the main purpose it to replace locals , to make your code shorter?

 

[Azlier]

Okay, lets assume you have two healing functions.

function Heal takes nothing returns nothing
//blah, blah, blah...
endfunction

//=================================
function Init takes nothing returns nothing
 local trigger t = CreateTrigger()
 call TriggerAddAction(t,Heal)
 call TriggerRegisterAnyUnitEventBJ(t,EVENT_HERE)
 set t = null
endfunction

//NEXT TRIGGER

function Heal takes nothing returns nothing
//Yap, yap yap...
endfunction

//==============================
function Init takes nothing returns nothing
 local trigger t = CreateTrigger()
 call TriggerAddAction(t,Heal)
 call TriggerRegisterAnyUnitEventBJ(t,EVENT_HERE)
 set t = null
endfunction

Now, when defining the second Heal function, there's going to be a syntax error. Since Heal is a good function name and plan to use it, what can you do besides adding some weird prefix? That's where scopes come in.

A scope is broken down into four words (or something like that).
scope - This declares the start of a scope.
HealAll - This is the name of the scope.
initializer - The tells the system that the Initializer function is next.
Init - This is the name of the chosen initializer. If you look below, you can actually see the Init function.

scope HealAll initializer Init

private function Heal takes nothing returns nothing
//blah, blah, blah...
endfunction

//=================================
private function Init takes nothing returns nothing
 local trigger t = CreateTrigger()
 call TriggerAddAction(t,Heal)
 call TriggerRegisterAnyUnitEventBJ(t,EVENT_HERE)
 set t = null
endfunction

endscope

//NEXT TRIGGER
scope HealOne initializer Init

private function Heal takes nothing returns nothing
//blah, blah, blah...
endfunction

//=================================
private function Init takes nothing returns nothing
 local trigger t = CreateTrigger()
 call TriggerAddAction(t,Heal)
 call TriggerRegisterAnyUnitEventBJ(t,EVENT_HERE)
 set t = null
endfunction

endscope

Scopes add a prefix to private functions, so that you can use the same function name over and over, as long as they're private and in separate scopes. At least that's what I've learned...

Wow... I don't have warcraft III so I'm limited to JASS in notepad. It looks so much more professional with the coloring, even though I only know three events, how to display text, and explode units without a bj!

EDIT: Woah, TriggerHappy, weren't you the one who inspires me to learn JASS in the first place?

 

[TriggerHappy]

Haha , i was just messing around in world editor and learned this , and now i check back and you did the same thing. But what i dont get is , you cant call private functions from outside of the scope?....

 

[Trollvottel]

But what i dont get is , you cant call private functions from outside of the scope?....

why do you think they are called "private"?^^

 

[Azlier]

If you want to be able to call them from outside the scope, it goes public function, not private. BEWARE: You can't have public functions with the same name AFAIK.

 

[TriggerHappy]

Then how would you use privates , how would you even call them or begin them.

 

[Azlier]

A private function is easily called... if called within the scope in which it resides. To get them from somewhere else, you eed to use public.

 

[Cokemonkey11]

from what im getting (im learning too) its just

call function

within the scope

 

[TriggerHappy]

oh.... It just needs to be inside the scope to be called. Thanks


UGH , i still have no idea on why you would need to use this

 

[Darthfett]

oh.... It just needs to be inside the scope to be called. Thanks


UGH , i still have no idea on why you would need to use this

It's to prevent you from having problems with functions with conflicting names, when creating/importing functions.

It's also nice so that you can name every trigger's InitTrig function

public/private function Init/InitTrig

public/private function Actions

public/private function Conditions

That way you don't have to change as much if you choose to copy/paste something.

 

[Cokemonkey11]

If scope gives all this added functionality, when would you ever want something outside a scope??

 

[saw792]

You wouldn't...

All coding now is done in either a scope or a library. A library is like a scope, except it is automatically moved to the top of the jass script upon saving. Libraries are generally used for systems that are needed by multiple other functions.

I think somebody was confused about publics as well. You can certainly have a public function with the same name as another public function, as long as they are not in the same scope/library.

function Test takes nothing returns nothing

compiles to

function Test takes nothing returns nothing

public function Test takes nothing returns nothing

compiles to

function SCOPENAME_Test takes nothing returns nothing

private function Test takes nothing returns nothing

compiles to

function SCOPENAME__Test+(Some random digits or something) takes nothing returns nothing