-
Notifications
You must be signed in to change notification settings - Fork 0
Trigger API Reference
BlackTower edited this page Aug 15, 2022
·
83 revisions
Table of Contents
- [DCEI Functions](#dcei-functions)
* [General](#general)
* [Log](#log)
* [Player](#player)
* [Multiplayer](#multiplayer)
* [Effect](#effect)
* [Unit](#unit)
* [Custom Data](#custom-data)
* [Behavior](#behavior)
* [Camera](#camera)
* [UI](#ui)
* [Input](#input)
* [Math](#math)
* [Map](#map)
* [Region](#region)
* [Upgrade](#upgrade)
* [Weapon](#weapon)
* [Ability](#ability)
* [Game](#game)
* [Tutorial](#tutorial)
* [Sound](#sound)
* [Service](#service)
* [Actor](#actor)
* [Terrain](#terrain)
* [Lighting](#lighting)
* [Custom UI](#custom-ui)
* [Save](#save)
* [Event](#event)
- [DCEI Trigger Events](#dcei-trigger-events)
* [Unit](#unit-1)
* [Timer](#timer)
* [Ability](#ability-1)
* [Input](#input-1)
* [Weapon](#weapon-1)
* [Behavior](#behavior-1)
* [Effect](#effect-1)
* [Player](#player-1)
* [Region](#region-1)
- [DCEI Trigger Variables](#dcei-trigger-variables)
* [Service](#service-1)
* [Unit](#unit-2)
* [Effect](#effect-2)
* [Ability](#ability-2)
* [Weapon](#weapon-2)
* [Behavior](#behavior-2)
* [Region](#region-2)
* [Input](#input-2)
* [Player](#player-2)
- [DCEI Trigger Types](#dcei-trigger-types)
|
These functions are available under the DCEI namespace, ex:
DCEI.LogMessage("Hello World!")General {General}
- string Texture(string texture)
- string Actor(string actor)
- string Unit(string unit)
- string Effect(string effect)
- string Behavior(string behavior)
- string Sound(string sound)
- string Tag(string tag)
- string Upgrade(string upgrade)
- string Font(string font)
- string Ability(string ability)
- void SetScreenSleep(bool flag)
- float GetGameTime()
- object GetValueFromDataPath(String[] paths)
- bool ValidateDataPath(String[] paths)
- void TriggerAddSimulationCommandEvent(int player, TypedCallback<string> callback)
- void SendSimulationCommand(string command)
- void TriggerAddPresentationCommandEvent(TypedCallback<string> callback)
- void SendPresentationCommand(int player, string command)
- void TriggerAddUpdateEvent(TypedCallback<float> callback)
- object CreateCustomIapProductData()
- object CreateCustomIapProduct(string productId, float price)
- object AddCustomIapProduct(CustomIapProductData data, CustomIapProduct product)
- float GetProtectedValue(string key)
- void ClearProtectedValue(string key)
- void SetProtectedValue(string key, float value)
- float ApplyModifier(BehaviorModifier modifier, float value)
- bool IsPointOnNavMesh(float x, float z)
- Float2 GetClosestPointOnNavMesh(float x, float z)
- void AddNavmeshCut(string prop_tag)
- void SetPropVisibility(string prop_tag, bool visibility)
- void EnableNavmeshCut(string prop_tag, bool enable)
- object GetCardDamageStats()
- void ResetCardDamageStats()
- void TriggerOnFocusChange(TypedCallback<bool> callback)
- void GarbageCollect()
- int GetLuaMemorySize()
- double GetLevelDataLoadingTime()
- void Wait(float time, bool useRealTime)
Log {Log}
Player {Player}
- int GetPlayerCount()
- int GetCurrentPlayerId()
- void SetPlayerTeamId(int playerId, int teamId)
- int GetPlayerTeamId(int playerId)
- void AddGold(int playerId, int amount)
- void SetGold(int playerId, int amount)
- int GetGold(int playerId)
- int GetUnitPlayerId(unit unit)
- int GetUnitTeamId(unit unit)
Multiplayer {Multiplayer}
Effect {Effect}
- string GetEffectType(string effectName)
- void CreateEffect(string effectName, unit target)
- void CreateEffectAtUnit(string effectName, unit target)
- void CreateEffect(string effectName, unit caster, unit source, unit target)
- void CreateEffectAtUnit(string effectName, unit target, unit caster, unit source)
- void CreateEffect(string effectName, unit caster, float x, float z)
- void CreateEffectAtPosition(string effectName, unit caster, float x, float z)
- double EvaluateEffectHookExpression(string name)
- object GetEffectHookFieldValue(String[] path)
- void SetEffectHookFieldValue(String[] path, object value)
Unit {Unit}
- unit CreateUnitFilter(UnitFilter filter)
- unit CreateUnit(int teamId, int playerId, string unitType, float x, float z, float dx, float dz)
- void KillUnit(unit unit)
- void RemoveUnit(unit unit)
- void RemoveUnitSync(unit unit)
- string GetUnitType(unit unit)
- double GetUnitTypeHealth(string unitType)
- string GetUnitDisplayName(unit unit)
- string GetUnitCategory(unit unit)
- void Move(unit unit, float x, float z)
- void Attack(unit unit, unit target)
- void DirectionalMove(unit target, float right, float up)
- void TurnUnitTowards(unit unit, float dx, float dz, float duration)
- float GetHealth(unit unit)
- void AddHealth(unit unit, float value)
- void SetHealth(unit unit, float value)
- void SetUnitOwner(unit unit, int playerId)
- void SetUnitTeamId(unit unit, int teamId)
- float GetMana(unit unit)
- void AddMana(unit unit, float value)
- void SetMana(unit unit, float value)
- Float2 GetUnitFacing2D(unit unit)
- float GetUnitBounty(unit unit)
- object GetUnitBehaviorList(unit unit)
- object GetUnitWeaponList(unit unit)
- object GetUnitAbilityList(unit unit)
- void ApplyTag(unit unit, string tagName, float duration, int stackCount)
- void RemoveTag(unit unit, string tagName, int stackCount)
- int GetUnitTagCount(unit unit, string tagName)
- object GetUnitTagList(unit unit)
- float GetUnitTotalDamage(unit unit)
- int GetUnitWaypointNodeIndex(unit unit)
- Float2 GetUnitPosition2D(unit unit)
- Float3 GetUnitPosition3D(unit unit)
- void SetUnitPosition2D(unit unit, float x, float z)
- void SetUnitPosition3D(unit unit, float x, float y, float z)
- void SetUnitPosition2DWithInterpolation(unit unit, float x, float z)
- void SetUnitPosition3DWithInterpolation(unit unit, float x, float y, float z)
- Float3 GetUnitRotationEuler(unit unit)
- void SetUnitRotationEuler(unit unit, float x, float y, float z)
- void MoveAttack(unit target, float x, float z)
- bool UnitExists(unit unit)
- bool UnitIsAlive(unit unit)
- bool UnitIsMoving(unit unit)
- void EnableUnitSelection(unit target)
- void EnableUnitSelectionSync(unit target)
- void DisableUnitSelection(unit target)
- void DisableUnitSelectionSync(unit target)
- float GetMaxShield(unit unit)
- void SetMaxShield(unit unit, float value)
- float GetShield(unit unit)
- void AddShield(unit unit, float value)
- void SetShield(unit unit, float value)
- float GetMaxHealth(unit unit)
- void SetMaxHealth(unit unit, float value)
- float GetMaxMana(unit unit)
- void SetMaxMana(unit unit, float value)
- void SetGoldBounty(unit unit, float amount)
- void ApplyWaypoint(unit unit, string waypointName, float waypointDispersal)
- void ApplyWaypoint(unit unit, WaypointOptions option)
- object GetWaypointPaths(bool includeRallyDisabledLanes)
- Float2 GetWaypointPathStartPosition(string name, float dispersal)
- void FollowUnit(unit unit, unit targetUnit, float offsetX, float offsetY, float distanceMax)
- void ClearFollowUnit(unit unit)
- void SelectUnit(unit unit)
- void SelectUnitSync(unit unit)
- void DeselectUnit(unit unit)
- void DeselectUnitSync(unit unit)
- unit FindUnit(string name)
- object FindUnitsByPlayerId(int playerId)
- object FindUnitsByTeamId(int teamId)
- object FindUnits(string name)
- unit FindUnitAtPosition(string name, float x, float z)
- bool IsUnitSelected(unit unit)
Custom Data {Custom-Data}
- object GetAllCustomData()
- object GetCustomDataByType(string typeName)
- object GetDefaultCustomDataByType(string typeName)
- object GetCustomDataByInstance(string typeName, string instanceName)
Behavior {Behavior}
- int GetUnitBehaviorStackCount(unit unit, string behaviorName)
- void ApplyBehaviorToSelf(unit unit, string behaviorName, int count)
- void ApplyBehaviorToUnit(unit caster, unit source, unit target, string behaviorName, int count)
- void RemoveBehavior(unit unit, string behaviorName, int count)
- void SetBehaviorDuration(unit unit, string behaviorName, float duration, bool extendDuration)
Camera {Camera}
- void SetEnabledCameraClamp(bool set)
- void SetEnabledCameraClampForPlayer(int player, bool set)
- void SetCameraFocusUnit(unit unit, float delay, float offsetX, float offsetY)
- void ClearCameraFocusUnit()
- void SetCameraFocusUnitForPlayer(int player, unit unit, float delay, float offsetX, float offsetY)
- void ClearCameraFocusUnitForPlayer(int player)
- void SetCameraFocus(float x, float y, float duration, bool useRealTime)
- void SetCameraFocusWithGameTime(float x, float y, float duration, bool useRealTime)
- void SetCameraFocusSmoothOvertimeForPlayer(int player, float x, float y, float duration, bool useRealTime)
- void SetCameraFocusSmoothOvertimeForPlayerWithGameTime(int player, float x, float y, float duration, bool useRealTime)
- void SetCameraDistance(float targetDistance, float duration, bool useRealTime)
- void SetCameraDistanceWithGameTime(float targetDistance, float duration, bool useRealTime)
- void SetCameraOrthographicSize(float targetSize, float duration, bool useRealTime)
- void SetCameraOrthographicSizeWithGameTime(float targetSize, float duration, bool useRealTime)
- void SetCameraMaxOrthographicSize(float targetSize)
- float GetCameraOrthographicSize()
- void SetCameraDistanceSmoothOvertimeForPlayer(int player, float targetDistance, float duration, bool useRealTime)
- void SetCameraDistanceSmoothOvertimeForPlayerWithGameTime(int player, float targetDistance, float duration, bool useRealTime)
- void SetCameraPitchSmoothOvertime(float targetPitchDeg, float duration, bool useRealTime)
- void SetCameraPitchSmoothOvertimeWithGameTime(float targetPitchDeg, float duration, bool useRealTime)
- void SetCameraPitchSmoothOvertimeForPlayer(int player, float targetPitchDeg, float duration, bool useRealTime)
- void SetCameraPitchSmoothOvertimeForPlayerWithGameTime(int player, float targetPitchDeg, float duration, bool useRealTime)
- void SetCameraYawSmoothOvertime(float targetYawDeg, float duration, bool useRealTime)
- void SetCameraYawSmoothOvertimeWithGameTime(float targetYawDeg, float duration, bool useRealTime)
- void SetCameraYawSmoothOvertimeForPlayer(int player, float targetYawDeg, float duration, bool useRealTime)
- void SetCameraYawSmoothOvertimeForPlayerWithGameTime(int player, float targetYawDeg, float duration, bool useRealTime)
- float GetCameraPitch()
- float GetCameraYaw()
- float GetCameraMaxDistance()
- float GetCameraMinDistance()
- Float2 GetCameraCurrentFocalPoint()
- Float2 GetCameraBoundsCenterPoint()
- float GetCameraBoundsHeight()
- float GetCameraBoundsWidth()
- float GetCameraTargetPointMaxDistance(float x, float y)
- void BlockCameraInput(bool set)
- void BlockCameraInputForPlayer(int player, bool set)
- void SetCameraVisibleAreaCenter(float x, float y)
- void SetCameraVisibleAreaWidth(float width)
- void SetCameraVisibleAreaLength(float length)
- void SetCameraVisibleAreaWidth(float width, bool updateMaxDistance)
- void SetCameraVisibleAreaLength(float length, bool updateMaxDistance)
- void SetCameraVisibleAreaCenterForPlayer(int player, float x, float y)
- void SetCameraVisibleAreaWidthForPlayer(int player, float width)
- void SetCameraVisibleAreaLengthForPlayer(int player, float length)
- void SetCameraVisibleAreaWidthForPlayer(int player, float width, bool updateMaxDistance)
- void SetCameraVisibleAreaLengthForPlayer(int player, float length, bool updateMaxDistance)
UI {UI}
- void ShowFeedbackMessage(string message)
- void ShowSystemUi(int typeId)
- void HideSystemUi(int typeId)
- void ShowAbilitiesUi(int id, unit unit)
- void ShowAbilitiesUiInSlot(int id, unit unit, int slotKey)
- void HideAbilitiesUi(int id, unit unit)
- void ShowAbilitiesUiForPlayer(int id, unit unit, int player)
- void HideAbilitiesUiForPlayer(int id, unit unit, int player)
- void ShowUnitStatusUi(int id, unit unit)
- void ShowUnitStatusUiForPlayer(int id, unit unit, int player)
- void SetUnitHealthBarUiScale(float scale)
- void SetGoldRewardTextScale(float scale)
- void ShowSpeechBubble(unit unit, int width, string content, string title)
- void ShowSpeechBubble(unit unit, int width, string content, string title, TextOptions options)
- void ShowUnitLabel(unit unit, string content)
- void ShowUnitLabel(unit unit, string content, UnitLabelOptions options)
- void HideUnitLabel(unit unit)
- void ShowFloatingText(float x, float y, float z, string content)
- void ShowFloatingText(Float3 pos, string content, float stayDuration, int animationType, float animationDuration, TextOptions options)
- void ShowFloatingTextWithOptions(Float3 pos, string content, float stayDuration, int animationType, float animationDuration, TextOptions options)
- void ShowFloatingTextAtUnit(unit unit, string content, float stayDuration, int animationType, float animationDuration, UnitLabelOptions options)
- void HideSpeechBubble(unit unit)
- void ShowUnitStatusUiInSlot(int id, unit unit, int slotKey)
- void SetHeroStatusUiVisibility(bool visible)
- void HideUnitStatusUi(int id, unit unit)
- void HideUnitStatusUiForPlayer(int id, unit unit, int player)
- void ShowMessageWithButtonText(string title, string content, string button, string image1, string image2, string image3)
- void ShowBigHeadMessage(string title, string message, string image)
- void ShowBigHeadMessage(string title, string message, string image, BigHeadMessageOptions options)
- void HideBigHeadMessage()
- void ShowObjectiveText(string text)
- void HideObjective()
- void ShowScreenMask(float alpha, ScreenBackgroundOptions options)
- void HideScreenMask()
- void ShowSlowMotionEffect()
- void HideSlowMotionEffect()
Input {Input}
- Float2 GetMousePosition2D()
- Float2 GetTouchPosition2D()
- Float2 GetSwipeScreenPosition()
- void HideJoystick(int joystickId)
- void ShowJoystick(int joystickId)
- void HideJoystickButton(int joystickButtonId)
- void ShowJoystickButton(int joystickButtonId)
- bool HasUserInput()
Math {Math}
- float Random(float min, float max)
- object CreateRandomGenerator(int seed)
- int NextRandomInteger(object generator, int max)
Map {Map}
- string GetLevelName()
- void PlayLevel(string path, string displayName, string data, object usedUnits)
- string GetPlayLevelData()
Region {Region}
- Region CreateRegion(float x, float z, float w, float h)
- void RemoveRegion(Region region)
- void RemoveRegionSync(Region region)
- Region FindRegion(string name)
- bool RegionExists(string name)
- string GetRegionName(Region region)
- Float2 GetRandomPointInRegion(Region region)
- Float2 GetCenterOfRegion(Region region)
- Float2 GetSizeOfRegion(Region region)
- bool CheckPointInRegion(Region region, float x, float z)
- object GetUnitsInRegion(Region region)
- void HideRegion(Region region)
- void RevealRegion(Region region)
- void MoveRegion(Region region, float x, float z)
Upgrade {Upgrade}
Weapon {Weapon}
- bool IsUnitWeaponEnabled(unit unit, string weaponName)
- BehaviorModifier GetUnitWeaponDamageModifier(unit unit, string weaponName)
- BehaviorModifier GetUnitWeaponCriticalChanceModifier(unit unit, string weaponName)
- BehaviorModifier GetUnitWeaponAttackSpeedModifier(unit unit, string weaponName)
- float GetUnitWeaponCriticalChance(string weaponName)
- float GetUnitWeaponAttackSpeed(string weaponName)
- void AddUnitWeapon(string unitType, string weaponName)
- void AddUnitWeaponSync(string unitType, string weaponName)
- void RemoveUnitWeapon(string unitType, string weaponName)
- void RemoveUnitWeaponSync(string unitType, string weaponName)
Ability {Ability}
- bool IsUnitAbilityEnabled(unit unit, string abilityName)
- float GetUnitAbilityCooldown(unit unit, string abilityName)
- AbilityCost GetAbilityCost(string abilityName)
- bool UnitHasAbility(unit unit, string abilityName)
- bool UnitTypeHasAbility(string unitType, string abilityName)
- int GetUnitAbilityCurrentCharge(unit unit, string abilityName)
- void SetUnitAbilityCooldown(unit unit, string abilityName, float seconds)
- void SetUnitAbilityMaxCooldown(unit unit, string abilityName, float seconds)
- void CastAbilityAtUnit(string abilityName, unit caster, unit target, bool immediate)
- void CastAbilityEffect(string abilityName, unit caster, unit target)
- void CancelAbilities(unit unit)
- void EnterTargetingMode(unit unit, string abilityName)
- void ExitTargetingMode()
- void AddUnitAbility(string unitType, string abilityName)
- void AddUnitAbilitySync(string unitType, string abilityName)
- void RemoveUnitAbility(string unitType, string abilityName)
- void RemoveUnitAbilitySync(string unitType, string abilityName)
- void CastAbilityAtPosition(string abilityName, unit caster, float x, float z, bool immediate)
- void CastAbilityEffectAtPosition(string abilityName, unit caster, float x, float z)
- void SetAbilityCurrentCharge(unit unit, string abilityName, int chargeCount, bool clampChargeCount)
Game {Game}
- void SetUpdateFrequency(float value)
- void ClearUpdateFrequency()
- float GetUpdateFrequency()
- void SetSpeedFactor(float value)
- float GetSpeedFactor()
- void SetVictory()
- void SetDefeat()
- void SetVictoryForPlayer(int player, string result)
- void SetDefeatForPlayer(int player, string result)
Tutorial {Tutorial}
- void ShowPositionHelper(float x, float z)
- void HidePositionHelper()
- void BlockGameWorld()
- void WhitelistUnit(unit u)
- void WhitelistPosition(float x, float z, float radius)
- void WhitelistUi(Transform ui)
- void UnblockGameWorld()
Sound {Sound}
- bool IsMusicEnabled()
- bool IsSoundEnabled()
- void PlayMusic(string name, bool smoothTransition)
- void SetMusicVolume(float volume)
- void PauseMusic()
- void ResumeMusic()
- void PlaySound(string nameOrPath, float volume)
- void PlaySoundForPlayer(string nameOrPath, int playerId, float volume)
Service {Service}
- string GetTranslationText(string key, Dictionary<string, object> parameters)
- bool IsAdsReady()
- void ShowAds(TypedCallback<bool> callback, bool fallbackToUnityAds)
- bool IsOnline()
- bool IsDev()
- void ShowSettings()
- void GetSaveDataHistory(int count, TypedCallback<object> callback)
- void ResetSavedMapDataByIndex(int index)
- void GetMail(TypedCallback<object> callback, bool forceFetch)
- void DeleteMail(int instanceId)
- int ScheduleNotification(string title, string body, double timeInSeconds)
- void CancelNotification(int id)
- object GetLastNotificationId()
- void ShowSendSMS(int platform)
- void RestartApplication()
- void OpenUrl(string url)
- void RequestAppStoreReview()
- void RequestInAppReview(Action successCallback, Action failureCallback)
- void GetServerTime(TypedCallback<int> callback)
- string GetUserId()
- string GetUserName()
- string GetUserTag()
- void GetLeaderBoardScore(string type, TypedCallback<object> callback)
- void GetLeaderBoardScoreList(string type, int skip, int limit, TypedCallback<object> callback)
- void GetLeaderBoardSurroundingUsers(string type, int count, TypedCallback<object> callback)
- void GetLeaderBoardUserScores(string type, List<string> uuids, TypedCallback<object> callback)
- void InitializeInAppPurchaseWithProductId(TypedCallback<string> purchaseCallback, List<string> productIds, TypedCallback<bool> initializationCallback)
- void InitializeInAppPurchaseWithProductData(TypedCallback<string> purchaseCallback, CustomIapProductData customIapProductData, TypedCallback<bool> initializationCallback)
- void PurchaseIapProduct(string productId)
- string GetIapProductLocalizedPrice(string productId)
- void PostLeaderBoardScore(string type, double score, string payload, int spentGems, TypedCallback<object> callback)
- void SetUserName(string name, TypedCallback<int> callback)
Actor {Actor}
- int CompileActorAction(string action)
- void SendActorAction(unit unit, int compiledActorActionId, string targetActorName)
Terrain {Terrain}
- void EnableRoute(string routeName, bool enable)
- Float2 GetMapSize()
- Float2 GetMapCenterPoint()
- int GetTerrainTypeAtPoint(float x, float z)
- float GetTerrainHeightAtPoint(float x, float z)
- void ChangePropLayerDisplay(string layerName, bool display)
- void LoadPropLayer(string layerName, bool initialDisplay)
- void UnloadPropLayer(string layerName)
- bool GetPropLayerLoadStatus(string layerName)
- Float3 GetTerrainChunkPosition(string chunkName)
- bool SetTerrainChunkPosition(string chunkName, Float3 pos)
- bool SetTerrainChunkPositionWithInterpolation(string chunkName, Float3 pos, float duration)
- int InstantiateTerrainChunk(string chunkName, Float3 pos)
- void DestroyTerrainChunkInstance(int instanceId)
- Float3 GetTerrainChunkInstancePosition(int instanceId)
- bool SetTerrainChunkInstancePosition(int instanceId, Float3 pos)
- bool SetTerrainChunkInstancePositionWithInterpolation(int instanceId, Float3 pos, float duration)
- int GetWeather()
- void SetWeather(int weatherStatus, float duration)
- int GetTimeOfTheDay()
- void SetTimeOfTheDay(int timeOfTheDay, float duration)
- ColorRGB GetCurrentLightColor()
- ColorRGB GetCurrentLightColorRGB()
- void SetOverrideLightColor(ColorRGB color, float duration)
- void SetOverrideLightColorRGB(ColorRGB color, float duration)
- void SetSkyboxColor(ColorRGB color, float duration)
- void SetSkyboxColorRGB(ColorRGB color, float duration)
- void ResetSkyboxColor(float duration)
- int AddLine(Float3 startPos, Float3 endPos, float width, ColorRGBA color, bool rectCap)
- int AddLineColorRGBA(Float3 startPos, Float3 endPos, float width, ColorRGBA color, bool rectCap)
- int AddLineWithSprite(Float3 startPos, Float3 endPos, float width, ColorRGBA color, string spriteName, float tex_multiplier)
- int AddLineWithSpriteColorRGBA(Float3 startPos, Float3 endPos, float width, ColorRGBA color, string spriteName, float tex_multiplier)
- void RemoveLine(int lineId)
- void MoveLineWithInterpolation(int lineId, Float3 startPos, Float3 endPos, float duration)
- void RemoveAllLines()
- void ChangeLineColor(int lineId, ColorRGBA color)
- void ChangeLineColorRGBA(int lineId, ColorRGBA color)
- void ChangeLineDisplay(int lineId, bool display)
- int AddGrid(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, bool rectCap)
- int AddGridColorRGBA(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, bool rectCap)
- int AddGridWithSprite(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, string spriteName, float tex_multiplier)
- int AddGridWithSpriteColorRGBA(Float3 center, float width, float height, int xCount, int zCount, float lineWidth, ColorRGBA color, string spriteName, float tex_multiplier)
- void RemoveGrid(int gridId)
- void SetBlurredScreenCaptureAsBackground(bool set, float duration)
Lighting {Lighting}
- void SetCustomLightColor(string name, ColorRGB color, float duration)
- void SetCustomLightColorRGB(string name, ColorRGB color, float duration)
- void SetCustomLightIntensity(string name, float intensity, float duration)
- void SetCustomLightPosition(string name, Float3 position, float duration)
- ColorRGB GetCustomLightColor(string name)
- ColorRGB GetCustomLightColorRGB(string name)
Custom UI {Custom-UI}
- Transform GetUiRootFrame()
- Float2 GetUiCanvasSize(bool ignoreSafeArea)
- float SetUiSizeMultiplier(float multiplier)
- Transform GetUiRootFrameForPlayer(int player)
- void DestroyFrame(Transform ui)
- bool FrameExists(Transform ui)
- Transform GetParentFrame(Transform item)
- Transform CreateFrame(Transform parent)
- float GetFrameWidth(Transform ui)
- float GetFrameHeight(Transform ui)
- void SetFrameUseImageSizeRatio(Transform ui, float ratio)
- void SetFrameAlpha(Transform ui, float alpha)
- Transform CreateMaskFrame(Transform parent)
- Transform CreateStencilMaskFrame(Transform parent)
- Transform CreateHighlightFrame(Transform parent)
- Transform CreateCameraFrame(Transform parent)
- Transform CreateVStackFrame(Transform parent)
- Transform CreateHStackFrame(Transform parent)
- Transform CreateGridFrame(Transform parent)
- void SetGridFrameLeftAlignment(Transform ui)
- void SetGridFrameRightAlignment(Transform ui)
- void SetGridFrameHorizontalCenterAlignment(Transform ui)
- void SetGridFrameTopAlignment(Transform ui)
- void SetGridFrameBottomAlignment(Transform ui)
- void SetGridFrameVerticalCenterAlignment(Transform ui)
- Transform CreateHScrollFrame(Transform parent)
- Transform CreateVScrollFrame(Transform parent)
- Transform CreateScrollFrame(Transform parent)
- int GetFrameIndexInParent(Transform item)
- void SetFrameIndexInParent(Transform item, int index)
- int GetChildrenFrameCount(Transform parent)
- Transform CreateButtonFrame(Transform parent)
- Transform CreateTextFrame(Transform parent)
- Transform CreateUserInputTextFrame(Transform parent)
- Transform CreateInputFrame(Transform parent)
- Transform CreateFrameFromXml(Transform parent, string name)
- void UpdateFrame(Transform ui, object callback)
- object GetFrameState(Transform ui)
- Transform GetChildFrameById(Transform ui, string id)
- object GetXmlFrames()
- object GetChildrenFramesIdAndFrameType(Transform ui)
- bool IsUiRootFrame(Transform ui)
- void SetCameraFrameViewportSize(Transform ui, int x, int y, bool discardDepth)
- void SetCameraFrameViewportPosition(Transform ui, float x, float y, float z)
- void SetCameraFrameViewportRotation(Transform ui, float x, float y, float z)
- void SetGridFrameCellWidth(Transform ui, float width)
- void SetGridFrameCellHeight(Transform ui, float height)
- Tweener AnimateCameraFrameViewportPosition(Transform ui, float x, float y, float z, float duration, string ease)
- Tweener AnimateCameraFrameViewportRotation(Transform ui, float x, float y, float z, float duration, string ease)
- Tweener AnimateCameraFrameOrthographicViewportSize(Transform ui, float size, float duration, string ease)
- void SetCameraFrameCullingMask(Transform ui, int mask)
- void SetCameraFrameBackgroundColor(Transform ui, ColorRGBA color)
- void SetCameraFrameBackgroundColorRGBA(Transform ui, ColorRGBA color)
- void SetCameraFrameViewportOrthographic(Transform ui, bool set)
- void SetCameraFrameOrthographicViewportSize(Transform ui, float size)
- Transform CreateMiniMapFrame(Transform parent, bool hideTerrain)
- void SetCameraFrameEffectColor(Transform ui, ColorRGB color, float saturation, float contrast, float brightness)
- void SetCameraFrameEffectColorRGB(Transform ui, ColorRGB color, float saturation, float contrast, float brightness)
- Transform GetScrollFrameContent(Transform parent)
- void SetScrollFrameScrollPosition(Transform ui, float position)
- float GetScrollFrameScrollPosition(Transform ui)
- void SetScrollFrameScrollPosition2D(Transform ui, Float2 position)
- Float2 GetScrollFrameScrollPosition2D(Transform ui)
- void SetScrollFrameScrollInertia(Transform ui, bool value)
- void SetScrollFrameSCrollEnable(Transform ui, bool value)
- void SetScrollFrameScrollEnable(Transform ui, bool value)
- void SetScrollFrameScrollDecelerationRate(Transform ui, float value)
- void SetScrollFrameScrollContentAlignment(Transform ui, string value)
- void SetTextFrameRtlSupport(Transform text, bool value)
- void SetTextFrameAlignment(Transform text, string alignment)
- void SetTextFrameWrapping(Transform text, bool enable)
- void SetTextFrameOverflow(Transform text, bool enable)
- void SetTextFrameText(Transform text, string content)
- void SetTextFrameTextExpression(Transform text, string content)
- void SetTextFrameFontSize(Transform text, float size)
- void SetTextFrameFontSizeMin(Transform text, float size)
- void SetTextFrameFontSizeMax(Transform text, float size)
- void SetTextFrameColor(Transform text, ColorRGB color)
- void SetTextFrameColorRGB(Transform text, ColorRGB color)
- void SetTextFrameOutline(Transform text, bool outline)
- void SetTextFrameShadow(Transform text, bool enableShadow)
- void SetTextFrameOutlineOutside(Transform text, bool outside)
- void SetTextFrameOutlineColor(Transform text, ColorRGBA color)
- void SetTextFrameOutlineColorRGBA(Transform text, ColorRGBA color)
- void SetTextFrameOutlineWidth(Transform text, float width)
- void SetTextFrameOutlineSoftness(Transform text, float softness)
- void SetTextFrameShadowWidth(Transform text, float width)
- void SetTextFrameShadowColor(Transform text, ColorRGBA color)
- void SetTextFrameShadowColorRGBA(Transform text, ColorRGBA color)
- void SetTextFrameShadowSoftness(Transform text, float softness)
- void SetTextFrameShadowDirection(Transform text, float x, float y)
- string GetInputFrameText(Transform text)
- void SetInputFrameText(Transform text, string content)
- void SetInputFrameFontSize(Transform text, float size)
- void SetInputFrameColor(Transform text, ColorRGB color)
- void SetInputFrameColorRGB(Transform text, ColorRGB color)
- void SetInputFrameWrapping(Transform text, bool enable)
- void SetInputFramePlaceholder(Transform text, string content)
- void SetInputFramePlaceholderFontSize(Transform text, float size)
- void SetInputFramePlaceholderColor(Transform text, ColorRGB color)
- void SetInputFramePlaceholderColorRGB(Transform text, ColorRGB color)
- void SetInputFramePlaceholderOutline(Transform text, bool outline)
- void SetUserInputTextFrameText(Transform text, string content)
- void SetUserInputTextFrameFontSize(Transform text, float size)
- void SetUserInputTextFrameColor(Transform text, ColorRGB color)
- void SetUserInputTextFrameColorRGB(Transform text, ColorRGB color)
- void SetUserInputTextFrameWrapping(Transform text, bool enable)
- void SetFrameMinSize(Transform ui, float width, float height)
- void SetFrameMinWidth(Transform ui, float width)
- void SetFrameMinHeight(Transform ui, float height)
- void SetFrameMaxSize(Transform ui, float width, float height)
- void SetFrameMaxWidth(Transform ui, float width)
- void SetFrameMaxHeight(Transform ui, float height)
- void SetFrameSize(Transform ui, float width, float height)
- void SetFrameWidth(Transform ui, float width)
- void SetFrameHeight(Transform ui, float height)
- void FlipFrameHorizontal(Transform ui)
- void FlipFrameVertical(Transform ui)
- void SetFrameMatchParent(Transform ui, bool matchWidth, bool matchHeight)
- void SetFramePadding(Transform ui, float padding)
- void SetFramePaddingLeft(Transform ui, float padding)
- void SetFramePaddingRight(Transform ui, float padding)
- void SetFramePaddingTop(Transform ui, float padding)
- void SetFramePaddingBottom(Transform ui, float padding)
- void SetFrameSpacing(Transform ui, float spacing)
- void SetFrameLeftAlignment(Transform ui)
- void SetFrameRightAlignment(Transform ui)
- void SetFrameTopAlignment(Transform ui)
- void SetFrameBottomAlignment(Transform ui)
- void SetFrameCenterAlignment(Transform ui)
- void SetFrameLeftAlignmentInParent(Transform ui)
- void SetFrameRightAlignmentInParent(Transform ui)
- void SetFrameTopAlignmentInParent(Transform ui)
- void SetFrameBottomAlignmentInParent(Transform ui)
- void SetFrameCenterAlignmentInParent(Transform ui)
- void SetFrameHorizontalOffsetInParent(Transform ui, float value)
- void SetFrameVerticalOffsetInParent(Transform ui, float value)
- void SetFrameReverseChildrenFrameOrder(Transform ui, bool value)
- void SetFrameImage(Transform ui, string name)
- void SetFrameImageExpression(Transform ui, string expression)
- void SetFrameImageGrayScaleExpression(Transform ui, string expression)
- void SetButtonFrameEnableExpression(Transform ui, string expression)
- void SetFrameImageTiled(Transform ui, bool setTiled)
- void SetFramePixelsPerUnitMultiplier(Transform ui, float pixelsPerUnitMultiplier)
- void SetFrameImageFillAmount(Transform ui, float fill)
- float GetFrameImageFillAmount(Transform ui)
- void SetFrameImageFillHorizontal(Transform ui)
- void SetFrameImageFillVertical(Transform ui)
- void SetFrameImageFillRadial(Transform ui)
- void SetFrameImageFillOrigin(Transform ui, int origin)
- void SetFrameImageFillAmountExpression(Transform ui, string expression, bool inverse)
- void SetFrameWidthExpression(Transform ui, string expression)
- void SetFrameHeightExpression(Transform ui, string expression)
- void SetFrameImageColor(Transform ui, ColorRGBA color)
- void SetFrameImageColorRGBA(Transform ui, ColorRGBA color)
- void SetFrameImageColorExpression(Transform ui, string r, string g, string b, string a)
- void SetFrameImageGrayScale(Transform ui, bool isGrayScale)
- void SetFrameTooltipText(Transform ui, string text)
- void SetFrameTooltipOffset(int offset)
- void SetFrameTooltipStyle(int style)
- void SetFrameTooltipPosition(int position)
- void SetFrameTooltipImage(string name)
- void SetFrameTooltipFontSize(int size)
- void SetFrameTooltipPadding(int left, int right, int top, int bottom)
- void SetFrameTooltipMaxWidth(int width)
- void SetFrameTooltipTextColor(ColorRGB color)
- void SetFrameTooltipTextColorRGB(ColorRGB color)
- void SetButtonFrameClickSound(Transform ui, string path)
- void SetButtonFrameEnable(Transform ui, bool enable)
- void SetButtonFrameDisabledImage(Transform ui, string name)
- void SetFrameRotation(Transform ui, float degrees)
- void SetFrameRotation3D(Transform ui, float x, float y, float z)
- void BindUnitData(string name, unit unit)
- void BindLuaTable(string name, object value)
- bool IsFrameActive(Transform ui)
- void SetFrameActive(Transform ui, bool value)
- void SetFrameBlockInput(Transform ui, bool value)
- void AttachFrameToUnit(Transform ui, unit unit, UnitLabelOptions options, bool useCurrentUiRoot)
- void SetMouseCursorFrame(Transform ui)
- void SetMouseCursorFrameForPlayer(int player, Transform ui)
- void AttachOffscreenUnitIndicatorFrame(Transform ui, unit unit, Transform rotatingPointerChildFrame)
- void MoveFrameToTop(Transform ui)
- void MoveFrameToBottom(Transform ui)
- void SetPauseButtonFrame(Transform ui)
- void SetPauseMenuFrame(Transform ui)
- void ShowPauseMenuFrame()
- void HidePauseMenuFrame()
- void SetPauseMenuFrameMusicButton(Transform ui)
- void SetPauseMenuFrameSoundButton(Transform ui)
- void SetPauseMenuFrameResumeButton(Transform ui)
- void SetPauseMenuFrameQuitButton(Transform ui)
- void SetPauseMenuFrameRestartButton(Transform ui)
- void SetPauseMenuFramePlayLevelButton(Transform ui, string path, string displayName)
- void SetPauseMenuFrameSettingsButton(Transform ui)
- void SuppressPauseMenuOnApplicationPause()
- Float3 GetFramePosition3D(Transform ui)
- Float3 GetCanvasPositionFromWorldPosition(Float3 worldPosition)
- void MoveFrameToPosition(Transform ui, Float3 canvasPosition, Offset offset)
- void SetFrameAnimationLoops(Tweener tweener, int loops, string loopType)
- void StopFrameAnimationLoops(Tweener tweener, bool waitAnimationComplete)
- Tweener AnimateFrameScale(Transform ui, Float3 start, Float3 end, float duration, string ease)
- Tweener AnimateFrameImageFillAmount(Transform ui, float start, float end, float duration, string ease)
- Tweener AnimateFrameRotation(Transform ui, Float3 start, Float3 end, float duration, string ease)
- Tweener AnimateFrameAlpha(Transform ui, float start, float end, float duration, string ease)
- Tweener AnimateFrameHorizontalOffset(Transform ui, float start, float end, float duration, string ease)
- Tweener AnimateFrameVerticalOffset(Transform ui, float start, float end, float duration, string ease)
- Tweener AnimateFrameScrollPosition(Transform ui, float start, float end, float duration, string ease)
- Tweener AnimateFrameScrollPosition2D(Transform ui, Float2 start, Float2 end, float duration, string ease)
- Float2 GetScreenSizeInPixel()
- Float2 GetScreenSafeAreaOffsetInPixel()
- Float2 GetScreenSafeAreaSizeInPixel()
Save {Save}
- void Save.Set(string key, object value)
- object Save.Get(string key)
- void Save.Commit()
- void Save.SetMapEntry(string entry)
Event {Event}
- void Event.Log(string key, object table)
- void Event.SetUserProperty(string key, object value)
- void Event.SetGameState(string state)
- void TriggerAddUnitSelectedEvent(unit unit, TypedCallback trigger)
- void TriggerAddUnitDeselectedEvent(unit unit, TypedCallback trigger)
- void TriggerAddUnitDamageEvent(unit unit, TypedCallback<float, unit> trigger, CriticalFilter filter)
- void TriggerAddUnitCriticalDamageEvent(unit unit, TypedCallback<float, unit> trigger)
- void TriggerAddUnitHealEvent(unit unit, TypedCallback<float, unit> trigger)
- void TriggerAddUnitSpawnEvent(unit unit, TypedCallback trigger, bool simple)
- void TriggerAddUnitDiedEvent(unit unit, TypedCallback<unit> trigger, bool simple)
- void TriggerAddUnitMoveCommandEvent(unit unit, TypedCallback<Float2> trigger)
- void TriggerAddOnUnitIdleEvent(unit unit, TypedCallback trigger)
- void TriggerAddUnitRemovedEvent(unit unit, TypedCallback trigger, bool simple)
- void TriggerAddTimerEventElapsed(TypedCallback trigger, float time, bool useRealTime, bool simple)
- void OnMapStart(TypedCallback trigger)
- void TriggerAddTimerEventPeriodic(TypedCallback trigger, float period, int lifeCount, bool useRealTime, bool simple)
- void TriggerAddTimerEventPeriodicIndefinite(TypedCallback trigger, float period, bool useRealTime, bool simple)
- void TriggerAddCastAbilityEvent(unit unit, TypedCallback<unit, Float2> trigger, bool simple, AbilityFilter filter)
- void TriggerAddUseAbilityEvent(unit unit, TypedCallback<unit, Float2> trigger, bool simple, AbilityFilter filter)
- void TriggerAddActivateAbilityEvent(unit unit, TypedCallback trigger, bool simple, AbilityFilter filter)
- void TriggerAddUnitAbilityOnOffEvent(unit unit, TypedCallback<bool> trigger, bool simple, AbilityFilter filter)
- void TriggerAddUnitAbilityOnEvent(unit unit, TypedCallback<bool> trigger, bool simple, AbilityFilter filter)
- void TriggerAddUnitAbilityOffEvent(unit unit, TypedCallback<bool> trigger, bool simple, AbilityFilter filter)
- void TriggerAddDeactivateAbilityEvent(unit unit, TypedCallback trigger, bool simple, AbilityFilter filter)
- void TriggerAddMouseDownEvent(int mouseButtonId, TypedCallback<Float2, unit> trigger)
- void TriggerAddMouseUpEvent(int mouseButtonId, TypedCallback<Float2, unit> trigger)
- void TriggerAddSwipeTouchDownEvent(TypedCallback<Float2> trigger)
- void TriggerAddSwipeTouchUpEvent(TypedCallback<Float2> trigger)
- void TriggerAddTouchDownEvent(TypedCallback<Float2, unit> trigger)
- void TriggerAddTouchUpEvent(TypedCallback<Float2, unit> trigger)
- void TriggerAddJoystickEvent(TypedCallback trigger)
- void TriggerAddJoystickEventWithJoystickOptions(TypedCallback trigger, JoystickOptions options)
- void TriggerAddJoystickTapEvent(TypedCallback trigger, int joystickId, float validDuration, float validRadius)
- void TriggerAddJoystickSwipeEvent(TypedCallback trigger, int joystickId, float validDuration)
- void TriggerAddJoystickReleaseEvent(TypedCallback trigger)
- void TriggerAddJoystickReleaseEventWithId(TypedCallback trigger, int joystickId)
- void TriggerAddTextCommandEvent(TypedCallback<string> trigger)
- void TriggerAddJoystickButtonEvent(int buttonId, TypedCallback trigger, JoystickButtonOptions options)
- void TriggerAddMappedKeyDownEvent(string keyEventName, TypedCallback<string> trigger)
- void TriggerAddMappedKeyUpEvent(string keyEventName, TypedCallback<string> trigger)
- void TriggerAddOnMouseTrackingEvent(TypedCallback<int, Float2> trigger)
- void StartMouseTracking(int playerId)
- void StopMouseTracking(int playerId)
- void SetBackButton(TypedCallback callback)
- void SetOnDownCallback(Transform ui, object callback)
- void SetOnUpCallback(Transform ui, object callback)
- void SetOnClickCallback(Transform ui, object callback)
- void SetPauseMenuCallback(TypedCallback<bool> callback)
- void TriggerAddBehaviorAddEvent(unit unit, TypedCallback<EffectContext> trigger, bool simple, BehaviorFilter filter)
- void TriggerAddBehaviorExpireEvent(unit unit, TypedCallback trigger, bool simple, BehaviorFilter filter)
- void TriggerAddBehaviorDisabledEvent(unit unit, TypedCallback trigger, bool simple, BehaviorFilter filter)
- void TriggerAddBehaviorEnabledEvent(unit unit, TypedCallback trigger, bool simple, BehaviorFilter filter)
- void TriggerAddBehaviorRemoveEvent(unit unit, TypedCallback trigger, bool simple, BehaviorFilter filter)
- void TriggerAddEffectEvent(string effectName, TypedCallback<EffectContext> trigger, bool simple)
- void TriggerAddEffectHookEvent(string effectName, TypedCallback<EffectContext> trigger, bool simple)
- void TriggerAddUnitEnterRegionEvent(unit unit, Region region, TypedCallback trigger)
- void TriggerAddUnitLeaveRegionEvent(unit unit, Region region, TypedCallback trigger)
- TriggeringJoystickAxes
- TriggeringJoystickId
- TriggeringJoystickButtonId
- TriggeringJoystickButtonEventType
- UnitBehaviorStatus
- BehaviorFilter
- AbilityFilter
- WeaponFilter
- CriticalFilter
- UnitTagStatus
- UnitFilter
- Unit
- Region
- Float2
- AbilityCost
- BehaviorModifier
- Float3
- EffectContext
- UnitLabelOptions
- Offset
- TextOptions
- ColorRGBA
- ColorRGB
- WaypointOptions
- ScreenBackgroundOptions
- AreaOffset
- JoystickOptions
- JoystickButtonOptions
- BigHeadMessageOptions
- SpawnGroupUnit
- SpawnGroup
- SpawnWaveInitialBehavior
- SpawnWaveOptions
See more information here.