Dear forum users! In compliance with the new European GDPR regulations, we'd just like to inform you that if you have an account, your email address is stored in our database. We do not share your information with third parties, and your email address and password are encrypted for security reasons.

New to the forum? Say hello in this topic! Also make sure to read the rules.

Document effect names in scriptAPI

Here you can find answered ScriptAPI topics.
Forum rules
By using the forum you agree to the following rules.
Post Reply
NearHuscarl
Superfighter
Superfighter
Posts: 89
Joined: Thu Feb 07, 2019 4:36 am

Document effect names in scriptAPI

Post by NearHuscarl » Fri Mar 22, 2019 7:03 am

The only effect name that is documented right now is "CFTXT". There are some other cool effects like "BLD" (blood) or "S_P" (spark) that would benefit modders if documented properly. The old thread about effect names is over a year old
0 x
Image

User avatar
JakSparro98
Superfighter
Superfighter
Posts: 530
Joined: Fri Jul 15, 2016 7:56 pm
Started SFD: PreAlpha 1.0.5
Location: Rome, Italy
Gender:
Age: 22

Post by JakSparro98 » Fri Mar 22, 2019 9:46 pm

@NearHuscarl
The effects list got slight changes from his previous appearance in the post you mentioned, this is the current list of effects you can use as parameter:
Image
some of the effects need to be handled by using extra parameters (MZLED is one of them).
4 x

NearHuscarl
Superfighter
Superfighter
Posts: 89
Joined: Thu Feb 07, 2019 4:36 am

Post by NearHuscarl » Sat Mar 23, 2019 8:27 pm

I know how to get the effect names. But the devs should themselves document the effects and the params required on some other effects. Some effects I cannot use like "HIT" or "PWT", I assume because of the missing undocumented params.

Here are some of the effects that not working (commented)
https://gist.github.com/NearHuscarl/374 ... 9321fcfa38
0 x
Image

User avatar
JakSparro98
Superfighter
Superfighter
Posts: 530
Joined: Fri Jul 15, 2016 7:56 pm
Started SFD: PreAlpha 1.0.5
Location: Rome, Italy
Gender:
Age: 22

Post by JakSparro98 » Sun Mar 31, 2019 5:39 pm

NearHuscarl wrote:
Sat Mar 23, 2019 8:27 pm
I know how to get the effect names. But the devs should themselves document the effects and the params required on some other effects. Some effects I cannot use like "HIT" or "PWT", I assume because of the missing undocumented params.

Here are some of the effects that not working (commented)
https://gist.github.com/NearHuscarl/374 ... 9321fcfa38
Refering to the "not working" section from the GitHub link

I assume that PWT is just a sub-part of CFTXT so I don't see why we should use it.

HIT, G_P and PPR_D they simply do not exist (you can notice in the console that HIT is also invoked by some game events, like when a player uses melee against a tile).

TR_SPR is used to spawn a trail of a specified effect, the usage is:
Game.PlayEffect("TR_SPR",Vector2.Zero,<holder>,<effect name>,<duration>);

holder is int
it's the uniqueID of the object the trail needs to track.

effect name is String
it can be any of the effects that does not need extra params (e.g TR_F).

duration is float
if duration is set to 0 it will last until the object linear velocity is 0 for some time, otherwise it will last the given number of seconds or until the object stops moving.
1 x

Juansero29
Fighter
Fighter
Posts: 42
Joined: Sun Jun 12, 2016 1:07 am
Title: Superfighter
SFD Account: Juansero29
SFD Alias: Juansero29
Started SFD: Pre-Alpha 1.0.5
Location: France
Gender:
Age: 22
Contact:

Post by Juansero29 » Fri Jan 08, 2021 10:56 am

Is this still undocumented? Seems like a basic thing to have.
0 x

Code: Select all

boom() {
  echo "BOOM!";			
}
BOOM!
----------------------------------------
Setting the world free since 1998
----------------------------------------

Post Reply