Class Primitive

A wrapper class for AdminToys.PrimitiveObjectToy.

Inheritance

System.Object

AdminToy

Primitive

Implements

IWorldSpace

IPosition

IRotation

IWrapper<AdminToys.PrimitiveObjectToy>

Inherited Members

AdminToy.AdminToyBase

AdminToy.ToyType

AdminToy.Player

AdminToy.Footprint

AdminToy.Position

AdminToy.Rotation

AdminToy.Scale

AdminToy.MovementSmoothing

AdminToy.IsStatic

AdminToy.Get(AdminToyBase)

AdminToy.Spawn()

AdminToy.UnSpawn()

AdminToy.Destroy()

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Exiled.API.Features.Toys

Assembly: Exiled.API.dll

Syntax

public class Primitive : AdminToy, IWorldSpace, IPosition, IRotation, IWrapper<PrimitiveObjectToy>

Properties

| Improve this Doc View Source

Base

Gets the base AdminToys.PrimitiveObjectToy.

Declaration

public PrimitiveObjectToy Base { get; }

Property Value

Type	Description
AdminToys.PrimitiveObjectToy

| Improve this Doc View Source

Collidable

Gets or sets a value indicating whether the primitive can be collided with.

Declaration

public bool Collidable { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Color

Gets or sets the material color of the primitive.

Declaration

public Color Color { get; set; }

Property Value

Type	Description
UnityEngine.Color

| Improve this Doc View Source

Type

Gets or sets the type of the primitive.

Declaration

public PrimitiveType Type { get; set; }

Property Value

Type	Description
UnityEngine.PrimitiveType

Methods

| Improve this Doc View Source

Create(PrimitiveSettings)

Creates a new Primitive.

Declaration

public static Primitive Create(PrimitiveSettings primitiveSettings)

Parameters

Type	Name	Description
PrimitiveSettings	primitiveSettings	The settings of the Primitive.

Returns

Type	Description
Primitive	The new Primitive.

| Improve this Doc View Source

Create(Nullable<Vector3>, Nullable<Vector3>, Nullable<Vector3>, Boolean)

Creates a new Primitive.

Declaration

public static Primitive Create(Vector3? position = null, Vector3? rotation = null, Vector3? scale = null, bool spawn = true)

Parameters

Type	Name	Description
System.Nullable<UnityEngine.Vector3>	position	The position of the Primitive.
System.Nullable<UnityEngine.Vector3>	rotation	The rotation of the Primitive.
System.Nullable<UnityEngine.Vector3>	scale	The scale of the Primitive.
System.Boolean	spawn	Whether or not the Primitive should be initially spawned.

Returns

Type	Description
Primitive	The new Primitive.

| Improve this Doc View Source

Create(Nullable<Vector3>, Nullable<Vector3>, Nullable<Vector3>, Boolean, Nullable<Color>)

Creates a new Primitive.

Declaration

public static Primitive Create(Vector3? position, Vector3? rotation, Vector3? scale, bool spawn, Color? color)

Parameters

Type	Name	Description
System.Nullable<UnityEngine.Vector3>	position	The position of the Primitive.
System.Nullable<UnityEngine.Vector3>	rotation	The rotation of the Primitive.
System.Nullable<UnityEngine.Vector3>	scale	The scale of the Primitive.
System.Boolean	spawn	Whether or not the Primitive should be initially spawned.
System.Nullable<UnityEngine.Color>	color	The color of the Primitive.

Returns

Type	Description
Primitive	The new Primitive.

| Improve this Doc View Source

Create(PrimitiveType, Nullable<Vector3>, Nullable<Vector3>, Nullable<Vector3>, Boolean)

Creates a new Primitive.

Declaration

public static Primitive Create(PrimitiveType primitiveType = PrimitiveType.Sphere, Vector3? position = null, Vector3? rotation = null, Vector3? scale = null, bool spawn = true)

Parameters

Type	Name	Description
UnityEngine.PrimitiveType	primitiveType	The type of primitive to spawn.
System.Nullable<UnityEngine.Vector3>	position	The position of the Primitive.
System.Nullable<UnityEngine.Vector3>	rotation	The rotation of the Primitive.
System.Nullable<UnityEngine.Vector3>	scale	The scale of the Primitive.
System.Boolean	spawn	Whether or not the Primitive should be initially spawned.

Returns

Type	Description
Primitive	The new Primitive.

| Improve this Doc View Source

Create(PrimitiveType, Nullable<Vector3>, Nullable<Vector3>, Nullable<Vector3>, Boolean, Nullable<Color>)

Creates a new Primitive.

Declaration

public static Primitive Create(PrimitiveType primitiveType, Vector3? position, Vector3? rotation, Vector3? scale, bool spawn, Color? color)

Parameters

Type	Name	Description
UnityEngine.PrimitiveType	primitiveType	The type of primitive to spawn.
System.Nullable<UnityEngine.Vector3>	position	The position of the Primitive.
System.Nullable<UnityEngine.Vector3>	rotation	The rotation of the Primitive.
System.Nullable<UnityEngine.Vector3>	scale	The scale of the Primitive.
System.Boolean	spawn	Whether or not the Primitive should be initially spawned.
System.Nullable<UnityEngine.Color>	color	The color of the Primitive.

Returns

Type	Description
Primitive	The new Primitive.

| Improve this Doc View Source

Get(PrimitiveObjectToy)

Gets the Primitive belonging to the AdminToys.PrimitiveObjectToy.

Declaration

public static Primitive Get(PrimitiveObjectToy primitiveObjectToy)

Parameters

Type	Name	Description
AdminToys.PrimitiveObjectToy	primitiveObjectToy	The AdminToys.PrimitiveObjectToy instance.

Returns

Type	Description
Primitive	The corresponding Primitive instance.

Implements

IWorldSpace

IPosition

IRotation

IWrapper<T>

Extension Methods

ReflectionExtensions.CopyProperties(Object, Object)