Class GameplayExecutableLibrary

Namespace

Ceres.Gameplay.Flow.Utilities

Assembly

Ceres.Gameplay.dll

Executable function library for Gameplay

[CeresGroup("Gameplay")]
public class GameplayExecutableLibrary : ExecutableFunctionLibrary

Inheritance

object

ExecutableFunctionLibrary

GameplayExecutableLibrary

Inherited Members

ExecutableFunctionLibrary.RegisterExecutableFunctionPtr<TLibrary>(string, int, void*)

ExecutableFunctionLibrary.RegisterExecutableFunctionFileInfo<TLibrary>(string, int, string, int)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GameplayExecutableLibrary()

public GameplayExecutableLibrary()

Methods

CollectExecutableFunctions()

Collect all static executable functions in this library

protected override void CollectExecutableFunctions()

Flow_CaptureRawScreenshot(Camera, Vector2, int, RenderTextureFormat)

Capture raw screenshot from renderer to a new Texture2D.

[ExecutableFunction]
[CeresLabel("Capture Raw Screenshot")]
[CeresGroup("Gameplay/Capture")]
public static Texture2D Flow_CaptureRawScreenshot(Camera camera, Vector2 size, int depthBuffer = 24, RenderTextureFormat renderTextureFormat = 0)

Parameters

camera Camera

size Vector2

depthBuffer int

renderTextureFormat RenderTextureFormat

Returns

Texture2D

Flow_CaptureRawScreenshotAsync(Camera, Vector2, int, RenderTextureFormat, int, Action<Texture2D>)

Capture raw screenshot from renderer to a new Texture2D in async.

[ExecutableFunction]
[CeresLabel("Capture Raw Screenshot")]
[CeresGroup("Gameplay/Capture")]
public static void Flow_CaptureRawScreenshotAsync(Camera camera, Vector2 size, int depthBuffer = 24, RenderTextureFormat renderTextureFormat = 0, int delayFrames = 1, Action<Texture2D> onComplete = null)

Parameters

camera Camera

size Vector2

depthBuffer int

renderTextureFormat RenderTextureFormat

delayFrames int

onComplete Action<Texture2D>

Flow_CaptureScreenShotFromScreen()

Capture screenshot to a new Texture2D. Need be called at the end of frame.

[ExecutableFunction]
[CeresLabel("Capture Screenshot")]
[CeresGroup("Gameplay/Capture")]
public static Texture2D Flow_CaptureScreenShotFromScreen()

Returns

Texture2D

Flow_CaptureScreenshotAsync(Action<Texture2D>)

Capture screenshot to a new Texture2D in async. Need be called at the end of frame.

[ExecutableFunction]
[CeresLabel("Capture Screenshot Async")]
[CeresGroup("Gameplay/Capture")]
public static void Flow_CaptureScreenshotAsync(Action<Texture2D> onComplete)

Parameters

onComplete Action<Texture2D>

Flow_FindLevel(string)

[ExecutableFunction]
[CeresLabel("Find Level from Name")]
[CeresGroup("Gameplay/Level")]
public static LevelReference Flow_FindLevel(string levelName)

Parameters

levelName string

Returns

LevelReference

Flow_FindLevelFromTag(string)

[ExecutableFunction]
[CeresLabel("Find Level from Tag")]
[CeresGroup("Gameplay/Level")]
public static LevelReference Flow_FindLevelFromTag(string tag)

Parameters

tag string

Returns

LevelReference

Flow_GetActor(ActorHandle)

[ExecutableFunction]
public static Actor Flow_GetActor(ActorHandle handle)

Parameters

handle ActorHandle

Returns

Actor

Flow_GetOrCreateSubsystem(SerializedType<SubsystemBase>)

[ExecutableFunction]
public static SubsystemBase Flow_GetOrCreateSubsystem(SerializedType<SubsystemBase> type)

Parameters

type SerializedType<SubsystemBase>

Returns

SubsystemBase

Flow_GetSubsystem(SerializedType<SubsystemBase>)

[ExecutableFunction]
public static SubsystemBase Flow_GetSubsystem(SerializedType<SubsystemBase> type)

Parameters

type SerializedType<SubsystemBase>

Returns

SubsystemBase

Flow_LoadLevel(LevelReference)

[ExecutableFunction]
[CeresLabel("Load Level")]
[CeresGroup("Gameplay/Level")]
public static void Flow_LoadLevel(LevelReference levelReference)

Parameters

levelReference LevelReference

Flow_LoadLevelFromName(string)

[ExecutableFunction]
[CeresLabel("Load Level from Name")]
[CeresGroup("Gameplay/Level")]
public static void Flow_LoadLevelFromName(string levelName)

Parameters

levelName string

Flow_Play2DAudioClip(AudioClip, float)

[ExecutableFunction]
[CeresLabel("Play 2D AudioClip")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_Play2DAudioClip(AudioClip audioClip, float volume = 1)

Parameters

audioClip AudioClip

volume float

Flow_Play2DAudioClipFromAddress(string, float)

[ExecutableFunction]
[CeresLabel("Play 2D AudioClip from Address")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_Play2DAudioClipFromAddress(string audioClipAddress, float volume = 1)

Parameters

audioClipAddress string

volume float

Flow_Play3DAudioClip(AudioClip, Vector3, float, float, float)

[ExecutableFunction]
[CeresLabel("Play 3D AudioClip")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_Play3DAudioClip(AudioClip audioClip, Vector3 position, float volume = 1, float spatialBlend = 1, float minDistance = 10)

Parameters

audioClip AudioClip

position Vector3

volume float

spatialBlend float

minDistance float

Flow_Play3DAudioClipFromAddress(string, Vector3, float, float, float)

[ExecutableFunction]
[CeresLabel("Play 3D AudioClip from Address")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_Play3DAudioClipFromAddress(string audioClipAddress, Vector3 position, float volume = 1, float spatialBlend = 1, float minDistance = 10)

Parameters

audioClipAddress string

position Vector3

volume float

spatialBlend float

minDistance float

Flow_PlayParticleSystem(GameObject, Vector3, Quaternion, Transform, bool)

[ExecutableFunction]
[CeresLabel("Play ParticleSystem")]
[CeresGroup("Gameplay/FX")]
public static void Flow_PlayParticleSystem(GameObject prefab, Vector3 position, Quaternion rotation, Transform parent = null, bool useLocalPosition = false)

Parameters

prefab GameObject

position Vector3

rotation Quaternion

parent Transform

useLocalPosition bool

Flow_PlayParticleSystemFromAddress(string, Vector3, Quaternion, Transform, bool)

[ExecutableFunction]
[CeresLabel("Play ParticleSystem from Address")]
[CeresGroup("Gameplay/FX")]
public static void Flow_PlayParticleSystemFromAddress(string prefabAddress, Vector3 position, Quaternion rotation, Transform parent = null, bool useLocalPosition = false)

Parameters

prefabAddress string

position Vector3

rotation Quaternion

parent Transform

useLocalPosition bool

Flow_Schedule3DAudioClip(AudioClip, Vector3, float, float, float, float)

[ExecutableFunction]
[CeresLabel("Schedule 3D AudioClip")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_Schedule3DAudioClip(AudioClip audioClip, Vector3 position, float scheduleTime, float volume = 1, float spatialBlend = 1, float minDistance = 10)

Parameters

audioClip AudioClip

position Vector3

scheduleTime float

volume float

spatialBlend float

minDistance float

Flow_Schedule3DAudioClipFromAddress(string, Vector3, float, float, float, float)

[ExecutableFunction]
[CeresLabel("Schedule 3D AudioClip from Address")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_Schedule3DAudioClipFromAddress(string audioClipAddress, Vector3 position, float scheduleTime, float volume = 1, float spatialBlend = 1, float minDistance = 10)

Parameters

audioClipAddress string

position Vector3

scheduleTime float

volume float

spatialBlend float

minDistance float

Flow_StopAudioClip(string)

[ExecutableFunction]
[CeresLabel("Stop AudioClip from Address")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_StopAudioClip(string audioClipAddress)

Parameters

audioClipAddress string

Flow_StopAudioClip(AudioClip)

[ExecutableFunction]
[CeresLabel("Stop AudioClip")]
[CeresGroup("Gameplay/Audios")]
public static void Flow_StopAudioClip(AudioClip audioClip)

Parameters

audioClip AudioClip