Name your file following the convention of EffectName.sp and place it in the respective category of Meta, Player, or Game.
Meta is only for meta effects.
Player is for effects that directly affect the player.
Game is for effects that manipulates the environment, such as weather, image overlays, color corrections, etc.
These are only used for organisation purposes.
The public keyword must be used as the functions are remotely called via GetFunctionByName and Call_StartFunction.
/*
Any instances of 'EffectName' should be replaced with an appropriate name for you effect.
As long as all the naming conventions are strictly followed below, they will all be run automatically, without the need to be called elsewhere in the plugin.
*/
g_EffectName = false;
public void Chaos_EffectName(EffectData effect){
effect.Title = "Effect Name";
effect.Duration = 30;
/* Optional configs: */
effect.HasNoDuration = true; // Use this if your effect isn't timed, eg. spawning models
effect.AddAlias("SearchTerm"); // Allow the effect to show up when using "!effect searchterm"
effect.IncompatibleWith("Chaos_DifferentEffectName"); // Prevents the effect running the same time with other effects
effect.AddFlag("NoMovement"); // Prevents this effect running at the same time with other effects containing the same flag.
// Prevents the plugin from announcing the effect name, and does not get added to the effect list (HUD).
// Useful if you want to delay the Announcement -> use AnnounceChaos() manually within the _START function
effect.HasCustomAnnouncement = true;
effect.IsMetaEffect = true; // Marks the effect as a meta effect (rarely run)
/*
Since this runs only once during OnPluginStart, you can also use this to Hook Events.
eg.
HookEvent("bullet_impact", Chaos_EffectName_Event_BulletImpact);
*/
}
public void Chaos_EffectName_OnMapStart(){
/*
Runs on every map start, use this to precache textures, etc.
eg.
PrecacheDecal("path/to/texture.vmt", true);
AddFileToDownloadsTable("materials/path/to/texture.vmt");
*/
}
public void Chaos_EffectName_START(){
g_EffectName = true;
// Runs when the effect is selected and announced
}
public void Chaos_EffectName_RESET(int ResetType){
// Runs when the effect is reset, also runs when the round ends/map changes/plugin reloaded
// Use HasTimerEnded to strictly check if the effect has expired/used up its duration.
if(ResetType & RESET_EXPIRED){
// Teleport players, set their movement speed, switch to a different weapon, etc.
// Avoid resetting things outside of this function that would be reset by default on round change.
}
g_EffectName = false;
}
public void Chaos_EffectName_OnPlayerSpawn(int client){
/* Re-apply the effect here. This function is called when a player spawns AND when the effect is active. */
}
public bool Chaos_EffectName_Conditions(bool EffectRunRandomly){
/*
Check conditions to deterimne whether the effect can be run or not. This is the last final check before the effect is about to run. If returned false, another effect will be selected.
EffectRunRandomly is false when the effect is manually called from the menu.
The EffectRunRandomly should be used for checks that won't break the server, eg:
*/
if(EffectRunRandomly){
// Prevent effect from running if round time is less than x seconds
}
// Prevent effect from running if it may cause serious issues (material/models missing, missing map data etc.)
// if you're using map spawns to teleport to, you may want to use the following:
if(!ValidMapPoints()) return false;
/* Available checks: */
ValidMapPoints(); // Returns true if spawn points are available in the map to use
IsHostageMap(); // Returns true if a hostage is found on the map
ValidBombSpawns(); // Returns true if custom bomb spawns have been saved to use
// You can run additional custom checks such restricting your effects from running on certain maps that aren't compatible
if(StrEqual(g_sCurrentMapName, "de_dust2")){
return false;
}
return true;
}
// Additional functions: (Run automatically if the correct naming convention is used). This is done to allow all components of an effect to be localised to one file (EffectName.sp).
public void Chaos_EffectName_OnEntityCreated(int ent, const char[] classname);
public void Chaos_EffectName_OnEntityDestroyed(int ent);
public Action Chaos_EffectName_OnPlayerRunCmd(int client, int &buttons, int &impulse, float vel[3], float angles[3], int &weapon, int &iSubType, int &cmdnum, int &tickcount, int &seed, int mouse[2]);
public void Chaos_EffectName_OnGameFrame();
// + more to be configured if required, in order to avoid editing other files for your effect.Add the following to addons/sourcemod/translations/chaos.phrases.txt.
"Chaos_EffectName"
{
"en" "Effect Name"
}If translations are missing on the server, the effect.Title will be used by the plugin
Include your EffectName.sp inside of addons/sourcemod/scripting/Effects/EffectsList.sp
#include "Effects/Player/EffectName.sp"Ensure that the contents of EffectsList.sp is sorted alphabetically in descending order.
Add the name of your function to addons/sourcemod/scripting/Effects/EffectNames.sp. This is used to call your function and add your effect.
"Chaos_EffectName",This should match the name of your function that sets up your effect:
public void Chaos_EffectName(EffectData effect)