Sansar Docs
Ask or search…
K

Default Attributes

Default Script, Value, and Name attributes.

DefaultScriptAttribute Class

Tags a class to be the default selection for this script project.

Syntax

[System.AttributeUsage(System.AttributeTargets.Class)] public class DefaultScriptAttribute : Attribute

Member Details

DefaultScriptAttribute Constructor

Documentation for this section has not yet been entered.

Syntax

public DefaultScriptAttribute ()

Remarks

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Class

Set a default value to show in the script properties field.

Syntax

[System.AttributeUsage(System.AttributeTargets.Field)] public class DefaultValueAttribute : Attribute

Member Details

DefaultValueAttribute Constructor

Set a default bool value to show in the script properties for this field. Without the DefaultValue attribute bools default to 'false'.

Syntax

public DefaultValueAttribute (bool value)
Parameters
value
The default boolvalue to show in script properties.

Remarks

Example

C# Example
[DefaultValue(true)]
public bool MyBool;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default byte value to show in the script properties for this field. Without the DefaultValue attribute bytes default to 0.

Syntax

public DefaultValueAttribute (byte value)
Parameters
value
The default byte value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(0x00C9)]
public byte MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default double value to show in the script properties for this field. Without the DefaultValue attribute doubles default to 0.0.

Syntax

public DefaultValueAttribute (double value)
Parameters
value
The default double value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(12.34)]
public double MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default double value to show in the script properties for this field. Without the DefaultValue attribute doubles default to 0.0.

Syntax

public DefaultValueAttribute (params double[] value)
Parameters
value
The default double value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(1.3, 2.4, 3.5)]
public Vector MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default short value to show in the script properties for this field. Without the DefaultValue attribute shorts default to 0.

Syntax

public DefaultValueAttribute (short value)
Parameters
value
The default short value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(123)]
public short MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default int value to show in the script properties for this field. Without the DefaultValue attribute ints default to 0.

Syntax

public DefaultValueAttribute (int value)
Parameters
value
The default int value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(123)]
public int MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default long value to show in the script properties for this field. Without the DefaultValue attribute longs default to 0.

Syntax

public DefaultValueAttribute (long value)
Parameters
value
The default long value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(123)]
public long MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default float value to show in the script properties for this field. Without the DefaultValue attribute floats default to 0.0.

Syntax

public DefaultValueAttribute (float value)
Parameters
value
The default float value to show in script properties.

Remarks

Example

C# Example
[DefaultValue(12.34)]
public float MyField;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0

DefaultValueAttribute Constructor

Set a default string value to show in the script properties for this field. Without the DefaultValue attribute strings default to an empty string.

Syntax

public DefaultValueAttribute (string value)
Parameters
value
The default value in string form for strings, quaternions and vector fields.

Remarks

Example

C# Example
[DefaultValue("Default Event")]
public string MyString = null;
[DefaultValue("&lt;1.2,3.4,5.6&gt;")] public Sansar.Vector MyVector; [DefaultValue("[1.2,3.4,5.6,7.8]")] public Sansar.Quaternion MyQuaternion; [DefaultValue("(1.2,3.4,5.6,7.8)")] public Sansar.Quaternion MyQuaternion; </pre></td></tr></tbody></table>
Requirements
Namespace: Sansar.Script
Assembly: Sansar.Script (in Sansar.Script.dll)
Assembly Versions: 1.0.0.0
Have more questions?

DisplayNameAttribute Class

Set the name to be shown in script properties for this field.

Syntax

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Field)] public class DisplayNameAttribute : Attribute

Member Details

DisplayNameAttribute Constructor

Set the name to be shown in script properties for this field.

Syntax

public DisplayNameAttribute (string name)
Parameters
name

Remarks

Example

C# Example
[DisplayName("")]
public float namedFloat;

Requirements

Namespace: Sansar.Script Assembly: Sansar.Script (in Sansar.Script.dll) Assembly Versions: 1.0.0.0