Skip to content

Commit

Permalink
Update FUNCS_EVENTS.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Fernando-A-Rocha committed Feb 7, 2023
1 parent 618be0e commit 595009b
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions .github/docs/newmodels/FUNCS_EVENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ All server-side only exported functions are explained here.

---

### **addExternalMod_IDFilenames**(`modInfo`)
### **addExternalMod_IDFilenames**(`modInfo`, `fromResourceName`)

Adds a new external mod which uses ID file names (e.g. "models/50001.txd") to the mod list.

Expand All @@ -161,6 +161,10 @@ Adds a new external mod which uses ID file names (e.g. "models/50001.txd") to th
- (optional) `disableAutoFree`: A boolean (e.g. false)
- (optional) `lodDistance`: A number (e.g. 300)

**Optional arguments**:

- `fromResourceName`: A string (e.g. "myResource") - where the mod files are located

**Returns**:

- a `boolean` which is **true** if the mod was added successfully [**OR**] **false** if not
Expand Down Expand Up @@ -191,7 +195,7 @@ Adds a list of new external mods which use ID file names to the mod list. See th

---

### **addExternalMod_CustomFilenames**(`modInfo`)
### **addExternalMod_CustomFilenames**(`modInfo`, `fromResourceName`)

Adds a new external mod which uses custom file names (e.g. "models/my_custom_object.dff") to the mod list.

Expand All @@ -210,6 +214,10 @@ Adds a new external mod which uses custom file names (e.g. "models/my_custom_obj
- (optional) `disableAutoFree`: A boolean (e.g. false)
- (optional) `lodDistance`: A number (e.g. 300)

**Optional arguments**:

- `fromResourceName`: A string (e.g. "myResource") - where the mod files are located

**Returns**:

- a `boolean` which is **true** if the mod was added successfully [**OR**] **false** if not
Expand Down

0 comments on commit 595009b

Please sign in to comment.