OpenSimulator - User contributions [en]

Coding standards

2026-03-19T18:51:08Z

Ubit: /* Formatting */

__NOTOC__
{{Quicklinks|Coding_standards}}
 
== Guidelines ==

Current maximum C# version to use is 12.

Dotnet version is 8.

We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx]. Corrections to existing files to follow these standards are welcome.

=== Formatting ===

* We put curly brackets on separate lines and use 4 space tabs.
* Tab themselves must be be 4 spaces, not actual hard tabs.
* Use c# object type instead of Dotnet support class name, i.e. string, object, double etc. instead of String, Object, Double .

=== Naming ===

* We use full words to name things.
* Aim for assosiative naming so that the logic is clear without explicit comments.

=== Classes ===

Unless the classes are very trivial, there should be one class per file.

<pre>
public class SimpleExample
{

}
</pre>

=== Methods ===

Method names have all their words capitalized (as opposed to Java, which culturally uses camelCase).

<pre>
public class SimpleExample
{
public void ExampleMethod(int exampleAttribute)
{
string exampleVariable = "test value";
}
}
</pre>

=== Fields ===

Fields should be always initialized when declared. Member fields start with m_ and continue in camelCase:

<pre>
public class SimpleExample
{
private long m_exampleMemberField = 0;
private static double m_exampleStaticMemberField = 2;

public void ExampleMethod(int exampleAttribute)
{
string exampleVariable = "test value";
}
}
</pre>

=== Warnings ===

* Please keep the code warning free, using #pragma only if absolutely necessary. For instance

#pragma warning disable 0612
ASSET_TYPE_TO_EXTENSION[(sbyte)AssetType.Script] = "_script.txt"; // Not sure if we'll ever see this
#pragma warning restore 0612

=== Logging ===

Each class, when needed, should have their own logger which is declared private and is not inherited:

<pre>
public class SimpleExample
{
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
}
</pre>

=== use of var and new()===

Only use var in a variable declaration when the type of the variable is clear on the right side
Only use new(..) in a variable declaration when the type of the variable is clear on the left side

<pre>
var a = new List<string>();
//or
List<string> b = new(); // preferred

var c = mything(); // not ok. we cant see the type without looking for mything details.
</pre>

if fact just DO NOT use var

[[Category:Standards]]

Coding standards

2026-03-19T18:47:13Z

Ubit: /* use of var and new() */

__NOTOC__
{{Quicklinks|Coding_standards}}
 
== Guidelines ==

Current maximum C# version to use is 12.

Dotnet version is 8.

We follow standard C# coding guidelines unless otherwise stated: [http://msdn.microsoft.com/en-us/library/czefa0ke.aspx]. Corrections to existing files to follow these standards are welcome.

=== Formatting ===

* We put curly brackets on separate lines and use 4 space tabs.
* Tab themselves should be spaces, not actual hard tabs.
* Use string instead of String when refering to the System.String type.

=== Naming ===

* We use full words to name things.
* Aim for assosiative naming so that the logic is clear without explicit comments.

=== Classes ===

Unless the classes are very trivial, there should be one class per file.

<pre>
public class SimpleExample
{

}
</pre>

=== Methods ===

Method names have all their words capitalized (as opposed to Java, which culturally uses camelCase).

<pre>
public class SimpleExample
{
public void ExampleMethod(int exampleAttribute)
{
string exampleVariable = "test value";
}
}
</pre>

=== Fields ===

Fields should be always initialized when declared. Member fields start with m_ and continue in camelCase:

<pre>
public class SimpleExample
{
private long m_exampleMemberField = 0;
private static double m_exampleStaticMemberField = 2;

public void ExampleMethod(int exampleAttribute)
{
string exampleVariable = "test value";
}
}
</pre>

=== Warnings ===

* Please keep the code warning free, using #pragma only if absolutely necessary. For instance

#pragma warning disable 0612
ASSET_TYPE_TO_EXTENSION[(sbyte)AssetType.Script] = "_script.txt"; // Not sure if we'll ever see this
#pragma warning restore 0612

=== Logging ===

Each class, when needed, should have their own logger which is declared private and is not inherited:

<pre>
public class SimpleExample
{
private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
}
</pre>

=== use of var and new()===

Only use var in a variable declaration when the type of the variable is clear on the right side
Only use new(..) in a variable declaration when the type of the variable is clear on the left side

<pre>
var a = new List<string>();
//or
List<string> b = new(); // preferred

var c = mything(); // not ok. we cant see the type without looking for mything details.
</pre>

if fact just DO NOT use var

[[Category:Standards]]

2025-05-06T00:59:09Z

Ubit:

{{osslfunc
|function_syntax= osSetTerrainTextures(list textureKeys, integer types)
|description=
Opensimulator regions store two sets of textures or materials:
* a set of texture keys for legacy viewers and map
* a set of keys of textures or pbr materials for new viewers. 
so this function sets terrain:
* textures for legacy viewers and map if types == 0 or 2
* textures for new viewers if types == 1 or 2
* PBR materials for new viewers if types == 1 
The list textureKeys must contain keys or names of 4 textures or 4 pbr materials. They must be of the same type due to viewers restrictions. 
This define the textures or materials the viewer will use to draw the terrain texture 
They are ordered from low to high terrain height level, as on viewers World -> Region Details -> Terrain menu tab. 
If a entry is a name, then the material or texture must be present on the prim inventory. 
If a entry is a empty string, then that level is unchanged.
|threat_level=High
|permissions=ESTATE_MANAGER,ESTATE_OWNER
|delay=0
|<source>
</source>
|additional_info=This function was added in 0.9.3.1
}}