fallout2sfall/sfall
0
0
Fork 0
mirror of https://github.com/sfall-team/sfall.git synced 2026-07-27 16:52:34 -07:00
Code Issues Packages Projects Releases Wiki Activity

Minor edits to error msg for some script functions

Browse Source 
Edits to function notes.
This commit is contained in:
NovaRain
2023-07-11 11:19:29 +08:00
parent a2ea1910f5
commit b94993d756
4 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/sfall function notes.md
+31 -31
View File
@@ -249,27 +249,27 @@ FUNCTION REFERENCE
**Some additional `reg_anim_*` functions were introduced. They all work in the same convention as vanilla functions and use the same underlying code.**
##### `void reg_anim_destroy(object)`
##### `void reg_anim_destroy(object obj)`
- Given object is destroyed at the end of current animation set.
-----
##### `void reg_anim_animate_and_hide(object, animID, delay)`
##### `void reg_anim_animate_and_hide(object obj, int animID, int delay)`
- Exactly like `reg_anim_animate` but the object will automatically disappear after the last animation frame (but not destroyed).
-----
##### `void reg_anim_light(object, light, delay)`
##### `void reg_anim_light(object obj, int light, int delay)`
- Change light of any object. light argument is a light radius (0-8), but you can use highest 2 bytes to pass light intensity as well (example: `0xFFFF0008` - intensity 65535 and radius 8). If highest 2 bytes are 0, intensity will not be changed. Intensity range is from 0 to 65535 (0xFFFF).
-----
##### `void reg_anim_change_fid(object, fid, delay)`
##### `void reg_anim_change_fid(object obj, int fid, int delay)`
- Should work like `art_change_fid_num` but in `reg_anim` sequence.
-----
##### `void reg_anim_take_out(object, holdFrameID, delay)`
##### `void reg_anim_take_out(object obj, holdFrameID, int delay)`
- Plays "take out weapon" animation for given **holdFrameID**. It is not required to have such weapon in critter's inventory.
-----
##### `void reg_anim_turn_towards(object, tile/target, delay)`
##### `void reg_anim_turn_towards(object obj, int/object tile/target, int delay)`
- Makes object change its direction to face given tile number or target object.
-----
@@ -281,15 +281,15 @@ FUNCTION REFERENCE
- Was made as a quick-and-dirty hack to enable dynamic changes to some explosion parameters for ranged attacks. All changed parameters are automatically reset to vanilla state after each attack action. Following macros are available in **sfall.h**:
-----
##### `void set_attack_explosion_pattern(x, y)`
##### `void set_attack_explosion_pattern(int x, int y)`
- Currently `y` is not used and `x` means: 1 - reduced explosion pattern (3 effects are spawned instead of 7), 0 - full pattern.
-----
##### `void set_attack_explosion_art(x, y)`
##### `void set_attack_explosion_art(int x, int y)`
- `y` is not used and `x` is a misc frame ID (last 3 bytes, without object type) to use for the next explosion.
-----
##### `void set_attack_explosion_radius(x)`
##### `void set_attack_explosion_radius(int x)`
- Changes radius at which explosion will hit secondary targets for the next attack (from the experiments it is limited to something around 8 by the engine)
-----
@@ -297,32 +297,32 @@ FUNCTION REFERENCE
- If you call this right before using a weapon with fire damage type (e.g. in `HOOK_AFTERHITROLL`), it will produce explosion effects (and radius damage) just like "explosion" type, but all targets will still receive fire damage.
-----
##### `void set_explosion_radius(grenade, rocket)`
##### `void set_explosion_radius(int grenade, int rocket)`
- Sets a permanent radius of the explosion for grenades and/or rockets. Passing 0 means not changing the corresponding radius.
- Changed radius will be reset each time the player reloads the game.
-----
##### `array get_explosion_damage(itemPid)`
##### `array get_explosion_damage(int itemPid)`
- Returns an array of the minimum and maximum damage of the explosive item.
-----
##### `void set_dynamite_damage(minDmg, maxDmg)`
##### `void set_dynamite_damage(int minDmg, int maxDmg)`
- Sets the minimum and maximum damage for Dynamite.
- Changed damage will be reset each time the player reloads the game.
-----
##### `void set_plastic_damage(minDmg, maxDmg)`
##### `void set_plastic_damage(int minDmg, int maxDmg)`
- Sets the minimum and maximum damage for Plastic Explosives.
- Changed damage will be reset each time the player reloads the game.
-----
##### `void set_explosion_max_targets(x)`
##### `void set_explosion_max_targets(int x)`
- Sets the maximum number of additional targets for an explosion, valid range: 1..6 (default is 6)
---
### Some utility/math functions are available:
##### `array string_split(string text, split)`
##### `array string_split(string text, string split)`
- Takes a string and a separator, searches the string for all instances of the separator, and returns a temp array filled with the pieces of the string split at each instance. If you give an empty string as the separator, the string is split into individual characters.
- You can use this to search for a substring in a string like this: `strlen(get_array(string_split(haystack, needle), 0))`
@@ -494,7 +494,7 @@ sfall_funcX metarule functions
----
#### spatial_radius
`int sfall_func1("spatial_radius", object object)`
`int sfall_func1("spatial_radius", object obj)`
- Returns radius of spatial script, associated with given dummy-object (returned by `create_spatial`)
----
@@ -545,17 +545,17 @@ sfall_funcX metarule functions
----
#### item_weight
`int sfall_func1("item_weight", object)`
`int sfall_func1("item_weight", object obj)`
- Gets the current weight of an object
----
#### get_outline
`int sfall_func1("get_outline", object)`
`int sfall_func1("get_outline", object obj)`
- Gets the current outline color for an object
----
#### set_outline
`void sfall_func2("set_outline", object, int color)`
`void sfall_func2("set_outline", object obj, int color)`
- Sets the outline color of an object (see `OUTLINE_*` constants in **sfall.h**)
- Can also set a custom color from the game palette by shifting the color index value left by 8 bits: `0xCC00` where `CC` is the palette index (**available since sfall 4.2.7/3.8.27**)
- Passing 0 will disable the outline
@@ -563,12 +563,12 @@ sfall_funcX metarule functions
----
#### get_flags
`int sfall_func1("get_flags", object)`
`int sfall_func1("get_flags", object obj)`
- Gets the current value of object flags (see **define_extra.h** for available flags)
-----
##### set_flags
`void sfall_func2("set_flags", object, int flags)`
`void sfall_func2("set_flags", object obj, int flags)`
- Sets the current flags of an object
- All flags are rewritten with given integer, so first get current flags with `get_flags` and use `bwor`/`bwand` to set/remove specific flag
@@ -584,7 +584,7 @@ sfall_funcX metarule functions
----
#### set_dude_obj
`object sfall_func1("set_dude_obj", critter)`
`object sfall_func1("set_dude_obj", int critter)`
- Take control of a given critter
- Passing 0 will reset control back to "real" dude
@@ -638,12 +638,12 @@ sfall_funcX metarule functions
----
#### lock_is_jammed
`int sfall_func1("lock_is_jammed", object)`
`int sfall_func1("lock_is_jammed", object obj)`
- Returns 1 if the lock (container or scenery) is currently jammed, 0 otherwise
----
#### unjam_lock
`void sfall_func1("unjam_lock", object)`
`void sfall_func1("unjam_lock", object obj)`
- Unjams a lock immediately without having to wait until the next day, or leave the map and then return after 24 hours
- __NOTE:__ does not work in `use_skill_on_p_proc` procedure
@@ -731,7 +731,7 @@ sfall_funcX metarule functions
----
#### get_current_inven_size
`int sfall_func1("get_current_inven_size", object)`
`int sfall_func1("get_current_inven_size", object obj)`
- Returns the current inventory size of the container or the critter
----
@@ -778,17 +778,17 @@ sfall_funcX metarule functions
----
#### get_object_data
`int sfall_func2("get_object_data", object, int offset)`
`int sfall_func2("get_object_data", object obj, int offset)`
- Returns the data at the specified offset of an object (see `OBJ_DATA_*` constants in **define_extra.h** for offsets)
----
#### set_object_data (object, offset, data)
`void sfall_func3("set_object_data", object, int offset, int data)`
#### set_object_data
`void sfall_func3("set_object_data", object obj, int offset, int data)`
- Sets the data at the specified offset of an object
----
#### get_object_ai_data
`int sfall_func2("get_object_ai_data", object, int aiParam)`
`int sfall_func2("get_object_ai_data", object obj, int aiParam)`
- Returns the setting value from the AI packet of an object (critter)
- Use `AI_CAP_*` constants from **define_extra.h** for the aiParam argument to get AI value
@@ -813,8 +813,8 @@ sfall_funcX metarule functions
----
#### set_unique_id
`int sfall_func1("set_unique_id", object)`\
`int sfall_func2("set_unique_id", object, int flag)`
`int sfall_func1("set_unique_id", object obj)`\
`int sfall_func2("set_unique_id", object obj, int flag)`
- Assigns a unique ID number to the object and returns it. If a unique ID number has already been assigned to an object, then ID number is returned without reassignment
- Items with unique IDs will not stack with other items of the same type in the inventory
- To just get the current ID number of an object, use `sfall_func2("get_object_data", object, OBJ_DATA_ID)`
sfall/Modules/Scripting/Handlers/Inventory.cpp
+1 -1
View File
@@ -96,7 +96,7 @@ void mf_critter_inven_obj2(OpcodeContext& ctx) {
ctx.setReturn(critter->invenSize);
break;
default:
ctx.printOpcodeError("%s() - invalid type.", ctx.getMetaruleName());
ctx.printOpcodeError("%s() - invalid type number.", ctx.getMetaruleName());
}
}
sfall/Modules/Scripting/Handlers/Objects.cpp
+2 -2
View File
@@ -539,7 +539,7 @@ void mf_get_object_ai_data(OpcodeContext& ctx) {
value = arrayId;
break;
default:
ctx.printOpcodeError("%s() - invalid value for AI argument.", ctx.getMetaruleName());
ctx.printOpcodeError("%s() - invalid aiParam number.", ctx.getMetaruleName());
}
ctx.setReturn(value);
}
@@ -557,7 +557,7 @@ void mf_set_drugs_data(OpcodeContext& ctx) {
result = Drugs::SetDrugAddictTimeOff(pid, val);
break;
default:
ctx.printOpcodeError("%s() - invalid value for type argument.", ctx.getMetaruleName());
ctx.printOpcodeError("%s() - invalid type number.", ctx.getMetaruleName());
return;
}
if (result) {
sfall/Modules/Scripting/Handlers/Worldmap.cpp
+3 -3
View File
@@ -209,13 +209,13 @@ void mf_set_rest_mode(OpcodeContext& ctx) {
void mf_set_rest_on_map(OpcodeContext& ctx) {
long mapId = ctx.arg(0).rawValue();
if (mapId < 0) {
ctx.printOpcodeError("%s() - invalid map number argument.", ctx.getMetaruleName());
ctx.printOpcodeError("%s() - invalid map number.", ctx.getMetaruleName());
ctx.setReturn(-1);
return;
}
long elev = ctx.arg(1).rawValue();
if (elev < -1 || elev > 2) {
ctx.printOpcodeError("%s() - invalid map elevation argument.", ctx.getMetaruleName());
ctx.printOpcodeError("%s() - invalid map elevation.", ctx.getMetaruleName());
ctx.setReturn(-1);
} else {
Worldmap::SetRestMapLevel(mapId, elev, ctx.arg(2).asBool());
@@ -226,7 +226,7 @@ void mf_get_rest_on_map(OpcodeContext& ctx) {
long result = -1;
long elev = ctx.arg(1).rawValue();
if (elev < 0 || elev > 2) {
ctx.printOpcodeError("%s() - invalid map elevation argument.", ctx.getMetaruleName());
ctx.printOpcodeError("%s() - invalid map elevation.", ctx.getMetaruleName());
} else {
result = Worldmap::GetRestMapLevel(elev, ctx.arg(0).rawValue());
}