Townportal v.5.0

[Moderator]

Townportal System v1.0.4 | Reviewed by Maker | 1st Oct 2013

APPROVED

A nice and useful system In RegisterPortalUnit you have same actions in then and else. Take those actions out of the if/then/else if DO_PAN -> static if DO_PAN Add a function where you can set hometown per player or even per unit SetUnitPosition could be good to use so units won't end up onto of each other when teleporting to town Maybe a special effect would look good when teleporting, the unit just disappears currently

[tr]

 

[BPower]

How can i add the trigger to the description?

edit: fixed

edit: updated

 

[mckill2009]

you should use UnitIndexer or hashtable for this to make it MUI coz atm, its just MPI using only the index of the player, error messages also should use SimError library...

 

[BPower]

you should use UnitIndexer or hashtable for this to make it MUI coz atm

Limits:
- 1.Each player can only have one unit registered to the system

This is my fault, i've added the USE_ABILITY option at the end, because i thought it my be usefull.

When not using EVENT_PLAYER_END_CINEMATIC, it ofc makes sense to make this MUI.

I will fix that.

error messages also should use SimError library...

In case a resources is used in a map, its not helpfull to spam error message to any user, but the map or resource maker.
I think debug call fits very well.

Otherwise i just delete those lines.

EDIT: Updated to v1.0.3

reduced code by 3 Lines and updated documentation.

 

[Maker]

static if USE_ABILITY
GetWidgetLife(portalUnit[id]) > 0.405 -> not IsUnitType(portalUnit[id], UNIT_TYPE_DEAD)
In the periodic loop you could do not (GetUnitTypeId(u) == 0 or IsUnitType(u, UNIT_TYPE_DEAD))

 

[BPower]

updated
updated: Did everything Maker suggested, except:

Add a function where you can set hometown per player or even per unit

Good idea, but at the moment i see more cons than pros adding such a function.
For example: if you TriggerRegisterEnterRegion dynamically you also have to deregister leakless.(removing the region, destroying (local) triggers??).

I'll reconsider this at a subsequent date.

 

[BPower]

Rewrote the whole code. Now requires UnitIndexer.
Its now shorter, better organized and slightly faster.
Also it doesn't required TimerTools anymore (That's a pro).
It uses Table instead of hashtabel hash = InitHashtable()

I considered adding such a function, but in the end I didn't(, yet).

Add a function where you can set hometown per player or even per unit

 

[BPower]

UPDATE: Fixed an error in version 2.0.0.0 when using ESC ( PLAYER_END_CINEMATIC).

 

[chobibo]

Hey, this looks cool. Thanks for sharing dude.

 

[BPower]

I'm planning a huge update on my TownPortaSystem for the next few days . The final update is still in progress. At the moment it looks like this:

For Esc: Each Player has it's own Portal region, which can be changed ingame plus a Portal Dummy unit (it really does open a portal . Any allied player can use other players portal and will then port to the x/y coordinate of that portal (Note not your own, but the one you've just enetered). Portals only close if the owning player uses it or opens a new one.

For Ability ... I'll consider doing somthing similar.

I've also discovered a bug. When using a portal with a meele unit, It will stop if enemies come near --> order move.
Also range unit will use Autoattack since it is not detectable. I guess I will add Chargo Hold on the next update, but that means you can't attack out of porting, you have to move first and wait 0.03125 seconds.

Edit: ESC variant is finished and works, I'll upload it as soon as the ability version is written aswell.

 

[BPower]

Big update: The system now works in a completly different manner. I think the changes are pretty cool.

 

[Kam]

I'm sure it's in your documentation but I seem to be missing it. How may I change the save point? Specifically how could I do so in a melee setting?

 

[BPower]

Here you go:
Inside the demo map the unit is registered via custom script. Just in case you are only familiar with GUI.

/************************************************************************************
*
*    Functions
*
*       function TownPortalRegister takes unit u, real x, real y, real angle, real area returns nothing
*           -   Register an unit to the system with the following parameters:
*           -   x/y     --> coordinates of the portal
*           -   angle   --> Which angle should the portal have
*           -   area    --> Within this radius the unit cannot use teleport. Center is x/y
*
*       function TownPortalShiftInfo takes unit u, real x, real y, real angle, real area returns nothing
*           -   Shift the information of an already registered unit, uses the same parameters as TownPortalRegister
*
*       function TownPortalUnregister takes unit u returns nothing
*           -   Unregister an already registered unit and clears all corresponding members
*
************************************************************************************
*
*   struct TownPortal extends array
*
*       Description
*       -----------------------
*
*           NA
*
*       Methods
*       -----------------------
*
*           static method register takes unit u, real x, real y, real angle, real area returns nothing  
*               -   Register an unit to the system with the following parameters:
*               -   x/y     --> coordinates of the portal
*               -   angle   --> Which angle should the portal have
*               -   area    --> Within this range the unit cannot use teleport. Center is x/y  
*
*           static method shiftInfo takes unit u, real x, real y, real angle, real area returns nothing
*               -   Shift the information of an already registered unit, uses the same parameters as TownPortalRegister
*
*           static method unregister takes unit u returns nothing
*               -   Unregister an already registered unit and clears all corresponding members
*
************************************************************************************/

In case you are using the old system with one save point for the map. There is no function to change it. I've updated the whole resource and it works now very different. Sry

 

[BPower]

Note: Don't use the ESC library, yet. Currently it leaks two handles (trigger and region) in case you re-assign the location or change the porting unit for a player. I'll fix it as soon as possible.

The Ability library is totally fine.

Edit: I fixed it, but I'll run some debug tests before uploading the new version, of the ESC library.

Update:

• minor changes in the code.
• made Alloc, ErrorMessage, SpellEffectEvent optional
• far better documentation for the Ability version

(Also I think the rating should be reconsidered, because now it is a really awesome resource. )

 

[InfernalTater]

This is pretty cool, nice job on it!

 

[Geshishouhu]

I like the idea of this spell and the progress bar looks awesome.
+Rep

 

[BPower]

Update:

UnitIndexing systems are no longer required.
Dummy is now optional.
System behaviour improved.
Documentation improved.
Code restructured.

The initial rating of 4/5 is utterly outdated, as TownPortal has become a completly different and more complex system since v.1.0

 

[NightKnight]

I liked the description of this spell

 

[nanotech]

Nice one!
Honestly, I can't rate any spell yet after 10 days.

 

[BPower]

I'm glad you like! Criticism, bug reports and suggestion for further updates are also very welcome.

 

[BPower]

I will do an update on Townportal soon. I have some new ideas.

Edit: Updating

 

[Kazeon]

//* Will fail on first play... I'm waiting for a good Sound library.

For alternative solution (while waiting for that "good sound library"), you can preload the sound anytime after the map initialization (loading screen). As example use 0 second timer to call the preload function. Just like what I do in my spell:

        // Needed so that the sound effect will appear since the first cast
        static method preloadSound takes nothing returns nothing
            
            local sound s = CreateSound(SOUND_PATH, false, false, true, 12700, 12700, "")
            
            call StartSound(s)
            call StopSound(s, true, false)
            call ReleaseTimer(GetExpiredTimer())
            set s = null
            
        endmethod
        
        static method init takes nothing returns nothing
            
            ...
            call TimerStart(NewTimer(), 0, false,  function thistype.preloadSound)
            
            ...
            
        endmethod

 

[BPower]

I will update it.

Edit: It seems not to work for me. Maybe because those sounds are 3D sounds.
sound handles are strange ....

 

[Kazeon]

I will update it.

Edit: It seems not to work for me. Maybe because those sounds are 3D sounds.
sound handles are strange ....

That's very weird. I did it all the time and always work, either 3D or not. You said it yourself that the sound doesn't appear only for the first time. The function I wrote before actually just plays the sound and stop it right away (to play the sound for the first time).

Or perhaps try to use exactly the same sound properties to preload the sound.

        static method preloadSound takes string path returns nothing
            
            local sound s = CreateSound(path, false, true, true, 10, 10, "CombatSoundsEAX")
            
            call SetSoundChannel(s, 5)
            call SetSoundVolume(s, 127)
            call SetSoundDistances(s, 600, 10000)
            call SetSoundDistanceCutoff(s, 3000)
            call SetSoundConeAngles(s, 0, 0, 127)
            call SetSoundConeOrientation(s, 0, 0, 0)
            call AttachSoundToUnit(s, source)
            call StartSound(s)
            call StopSound(s, true, false)
            call ReleaseTimer(GetExpiredTimer())
            set s = null
            
        endmethod

I just can't accept this, it's way too weird and often become so frustrating to solve.
Once I had a very strange sound problem. I use a local sound variable and the sound wouldn't play at all. Then I changed it a global sound variable, then it worked fine. I swear I wasn't drunk. I mean, where's the sense of logic there? And I spent hours to fix that silly error. We really need to solve these problems before somebody hangs himself out of frustration. I almost became the first one that time.

 

[Kam]

I just can't accept this, it's way too weird and often become so frustrating to solve.
Once I had a very strange sound problem. I use a local sound variable and the sound wouldn't play at all. Then I changed it a global sound variable, then it worked fine. I swear I wasn't drunk. I mean, where's the sense of logic there? And I spent hours to fix that silly error. We really need to solve these problems before somebody hangs himself out of frustration. I almost became the first one that time.

I've had that happen before with sounds applied via triggers. I solved it by checking the Options box for "Stop when out of range" in the sound editor. It seems numerous sound files do not have that set by default.