add_coupling
Stable function · Editing
Tier: stable · Kind: function · Topic: Editing
| Julia | TypeScript | Python | Rust | Go |
|---|---|---|---|---|
add_coupling | addCoupling | add_coupling, add_coupling_to_file | add_coupling | AddCoupling |
Note: spelling differs from the §2 rule: python=add_coupling_to_file (expected add_coupling); multiple spellings exported by: python
Julia
add_coupling(file::EsmFile, entry::CouplingEntry)
add_coupling(file::EsmFile, entry::CouplingEntry) -> EsmFile
Add a coupling entry to an ESM file.
TypeScript
function addCoupling(file: EsmFile, entry: CouplingEntry): EsmFile
Add a coupling entry to an ESM file
Parameters
file— ESM file to add coupling toentry— Coupling entry to add
Returns
New ESM file with coupling added
Python
Exported as add_coupling and add_coupling_to_file. Both names refer to the same operation.
add_coupling
add_coupling(esm_file: EsmFile, coupling: CouplingEntry, validate_after_edit: bool = True) -> EditResult
Add a coupling entry to an ESM file.
add_coupling_to_file
add_coupling_to_file(esm_file: EsmFile, coupling: CouplingEntry, validate_after_edit: bool = True) -> EditResult
Deprecated alias for add_coupling
. Add a coupling entry to an ESM file.
Rust
pub fn add_coupling(esm_file: &EsmFile, coupling: CouplingEntry) -> EditResult<EsmFile>
Add a coupling entry to an ESM file
Arguments
esm_file- The ESM file to modifycoupling- The coupling entry to add
Returns
EditResult<EsmFile>- New ESM file with the added coupling entry