星火 2.0 开发文档

主题

gamesparkcore · 其他 ​

AbilityDisplayExtensions 仅客户端 ​

命名空间 gamesparkcore.AbilitySystem

csharp
public static class AbilityDisplayExtensions

方法 ​

GetDisplayName 仅客户端 ​

csharp
public static string GetDisplayName(this Ability ability)

GetDisplayDescription 仅客户端 ​

csharp
public static string? GetDisplayDescription(this Ability ability)

GetDisplayIcon 仅客户端 ​

csharp
public static Icon? GetDisplayIcon(this Ability ability)

WaveAIExtensions 双端 ​

命名空间 gamesparkcore.AISystem

csharp
public static class WaveAIExtensions

方法 ​

MarchAlongRoute 仅服务端 ​

csharp
public static WaveAI MarchAlongRoute(this IEnumerable<Entity> units, PlacedLineReference route, PatrolMode? patrolMode = null, float? scanRange = null)

PatrolAlongRoute 仅服务端 ​

csharp
public static WaveAI PatrolAlongRoute(this IEnumerable<Entity> units, PlacedLineReference route, PatrolMode? patrolMode = null)

FollowAndAttack 仅服务端 ​

csharp
public static WaveAI FollowAndAttack(this IEnumerable<Entity> units, ITarget target, float? scanRange = null)

FollowWithoutAttack 仅服务端 ​

csharp
public static WaveAI FollowWithoutAttack(this IEnumerable<Entity> units, ITarget target)

HuntAndAttack 仅服务端 ​

csharp
public static WaveAI HuntAndAttack(this IEnumerable<Entity> units, float? scanRange = null)

HuntAndAttack 仅服务端 ​

csharp
public static WaveAI HuntAndAttack(this IEnumerable<Entity> units, IEnumerable<Entity> targets, float? scanRange = null)

HuntWithoutAttack 仅服务端 ​

csharp
public static WaveAI HuntWithoutAttack(this IEnumerable<Entity> units, float? scanRange = null)

HuntWithoutAttack 仅服务端 ​

csharp
public static WaveAI HuntWithoutAttack(this IEnumerable<Entity> units, IEnumerable<Entity> targets, float? scanRange = null)

BuffDisplayExtensions 仅客户端 ​

命名空间 gamesparkcore.BuffSystem

csharp
public static class BuffDisplayExtensions

方法 ​

GetDisplayName 仅客户端 ​

csharp
public static string GetDisplayName(this Buff buff)

GetDisplayDescription 仅客户端 ​

csharp
public static string? GetDisplayDescription(this Buff buff)

GetDisplayIcon 仅客户端 ​

csharp
public static Icon? GetDisplayIcon(this Buff buff)

CalculationExtensions 双端 ​

命名空间 gamesparkcore.CalculationSystem

csharp
public static class CalculationExtensions

方法 ​

RandomFloat 双端 ​

csharp
public static double RandomFloat(double min, double max, Random random)

IncludedAngle 双端 ​

csharp
public static Angle IncludedAngle(Angle a, Angle b)

ConversationSystemExtensions 双端 ​

命名空间 gamesparkcore.ConversationSystem

csharp
public static class ConversationSystemExtensions

方法 ​

csharp
public static CmdResult StartConversationByLink(this IGameLink<GameDataConversation> conversationLink, IExecutionContext? context = null)

ActorExtensions 双端 ​

命名空间 gamesparkcore.Execution

csharp
public static class ActorExtensions

方法 ​

CreateActorByScenePoint 仅客户端 ​

csharp
public static Actor? CreateActorByScenePoint(this IGameLink<GameDataActor> actorLink, ScenePoint point, bool skipBirth = false)

CreateActorByUnit 仅客户端 ​

csharp
public static Actor? CreateActorByUnit(this IGameLink<GameDataActor> actorLink, Unit unit, bool skipBirth = false)

CreateActorByItem 仅客户端 ​

csharp
public static Actor? CreateActorByItem(this IGameLink<GameDataActor> actorLink, Item item, bool skipBirth = false)

EffectExtensions 双端 ​

命名空间 gamesparkcore.Execution

csharp
public static class EffectExtensions

方法 ​

ExecuteResolved 仅服务端 ​

csharp
public static CmdResult ExecuteResolved(this IGameLink<GameDataEffect> link, Entity source, Entity target)

CreateResolveAndExecute 仅服务端 ​

csharp
public static TEffect? CreateResolveAndExecute<TEffect>(this IGameLink<GameDataEffect> link, Entity source, Entity target, out CmdResult result) where TEffect : Effect

ItemExtensions 双端 ​

命名空间 gamesparkcore.ItemSystem

csharp
public static class ItemExtensions

方法 ​

GiveItemTo 仅服务端 ​

csharp
public static bool GiveItemTo(this ItemPickable item, Unit target, bool isRequest = false)

CanPickUpBy 仅服务端 ​

csharp
public static bool CanPickUpBy(this Item item, Unit target, bool isRequest = false)
csharp
public static Item? CreateItemByLink(this IGameLink<GameDataItem> itemLink, ScenePoint position, Player? owner = null)

MoveItemToInventory 仅服务端 ​

csharp
public static bool MoveItemToInventory(this ItemPickable item, Inventory inventory)

MoveItemToSlot 仅服务端 ​

csharp
public static bool MoveItemToSlot(this ItemPickable item, InventorySlot slot)

PlayerExtensions 双端 ​

命名空间 gamesparkcore.PlayerAndUsers

csharp
public static class PlayerExtensions

方法 ​

GetNickname 双端 ​

csharp
public static string? GetNickname(this Player player)

GetNicknameOrDefault 双端 ​

csharp
public static string GetNicknameOrDefault(this Player player, string defaultName = "Unknown")

IsHuman 双端 ​

csharp
public static bool IsHuman(this Player player)

GetTeamId 双端 ​

csharp
public static int GetTeamId(this Player player)

GetUnitsCount 双端 ​

csharp
public static int GetUnitsCount(this Player player)

IsAllyTo 双端 ​

csharp
public static bool IsAllyTo(this Player player, Player other)

IsEnemyTo 双端 ​

csharp
public static bool IsEnemyTo(this Player player, Player other)

IsNeutralTo 双端 ​

csharp
public static bool IsNeutralTo(this Player player, Player other)

SetMainUnit 双端 ​

csharp
public static bool SetMainUnit(this Player player, Unit unit)

UserCloudDataExtensions 仅服务端 ​

命名空间 gamesparkcore.PlayerAndUsers

csharp
public static class UserCloudDataExtensions

方法 ​

QueryUserDataByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<IEnumerable<IUserDataBatchQueryResult>>> QueryUserDataByUserIdsAsync(List<long> userIds, IEnumerable<string> keys)

QueryUserDataByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<IEnumerable<IUserDataBatchQueryResult>>> QueryUserDataByUserIdsAsync(List<long> userIds, IEnumerable<string> keys, Action<long, IUserDataBatchQueryResult?>? onUserSuccess, Action<UserCloudDataResult>? onFailed)

QueryCurrencyByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<UserData<IUserCurrencyRecord>>> QueryCurrencyByUserIdsAsync(List<long> userIds, IEnumerable<string> keys)

QueryCurrencyByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<UserData<IUserCurrencyRecord>>> QueryCurrencyByUserIdsAsync(List<long> userIds, IEnumerable<string> keys, Action<long, IEnumerable<IUserCurrencyRecord>>? onUserSuccess, Action<UserCloudDataResult>? onFailed)

QueryCappedDataByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<UserData<IUserCappedDataRecord>>> QueryCappedDataByUserIdsAsync(List<long> userIds, IEnumerable<string> keys)

QueryCappedDataByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<UserData<IUserCappedDataRecord>>> QueryCappedDataByUserIdsAsync(List<long> userIds, IEnumerable<string> keys, Action<long, IEnumerable<IUserCappedDataRecord>>? onUserSuccess, Action<UserCloudDataResult>? onFailed)

QueryUserNamesByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<UserNames>> QueryUserNamesByUserIdsAsync(List<long> userIds)

QueryUserNamesByUserIdsAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<UserNames>> QueryUserNamesByUserIdsAsync(List<long> userIds, Action<long, string?>? onUserSuccess, Action<UserCloudDataResult>? onFailed)

QueryUserListItemsByUserIdAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<IEnumerable<IListItemRecord>>> QueryUserListItemsByUserIdAsync(long userId, string key, int? maxCount = null)

QueryUserListItemsByUserIdAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<IEnumerable<IListItemRecord>>> QueryUserListItemsByUserIdAsync(long userId, string key, Action<IListItemRecord>? onItemSuccess, Action<UserCloudDataResult>? onFailed, int? maxCount = null)

QueryUserListItemsByUserIdAsync 仅服务端 ​

csharp
public static Task<UserCloudDataResult<IEnumerable<IListItemRecord>>> QueryUserListItemsByUserIdAsync(long userId, string key, Action<IEnumerable<IListItemRecord>>? onSuccess, Action<UserCloudDataResult>? onFailed, int? maxCount = null)

QuestSystemExtensions 双端 ​

命名空间 gamesparkcore.QuestSystem

csharp
public static class QuestSystemExtensions

方法 ​

AcceptAndTrack 双端 ​

csharp
public static CmdResult AcceptAndTrack(this Player player, IGameLink<GameDataQuest> questLink, bool autoTrack = true)

TurnInIfCompletableAsync 双端 ​

csharp
public static CmdResult TurnInIfCompletableAsync(this Player player, IGameLink<GameDataQuest> questLink)

NotifyTalkToNpc 双端 ​

csharp
public static void NotifyTalkToNpc(this Player player, Unit npc)

ScenePointExtensions 双端 ​

命名空间 gamesparkcore.SceneSystem

csharp
public static class ScenePointExtensions

方法 ​

ClampToMap 双端 ​

csharp
public static ScenePoint ClampToMap(ScenePoint point)

RandomInRadius 双端 ​

csharp
public static ScenePoint RandomInRadius(this ScenePoint center, float radius, Random random)

RandomInRing 双端 ​

csharp
public static ScenePoint RandomInRing(this ScenePoint center, float minRadius, float maxRadius, Random random)

StringExtensions 双端 ​

命名空间 gamesparkcore.StringSystem

csharp
public static class StringExtensions

方法 ​

Concat 双端 ​

csharp
public static string Concat(params object?[] values)

StringToUTF8String 双端 ​

csharp
public static UTF8String StringToUTF8String(this string value)

UTF8StringToString 双端 ​

csharp
public static string UTF8StringToString(this UTF8String value)

TimerExtensions 双端 ​

命名空间 gamesparkcore.TimerSystem

csharp
public static class TimerExtensions

方法 ​

DelayOnce 双端 ​

csharp
public static Timer DelayOnce(double intervalSeconds, Action callback)

DelayRepeat 双端 ​

csharp
public static Timer DelayRepeat(double intervalSeconds, int times, Action callback)

DelayLoop 双端 ​

csharp
public static Timer DelayLoop(double intervalSeconds, Action callback)

NextFrame 双端 ​

csharp
public static NextTick NextFrame(Action callback)

TriggerExtensions 双端 ​

命名空间 gamesparkcore.TriggerSystem

csharp
public static class TriggerExtensions

方法 ​

CreateGlobalTrigger 双端 ​

csharp
public static Trigger<TEvent> CreateGlobalTrigger<TEvent>(Action callback, bool keepReference = true) where TEvent : class, ITriggerEvent<TEvent>

CreateTrigger 双端 ​

csharp
public static Trigger<TEvent> CreateTrigger<TEvent>(this IEventSender sender, Action callback, bool keepReference = true) where TEvent : class, ITriggerEvent<TEvent>

ControlExtensions 仅客户端 ​

命名空间 gamesparkcore.UISystem

csharp
public static class ControlExtensions

方法 ​

GetChild 仅客户端 ​

csharp
public static Control? GetChild(this Control control, string name)

GetChildren 仅客户端 ​

csharp
public static Control[] GetChildren(this Control control)

AbilityExtensions 双端 ​

命名空间 gamesparkcore.UnitSystem

csharp
public static class AbilityExtensions

方法 ​

GetOwner 双端 ​

csharp
public static Unit GetOwner(this Ability ability)

GetCooldownRemaining 双端 ​

csharp
public static TimeSpan? GetCooldownRemaining(this Ability ability)

GetMaxCooldown 双端 ​

csharp
public static TimeSpan? GetMaxCooldown(this Ability ability)

GetCurrentPhase 双端 ​

csharp
public static int? GetCurrentPhase(this Ability ability)

IsChargeAbility 双端 ​

csharp
public static bool IsChargeAbility(this Ability ability)

GetChargeCooldownRemaining 双端 ​

csharp
public static TimeSpan? GetChargeCooldownRemaining(this Ability ability)

GetChargeMaxCooldown 双端 ​

csharp
public static TimeSpan? GetChargeMaxCooldown(this Ability ability)

GetChargeCount 双端 ​

csharp
public static double? GetChargeCount(this Ability ability)

GetChargeMaxCount 双端 ​

csharp
public static double? GetChargeMaxCount(this Ability ability)

IsAbilityEnabled 双端 ​

csharp
public static bool IsAbilityEnabled(this Ability ability)

SetCooldownRemaining 仅服务端 ​

csharp
public static void SetCooldownRemaining(this Ability ability, TimeSpan remaining)

CreateAbilityForUnit 仅服务端 ​

csharp
public static Ability? CreateAbilityForUnit(this IGameLink<GameDataAbility> abilityLink, Unit unit)

UnitExtensions 双端 ​

命名空间 gamesparkcore.UnitSystem

csharp
public static class UnitExtensions

方法 ​

GetInventoryManager 双端 ​

csharp
public static InventoryManager? GetInventoryManager(this Unit unit)

GetAbilityCount 双端 ​

csharp
public static int GetAbilityCount(this Unit unit)

GetBuffCount 双端 ​

csharp
public static int GetBuffCount(this Unit unit)

GetAllInventories 双端 ​

csharp
public static IEnumerable<Inventory> GetAllInventories(this Unit unit)

GetInventoryAt 双端 ​

csharp
public static Inventory? GetInventoryAt(this Unit unit, int index)

GetAllInventorySlots 双端 ​

csharp
public static IEnumerable<InventorySlot> GetAllInventorySlots(this Unit unit)

GetAllSlots 双端 ​

csharp
public static IEnumerable<InventorySlot> GetAllSlots(this Inventory inventory)

GetSlotAt 双端 ​

csharp
public static InventorySlot? GetSlotAt(this Inventory inventory, int index)

GetAllOrders 双端 ​

csharp
public static IEnumerable<Order> GetAllOrders(this Unit unit)

GetOrderAt 双端 ​

csharp
public static Order? GetOrderAt(this Unit unit, int index)

GetAttributeValue 双端 ​

csharp
public static double GetAttributeValue(this Unit unit, IGameLink<GameDataUnitProperty> key)

GetLevel 双端 ​

csharp
public static int GetLevel(this Unit unit)

GetMaxLevel 双端 ​

csharp
public static int? GetMaxLevel(this Unit unit)

GetExp 双端 ​

csharp
public static double GetExp(this Unit unit)

IsAlly 双端 ​

csharp
public static bool IsAlly(this Unit unit, Entity target)

IsEnemy 双端 ​

csharp
public static bool IsEnemy(this Unit unit, Entity target)

IsInRange 双端 ​

csharp
public static bool IsInRange(this Unit unit, ITarget target, float range)

GetTeamId 双端 ​

csharp
public static int GetTeamId(this Unit unit)

GetTotalBuffStack 双端 ​

csharp
public static uint GetTotalBuffStack(this Unit unit, IGameLink<GameDataBuff> link)

GetAllItems 双端 ​

csharp
public static IEnumerable<ItemPickable> GetAllItems(this Unit unit)

HasItem 双端 ​

csharp
public static bool HasItem(this Unit unit, IGameLink<GameDataItem> link)

GetInventoryItems 双端 ​

csharp
public static IEnumerable<ItemPickable> GetInventoryItems(this Unit unit, int inventoryIndex)

GetDisplayName 仅客户端 ​

csharp
public static string GetDisplayName(this Unit unit)

GetDisplayDescription 仅客户端 ​

csharp
public static string? GetDisplayDescription(this Unit unit)

GetDisplayIcon 仅客户端 ​

csharp
public static Icon? GetDisplayIcon(this Unit unit)

GetBuffManager 双端 ​

csharp
public static BuffManager? GetBuffManager(this Unit unit)

HasBuff 双端 ​

csharp
public static bool HasBuff(this Unit unit, IGameLink<GameDataBuff> Buff)

GetBuff 双端 ​

csharp
public static Buff? GetBuff(this Unit unit, IGameLink<GameDataBuff> Buff)

GetBuffs 双端 ​

csharp
public static ReadOnlySet<Buff>? GetBuffs(this Unit unit, IGameLink<GameDataBuff> Buff)

GetAllBuffs 双端 ​

csharp
public static HashSet<Buff>? GetAllBuffs(this Unit unit)

HasAnyBuff 双端 ​

csharp
public static bool HasAnyBuff(this Unit unit, params IGameLink<GameDataBuff>[] Buffs)

HasAllBuffs 双端 ​

csharp
public static bool HasAllBuffs(this Unit unit, params IGameLink<GameDataBuff>[] Buffs)

GetBuffsByPolarity 双端 ​

csharp
public static IEnumerable<Buff>? GetBuffsByPolarity(this Unit unit, BuffPolarity polarity)

GetDispellableBuffs 双端 ​

csharp
public static IEnumerable<Buff>? GetDispellableBuffs(this Unit unit)

CountBuffsByPolarity 双端 ​

csharp
public static int CountBuffsByPolarity(this Unit unit, BuffPolarity polarity)

GetAbilityManager 双端 ​

csharp
public static AbilityManager? GetAbilityManager(this Unit unit)

HasAbility 双端 ​

csharp
public static bool HasAbility(this Unit unit, IGameLink<GameDataAbility> abilityLink)

HasAnyAbility 双端 ​

csharp
public static bool HasAnyAbility(this Unit unit, params IGameLink<GameDataAbility>[] abilityLinks)

HasAllAbilities 双端 ​

csharp
public static bool HasAllAbilities(this Unit unit, params IGameLink<GameDataAbility>[] abilityLinks)

GetAbility 双端 ​

csharp
public static Ability? GetAbility(this Unit unit, IGameLink<GameDataAbility> abilityLink)

GetAllAbilities 双端 ​

csharp
public static ReadOnlySet<Ability>? GetAllAbilities(this Unit unit, IGameLink<GameDataAbility> abilityLink)

GetAllAbilities 双端 ​

csharp
public static HashSet<Ability>? GetAllAbilities(this Unit unit)

GetActiveAbilities 双端 ​

csharp
public static IEnumerable<Ability>? GetActiveAbilities(this Unit unit)

GetPassiveAbilities 双端 ​

csharp
public static IEnumerable<Ability>? GetPassiveAbilities(this Unit unit)

GetValidAttack 双端 ​

csharp
public static AbilityExecute? GetValidAttack(this Unit unit)

IsAbilityEnabled 双端 ​

csharp
public static bool IsAbilityEnabled(this Unit unit, IGameLink<GameDataAbility> abilityLink)

IsAbilityActivated 双端 ​

csharp
public static bool IsAbilityActivated(this Unit unit, IGameLink<GameDataAbility> abilityLink)
csharp
public static Unit? CreateUnitByLink(this IGameLink<GameDataUnit> unitLink, Player owner, ScenePoint position, Angle facing, bool useDefaultAI = false)

CreateItemAndGive 仅服务端 ​

csharp
public static ItemPickable? CreateItemAndGive(this Unit unit, IGameLink<GameDataItem> itemLink, bool isRequest = false)
csharp
public static Inventory? AddInventoryByLink(this Unit unit, IGameLink<GameDataInventory> inventoryLink)

RemoveInventory 仅服务端 ​

csharp
public static bool RemoveInventory(this Unit unit, Inventory inventory)

AddAbility 仅服务端 ​

csharp
public static Ability? AddAbility(this Unit unit, IGameLink<GameDataAbility> abilityLink)

RemoveAbility 仅服务端 ​

csharp
public static bool RemoveAbility(this Unit unit, IGameLink<GameDataAbility> abilityLink)

RemoveAbilities 仅服务端 ​

csharp
public static int RemoveAbilities(this Unit unit, IGameLink<GameDataAbility> abilityLink)

AddBuff 仅服务端 ​

csharp
public static Buff? AddBuff(this Unit unit, IGameLink<GameDataBuff> buffLink, uint? stack = null, TimeSpan? duration = null)

RemoveBuff 仅服务端 ​

csharp
public static bool RemoveBuff(this Unit unit, IGameLink<GameDataBuff> buffLink)

RemoveBuffs 仅服务端 ​

csharp
public static int RemoveBuffs(this Unit unit, IGameLink<GameDataBuff> buffLink)

SetAttributeValue 仅服务端 ​

csharp
public static void SetAttributeValue(this Unit unit, IGameLink<GameDataUnitProperty> key, double value)

AddAttributeValue 仅服务端 ​

csharp
public static void AddAttributeValue(this Unit unit, IGameLink<GameDataUnitProperty> key, double delta)

SetLevel 仅服务端 ​

csharp
public static bool SetLevel(this Unit unit, int level)

AddLevel 仅服务端 ​

csharp
public static bool AddLevel(this Unit unit, int delta)

SetExp 仅服务端 ​

csharp
public static void SetExp(this Unit unit, double exp)

AddExp 仅服务端 ​

csharp
public static void AddExp(this Unit unit, double exp)

IsWalking 仅服务端 ​

csharp
public static bool IsWalking(this Unit unit)

DispelPositiveBuffs 仅服务端 ​

csharp
public static int DispelPositiveBuffs(this Unit unit, bool onlyDispellable = true)

DispelNegativeBuffs 仅服务端 ​

csharp
public static int DispelNegativeBuffs(this Unit unit, bool onlyDispellable = true)

DispelBuffs 仅服务端 ​

csharp
public static int DispelBuffs(this Unit unit, BuffPolarity polarity, bool onlyDispellable = true)

ClearAllDispellableBuffs 仅服务端 ​

csharp
public static int ClearAllDispellableBuffs(this Unit unit)

RemoveBuffsByPredicate 仅服务端 ​

csharp
public static int RemoveBuffsByPredicate(this Unit unit, Func<Buff, bool> predicate)

HasAIThinkTree 仅服务端 ​

csharp
public static bool HasAIThinkTree(this Unit host)

HasWaveAI 仅服务端 ​

csharp
public static bool HasWaveAI(this Unit host)

EnableAIThinkTree 仅服务端 ​

csharp
public static bool EnableAIThinkTree(this Unit host)

DisableAIThinkTree 仅服务端 ​

csharp
public static bool DisableAIThinkTree(this Unit host)

RemoveAI 仅服务端 ​

csharp
public static AIThinkTree? RemoveAI(this Unit host)