OpenMod Docs OpenMod Docs
OpenMod Docs OpenMod Docs
OpenMod .NET Plugin Framework.

Interface IWorldTransform

Namespace: OpenMod.Extensions.Games.Abstractions.Transforms
Assembly: OpenMod.Extensions.Games.Abstractions.dll
Syntax
public interface IWorldTransform : IReadOnlyCollection<IWorldTransform>

Properties

| Improve this Doc View Source

ChildTransforms

Gets the child transforms of this transform.

Declaration
IReadOnlyCollection<IWorldTransform> ChildTransforms { get; }
Property Value
Type Description
IReadOnlyCollection<IWorldTransform>
| Improve this Doc View Source

ParentTransform

Gets the parent transform of this transform.

Declaration
IWorldTransform ParentTransform { get; }
Property Value
Type Description
IWorldTransform
| Improve this Doc View Source

Position

Gets the position of the transform.

Declaration
Vector3 Position { get; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

Rotation

Gets the rotation of the transform.

Declaration
Quaternion Rotation { get; }
Property Value
Type Description
Quaternion
| Improve this Doc View Source

TransformName

Gets the name of the transform.

Declaration
string? TransformName { get; }
Property Value
Type Description
System.Nullable<System.String>
| Improve this Doc View Source

Velocity

Gets the velocity of the transform.

Declaration
Vector3 Velocity { get; }
Property Value
Type Description
Vector3

Methods

| Improve this Doc View Source

DestroyAsync()

Destorys the transform.

Declaration
Task DestroyAsync()
Returns
Type Description
Task
| Improve this Doc View Source

SetPositionAsync(Vector3)

Sets the position of the transform.

Declaration
Task<bool> SetPositionAsync(Vector3 position)
Parameters
Type Name Description
Vector3 position

The position to set to.

Returns
Type Description
Task<System.Boolean>

True if successful; otherwise, false.

| Improve this Doc View Source

SetRotationAsync(Quaternion)

Sets the rotation of the transform.

Declaration
Task<bool> SetRotationAsync(Quaternion rotation)
Parameters
Type Name Description
Quaternion rotation

The rotation to set to.

Returns
Type Description
Task<System.Boolean>

True if successful; otherwise, false.

| Improve this Doc View Source

SetVelocityAsync(Vector3)

Sets the velocity of the transform.

Declaration
Task<bool> SetVelocityAsync(Vector3 velocity)
Parameters
Type Name Description
Vector3 velocity

The velocity to set.

Returns
Type Description
Task<System.Boolean>

True if successful; otherwise, false.

Extension Methods

DisposeHelper.DisposeSyncOrAsync(Object)