EngineInterface.GoInterface

IApproachableTarget 双端

命名空间 EngineInterface.GoInterface

public interface IApproachableTarget

ICoreActor 双端

命名空间 EngineInterface.GoInterface

public interface ICoreActor

属性

ActorId 双端

public int ActorId { get; }

PlayerId 双端

public int PlayerId { get; }

IsValid 双端

public bool IsValid { get; }

CoreActorType 仅客户端

public CoreActorType CoreActorType { get; }

方法

GetPropertyWithHash 双端

T? GetPropertyWithHash<T>(long propertyHash)

GetPropertiesWithHash 仅客户端

PropertyHashKeyValue[] GetPropertiesWithHash(bool modifiedOnly = true)

GetBytesPropertiesWithHash 仅客户端

IEnumerable<PropertyHashKeyValueBytes> GetBytesPropertiesWithHash(bool modifiedOnly = true)

GetCooldownWithHash 双端

TimeSpan? GetCooldownWithHash(long propertyHash)

GetCooldownMaxWithHash 双端

TimeSpan? GetCooldownMaxWithHash(long propertyHash)

GetCooldownDataWithHash 双端

byte[]? GetCooldownDataWithHash(long propertyHash)

ChangeOwner 双端

bool ChangeOwner(int newPlayerId)

SetPropertyWithHash 仅服务端

void SetPropertyWithHash<T>(long propertyHash, T value)

AddPropertyWithHash 仅服务端

void AddPropertyWithHash(long propertyHash, double value)

SetPropertyDefaultSyncType 仅服务端

void SetPropertyDefaultSyncType(int hashLow32, SyncType syncType)

SetComponentSyncType 仅服务端

void SetComponentSyncType(int hashHigh32, SyncType syncType)

SetPropertySyncType 仅服务端

void SetPropertySyncType(long propertyHash, SyncType syncType)

Overrides synchronization for one complete property or timer key on this actor.

TogglePropertyModifyEvent 仅服务端

void TogglePropertyModifyEvent(long hash, bool on)

SetSyncType 仅服务端

void SetSyncType(SyncType type)

SetCooldownWithHash 仅服务端

void SetCooldownWithHash(long propertyHash, TimeSpan max, TimeSpan? current = null)

SetCooldownWithHash 仅服务端

void SetCooldownWithHash(long propertyHash, TimeSpan max, TimeSpan current, byte[] data)

RestartCooldownWithHash 仅服务端

void RestartCooldownWithHash(long propertyHash)

ClearCooldownWithHash 仅服务端

void ClearCooldownWithHash(long propertyHash)

Kill 仅服务端

void Kill()

Revive 仅服务端

void Revive()

Destroy 仅服务端

void Destroy()

IsVisibleTo 仅服务端

bool IsVisibleTo(int playerId)

SetCoreActorType 仅服务端

void SetCoreActorType(CoreActorType actorType)

字段

CoreActorTypeHash 双端

const int CoreActorTypeHash

IDetector 双端

命名空间 EngineInterface.GoInterface

public interface IDetector

方法

Destroy 双端

void Destroy()

事件

OnEnter 双端

event Action<int>? OnEnter

OnExit 双端

event Action<int>? OnExit

IScenePoint 双端

命名空间 EngineInterface.GoInterface

public interface IScenePoint : IApproachableTarget

属性

X 双端

public float X { get; }

Y 双端

public float Y { get; }

Z 双端

public float Z { get; }

Scene 双端

public IViewScene Scene { get; }

ToVector3 双端

public Vector3 ToVector3 { get; }

IViewActor 双端

命名空间 EngineInterface.GoInterface

public interface IViewActor : ICoreActor, IViewAsyncActor, IApproachableTarget

属性

ActorId 双端

new int ActorId { get; }

StatusBar 仅客户端

public IViewStatusBar StatusBar { get; }

Scene 仅服务端

public IViewScene Scene { get; }

Position 仅服务端

public IScenePoint Position { get; }

Height 仅服务端

public float Height { get; set; }

Facing 仅服务端

public float Facing { get; }

SearchRadius 仅服务端

public float SearchRadius { get; set; }

Scale 仅服务端

public float Scale { set; }

IsJoystickMoving 仅服务端

public bool IsJoystickMoving { get; }

JoystickMovingTime 仅服务端

public int JoystickMovingTime { get; }

方法

MoveTo 双端

bool MoveTo(IScenePoint point, bool sync = true, bool syncDistance = true)

AttachTo 双端

bool AttachTo(IViewActor? parent)

SetLocalSightCircle 仅客户端

bool SetLocalSightCircle(float radius)

SetLocalSightCone 仅客户端

bool SetLocalSightCone(float directionX, float directionY, float radius, float centralAngle, float innerRadius, int directionSource, float fixedDirection)

SetLocalSightFocus 仅客户端

bool SetLocalSightFocus(bool enabled)

PathTo 仅服务端

bool PathTo(IApproachableTarget target, float maxDis, float minDis, bool targetActorVisionCheck = true)

• target —
• maxDis —
• minDis —
• targetActorVisionCheck — When true, and target is an actor, the unit need to be able to see the target to approach

返回：

Stop 仅服务端

void Stop()

AddHeight 仅服务端

void AddHeight(float height)

SetFacing 仅服务端

void SetFacing(float angle, TimeSpan time)

SetPositionSilent 仅服务端

bool SetPositionSilent(IScenePoint point)

SetFacingSilent 仅服务端

bool SetFacingSilent(float angle)

SelectLineUnits 仅服务端

int[]? SelectLineUnits(IScenePoint from, IScenePoint to, float radius)

IsPathBlocked 仅服务端

bool IsPathBlocked(IScenePoint position, int flags)

SetVisionObserverEnabled 仅服务端

bool SetVisionObserverEnabled(bool enabled)

SetVisionShape 仅服务端

bool SetVisionShape(float centralAngle, float innerRadius, int directionSource, float fixedDirection)

ChangeLink 仅服务端

bool ChangeLink(int linkHash)

StartJoystickMove 仅服务端

void StartJoystickMove(float x, float y)

StartJoystickMove 仅服务端

void StartJoystickMove(float x, float y, float z)

StopJoystickMove 仅服务端

void StopJoystickMove()

SwitchScene 仅服务端

bool SwitchScene(IViewScene scene)

SetModel 仅服务端

void SetModel(int linkHash)

Approach 仅服务端

bool Approach(IApproachableTarget target, float maxDis, float minDis, int customApproachId = 0, bool targetActorVisionCheck = true)

StopApproach 仅服务端

bool StopApproach(int customApproachId = 0)

CreateViewMover 仅服务端

IViewMover? CreateViewMover(IMoverData data, int targetActorId)

CreateViewMover 仅服务端

IViewMover? CreateViewMover(IMoverData data, IScenePoint targetPosition)

AddState 仅服务端

void AddState(UnitState state)

RemoveState 仅服务端

void RemoveState(UnitState state)

IViewAnimation 双端

命名空间 EngineInterface.GoInterface

public interface IViewAnimation

属性

IsEngineAnimation 双端

public bool IsEngineAnimation { get; }

Gets if this animation is created by the engine instead of the game logic. e.g., animations created by the engine for character movement, idle and death animations, or animation instances created by the animation sequence system.

Phase 双端

public int Phase { get; }

IsPlaying 双端

public bool IsPlaying { get; }

Asset 双端

public UTF8String Asset { get; }

Priority 双端

public int Priority { get; set; }

Gets or sets the animation priority in the inclusive range 0-31.

备注

Lower values are treated as 0 and higher values are treated as 31 by the native animation layer packing.

LogicLayer 双端

public AnimationLogicLayer LogicLayer { get; }

Duration 双端

public float Duration { get; }

IsLooping 双端

public bool IsLooping { get; set; }

IsSuppressed 双端

public bool IsSuppressed { get; }

PauseOnSuppressed 双端

public bool PauseOnSuppressed { get; set; }

PlayingOffset 双端

public float PlayingOffset { get; set; }

Speed 双端

public float Speed { get; set; }

Type 双端

public int Type { get; }

ActorId 双端

public int ActorId { get; }

AnimationId 双端

public int AnimationId { get; }

方法

FadeBlendWeight 双端

bool FadeBlendWeight(float targetWeight, float fadeTime)

Stop 双端

bool Stop(float fadeOutTime = 0.15f)

事件

StateChanged 双端

event Action<AnimationStateEvent>? StateChanged

TimedEventTriggered 双端

event Action<UTF8String, bool>? TimedEventTriggered

IViewAnimationSequence 双端

命名空间 EngineInterface.GoInterface

public interface IViewAnimationSequence

方法

Pause 双端

void Pause(bool on)

Stop 双端

void Stop()

SwitchTo 双端

void SwitchTo(int index = -1)

事件

EventTriggered 双端

event Action<int, float, int, IViewAnimation?>? EventTriggered

Removed 双端

event Action? Removed

IndexChanged 双端

event Action<int>? IndexChanged

IViewAsyncActor 双端

命名空间 EngineInterface.GoInterface

public interface IViewAsyncActor

属性

ActorId 仅客户端

public int ActorId { get; }

Scene 仅客户端

public IViewScene Scene { get; }

Position 仅客户端

public IScenePoint Position { get; set; }

WorldPosition 仅客户端

public IScenePoint WorldPosition { get; }

Rotation 仅客户端

public Vector3 Rotation { get; set; }

Scale 仅客户端

public Vector3 Scale { get; set; }

Facing 仅客户端

public float Facing { get; }

ShouldRemoveWithParent 仅客户端

public bool ShouldRemoveWithParent { get; set; }

AnimationIds 仅客户端

public int[]? AnimationIds { get; }

方法

Detach 仅客户端

bool Detach(bool resetBearings = false)

AttachTo 仅客户端

bool AttachTo(IViewAsyncActor parent, UTF8String socket)

GetSocketPosition 仅客户端

IScenePoint GetSocketPosition(UTF8String socket)

Kill 仅客户端

void Kill()

Destroy 仅客户端

void Destroy(bool ForceNoFade = false)

SetOffset 仅客户端

void SetOffset(Vector3 vector3)

SetGroundZ 仅客户端

void SetGroundZ(float z)

GetGroundZ 仅客户端

float GetGroundZ()

ChangeOwner 仅客户端

bool ChangeOwner(int PlayerId)

SetAsset 仅客户端

bool SetAsset(int linkHash)

SetShowShadow 仅客户端

bool SetShowShadow(bool show)

SetLaunchSite 仅客户端

bool SetLaunchSite(IViewAsyncActor actor, UTF8String socket)

SetLaunchSite 仅客户端

bool SetLaunchSite(Vector3 position, bool offsetByGroundZ = false)

SetImpactSite 仅客户端

bool SetImpactSite(IViewAsyncActor actor, UTF8String socket)

For ActorAction Only

• actor —
• socket —

返回：

SetHighlight 仅客户端

void SetHighlight(short R, short G, short B, short A)

ClearHighlight 仅客户端

void ClearHighlight()

PlayAnimation 仅客户端

IViewAnimation? PlayAnimation(UTF8String animationName, AnimationPlayParam? param = null)

PlayAnimationBracket 仅客户端

IViewAnimation? PlayAnimationBracket(AnimationBracketPlayParam param)

PlayAnimationSequence 仅客户端

IViewAnimationSequence? PlayAnimationSequence(int seqConfigHash, bool triggerEvents = false, float speed = 1f)

StopAnimationOfLayer 仅客户端

bool StopAnimationOfLayer(AnimationLogicLayer logicLayer)

SetBirthStandDeathAnimation 仅客户端

bool SetBirthStandDeathAnimation(UTF8String birth, UTF8String stand, UTF8String death)

SetUnitLocomotionAnimationProfile 仅客户端

bool SetUnitLocomotionAnimationProfile(UnitLocomotionAnimationProfilePayload profile)

DisableUnitLocomotionAnimation 仅客户端

bool DisableUnitLocomotionAnimation()

StopAnimationBracket 仅客户端

bool StopAnimationBracket(IViewAnimation viewAnimation, bool destroy = false)

GetAnimationInstances 仅客户端

IEnumerable<IViewAnimation> GetAnimationInstances()

ClearAnimationMapping 仅客户端

bool ClearAnimationMapping(UTF8String alias)

SetAnimationMapping 仅客户端

bool SetAnimationMapping(UTF8String alias, UTF8String animationRaw)

SetTintColor 仅客户端

void SetTintColor(short R, short G, short B, short A, bool isOverride = false)

ClearTintColor 仅客户端

void ClearTintColor()

ResetTintColorByType 仅客户端

void ResetTintColorByType(bool isOverride = false)

RegisterBoneChain 仅客户端

bool RegisterBoneChain(int chainId, IEnumerable<ModelBoneWeight> modelBoneWeights)

UnregisterBoneChain 仅客户端

bool UnregisterBoneChain(int chainId)

SetBoneChainFacing 仅客户端

bool SetBoneChainFacing(int chainId, float facing, float duration = 0f)

ResetBoneChainFacing 仅客户端

bool ResetBoneChainFacing(int chainId, float duration = 0f)

SetUpperBodyRootBone 仅客户端

bool SetUpperBodyRootBone(UTF8String boneName)

IViewAsyncActorController 双端

命名空间 EngineInterface.GoInterface

public interface IViewAsyncActorController : IViewAsyncActor

方法

Play 仅客户端

bool Play()

SetPlaySpeed 仅客户端

bool SetPlaySpeed(float speed)

SetPlayDuration 仅客户端

bool SetPlayDuration(TimeSpan duration)

SetPlayOffset 仅客户端

bool SetPlayOffset(TimeSpan offset, bool triggerEvents = false)

SetPlayPercent 仅客户端

bool SetPlayPercent(float percent)

Pause 仅客户端

bool Pause()

Resume 仅客户端

bool Resume()

Stop 仅客户端

bool Stop(bool fade = true)

Mute 仅客户端

bool Mute(bool on)

SetSoundVolume 仅客户端

bool SetSoundVolume(float volume)

SetGridAxis 仅客户端

bool SetGridAxis(Vector3 x, Vector3 y)

SetGridBounds 仅客户端

bool SetGridBounds(Rectangle rect)

SetGridState 仅客户端

bool SetGridState(Point block, int state)

SetGridStickToGround 仅客户端

bool SetGridStickToGround(bool stickToGround)

SetText 仅客户端

bool SetText(UTF8String text)

SetMaterialParameter 仅客户端

void SetMaterialParameter(int intParam)

SetMaterialParameter 仅客户端

void SetMaterialParameter(float floatParam)

SetMaterialParameter 仅客户端

void SetMaterialParameter(Color colorParam)

GetSoundAsset 仅客户端

UTF8String GetSoundAsset()

IViewBarWidget 双端

命名空间 EngineInterface.GoInterface

public interface IViewBarWidget : IViewWidget

方法

SetPercentage 仅客户端

bool SetPercentage(float percentage)

SetSkinIndex 仅客户端

bool SetSkinIndex(int skinIndex)

IViewFloatingText 双端

命名空间 EngineInterface.GoInterface

public interface IViewFloatingText : IViewWidgetContainer

方法

AttachToUnit 双端

void AttachToUnit(IViewActor actor)

Destroy 双端

void Destroy()

SetUIPosition 双端

void SetUIPosition(Vector2 position2D)

SetWorldPosition 双端

void SetWorldPosition(Vector3 position3D)

IViewGame 双端

命名空间 EngineInterface.GoInterface

public interface IViewGame

属性

IsDebugTestMode 双端

public bool IsDebugTestMode { get; }

RuntimeEnvironment 双端

public GameRuntimeEnvironment RuntimeEnvironment { get; }

当前游戏局的运行时环境，用于区分项目自己的调试、内测和正式数据隔离环境。

DeploymentEnvironment 双端

public GameDeploymentEnvironment DeploymentEnvironment { get; }

当前游戏 Host 所在的部署环境，用于区分官方平台和编辑器发布通道。

IsClientOnly 双端

public bool IsClientOnly { get; }

是否为纯客户端模式（无服务端连接）。

StartFromEngine 双端

public bool StartFromEngine { get; }

SessionId 双端

public long SessionId { get; }

ProjectId 双端

public string ProjectId { get; }

Platform 仅客户端

public Platform Platform { get; }

LobbyModeKey 仅服务端

public string LobbyModeKey { get; }

Gets the creator-center lobby mode key associated with the current game session.

IsSessionResident 仅服务端

public bool IsSessionResident { get; }

Gets whether the current server session is resident.

IsPaused 仅服务端

public bool IsPaused { get; }

方法

StartGameTick 双端

void StartGameTick()

RegisterScene 双端

IViewScene RegisterScene(int hash)

GetViewPlayer 双端

IViewPlayer? GetViewPlayer(int playerId)

GetViewTeam 双端

IViewTeam? GetViewTeam(int teamId)

SimpleOut 双端

void SimpleOut()

Simply calls a function of the host game engine.

FlushLogs 双端

void FlushLogs()

Flush log output owned by the current runtime.

SimpleInTest 双端

void SimpleInTest(int count)

Ask the host game engine to call the framework count times.

• count —

LoadClientScene 仅客户端

bool LoadClientScene(UTF8String sceneName, UTF8String templateSceneName, bool randomMap, bool asyncLoadingBlock)

CreateFloatingText 仅客户端

IViewFloatingText? CreateFloatingText(IViewActor referenceActor, UTF8String text, UTF8String link)

CreateFloatingText 仅客户端

IViewFloatingText? CreateFloatingText(Vector3 worldPos, UTF8String text, UTF8String link)

CreateFloatingText 仅客户端

IViewFloatingText? CreateFloatingText(Vector2 screenPosition, UTF8String text, UTF8String link)

CreateStatusBarCustom 仅客户端

IViewStatusBarCustom? CreateStatusBarCustom(Vector3 worldPos, UTF8String link)

CreateStatusBarCustom 仅客户端

IViewStatusBarCustom? CreateStatusBarCustom(Vector2 screenPosition, UTF8String link)

ScreenRaycast 仅客户端

int[]? ScreenRaycast(float x, float y, int level)

GetLocalPlayerId 仅客户端

int GetLocalPlayerId()

GetCoreActor 仅客户端

ICoreActor GetCoreActor(int actorId)

GetViewActor 仅客户端

IViewActor GetViewActor(int actorId)

SendHostMessage 仅客户端

bool SendHostMessage(int typeHash, ReadOnlySpan<byte> msg)

SetSoundCategoryVolume 仅客户端

bool SetSoundCategoryVolume(int category, float volume)

StopSoundInCategory 仅客户端

bool StopSoundInCategory(int category)

Log 双端

void Log(int level, string message)

RequestSessionEnd 仅服务端

void RequestSessionEnd()

Requests that the host end the current game session.

SetSessionResident 仅服务端

SessionResidenceResult SetSessionResident(bool resident)

Changes whether the current server session remains resident when no players are online.

• resident — true to request residence; otherwise, to release it.

返回： The result of applying the requested state.

CopyScene 仅服务端

bool CopyScene(int sceneTemplateHash, UTF8String newSceneTag)

PauseGame 仅服务端

void PauseGame(float timeOut, bool unitsOnly)

ResumeGame 仅服务端

void ResumeGame()

SetPropertyHashDefaultSyncTypeGlobal 仅服务端

void SetPropertyHashDefaultSyncTypeGlobal(int hashLow32, SyncType syncType)

SetPropertyHash64DefaultSyncTypeGlobal 仅服务端

void SetPropertyHash64DefaultSyncTypeGlobal(long hash, SyncType syncType)

CreateDetectorPolygon 仅服务端

IDetector? CreateDetectorPolygon(IViewScene scene, params Vector2[] points)

CreateDetectorCircle 仅服务端

IDetector? CreateDetectorCircle(IScenePoint position, float radius)

事件

OnTick 双端

event Action<int>? OnTick

OnEngineStart 双端

event Action? OnEngineStart

OnEngineEnd 双端

event Action? OnEngineEnd

OnHostCooldown 双端

event Action<int, long>? OnHostCooldown

OnHostDisconnected 仅客户端

event Action? OnHostDisconnected

Called when the connected game Host is disconnected. This is optional for binary compatibility with older client assemblies.

OnApplicationWillEnterBackground 仅客户端

event Action? OnApplicationWillEnterBackground

Called when the mobile application is about to enter the background. This is optional for binary compatibility with older client assemblies.

OnApplicationDidEnterBackground 仅客户端

event Action? OnApplicationDidEnterBackground

Called after the mobile application has entered the background. This is optional for binary compatibility with older client assemblies.

OnApplicationWillEnterForeground 仅客户端

event Action? OnApplicationWillEnterForeground

Called when the mobile application is about to return to the foreground. This is optional for binary compatibility with older client assemblies.

OnApplicationDidEnterForeground 仅客户端

event Action? OnApplicationDidEnterForeground

Called after the mobile application has returned to the foreground. This is optional for binary compatibility with older client assemblies.

OnApplicationLowMemory 仅客户端

event Action? OnApplicationLowMemory

Called when the mobile operating system reports memory pressure. This is optional for binary compatibility with older client assemblies.

OnHostCooldownUpdate 仅客户端

event Action<int, long, TimeSpan>? OnHostCooldownUpdate

OnHostCooldownStoppedEarly 仅客户端

event Action<int, long>? OnHostCooldownStoppedEarly

OnCoreActorChanged 仅客户端

event Action<int>? OnCoreActorChanged

OnCoreActorAppear 仅客户端

event Action<int, bool, int>? OnCoreActorAppear

OnCoreActorDisappear 仅客户端

event Action<int, ActorDisappearType>? OnCoreActorDisappear

OnGameInfoUpdate 仅客户端

event Action<UTF8String>? OnGameInfoUpdate

OnPropertyChangedDouble 仅客户端

event Action<int, long, double> OnPropertyChangedDouble

OnPropertyChangedBytes 仅客户端

event Action<int, long, ReadOnlySpan<byte>> OnPropertyChangedBytes

OnHostMessage 仅客户端

event Action<int, ReadOnlySpan<byte>>? OnHostMessage

OnSceneHashLoadStart 仅客户端

event Action<int>? OnSceneHashLoadStart

OnSceneHashLoadEnd 仅客户端

event Action<int>? OnSceneHashLoadEnd

OnSceneHashLoadEndWithResult 仅客户端

event Action<int, bool>? OnSceneHashLoadEndWithResult

ActorTimedAssetEventTriggered 仅客户端

event Action<int, UTF8String, bool>? ActorTimedAssetEventTriggered

ActorTimedAnimationEventTriggered 仅客户端

event Action<int, UTF8String, IViewAnimation, bool>? ActorTimedAnimationEventTriggered

OnCoreActorRemove 仅服务端

event Action<int>? OnCoreActorRemove

int => CoreActorId

OnCanLoadDefaultScene 仅服务端

event Action? OnCanLoadDefaultScene

Occurs when the default scene can be loaded.

备注

This event is triggered to signal that the conditions for loading the default scene have been met. Subscribers can use this event to initiate actions related to loading the default scene.

OnActorMoveStart 仅服务端

event Action<int, bool>? OnActorMoveStart

int => CoreActorId bool => isMoverMove

OnActorMoveEnd 仅服务端

event Action<int, bool>? OnActorMoveEnd

OnUserCloudDataProviderReady 仅服务端

event Action? OnUserCloudDataProviderReady

Occurs when the user cloud data provider is initialized and ready for use.

备注

Subscribe to this event to be notified when cloud data operations can safely begin. Handlers are invoked after the provider has completed any required setup.

IViewImageWidget 双端

命名空间 EngineInterface.GoInterface

public interface IViewImageWidget : IViewWidget

方法

SetImage 仅客户端

bool SetImage(UTF8String image)

IViewMover 双端

命名空间 EngineInterface.GoInterface

public interface IViewMover

属性

MoverIdLocal 双端

public int MoverIdLocal { get; }

方法

Destroy 双端

void Destroy()

事件

OnMoveComplete 双端

event Action? OnMoveComplete

OnMoveStop 双端

event Action? OnMoveStop

OnMoveImpact 双端

event Action<int>? OnMoveImpact

OnMoveCollide 双端

event Action? OnMoveCollide

IViewPlayer 双端

命名空间 EngineInterface.GoInterface

public interface IViewPlayer

属性

TeamId 仅客户端

public int TeamId { get; }

IsNeutral 双端

public bool IsNeutral { get; }

MainActorId 仅客户端

public int? MainActorId { get; }

Controller 双端

public ControllerType Controller { get; }

UserId 双端

public long UserId { get; }

Team 仅服务端

public IViewTeam Team { get; set; }

MainActor 仅服务端

public IViewActor? MainActor { get; set; }

方法

CreatePhysicsViewActor 双端

IViewActor? CreatePhysicsViewActor(int unitId, int playerId, int linkHash, int sceneHash, Vector3 position, Vector3 rotation, int componentMask)

CreateViewAsyncActorController 仅客户端

IViewAsyncActorController CreateViewAsyncActorController(int linkHash, bool skipBirth, int sceneHash)

GetUserName 仅客户端

UTF8String GetUserName(long userId)

GetSceneHash 双端

int GetSceneHash()

CreateViewActor 仅服务端

IViewActor? CreateViewActor(IScenePoint IScenePoint, int linkHash, float facing)

CreateCoreActor 仅服务端

ICoreActor CreateCoreActor(SyncType syncType)

SetShareSightTo 仅服务端

void SetShareSightTo(int otherPlayerId, bool on)

CanSee 仅服务端

bool CanSee(float x, float y, float z, int sceneHash)

SendClientMessage 仅服务端

bool SendClientMessage(int typeHash, ReadOnlySpan<byte> msg, bool guaranteed = false)

SwitchScene 仅服务端

bool SwitchScene(IViewScene scene, bool withMainUnit)

Kick 仅服务端

void Kick(string reason, string? clientMessage = null)

Disconnect 仅服务端

void Disconnect()

事件

OnTeamChanged 仅客户端

event Action<int>? OnTeamChanged

OnNeutralChanged 仅客户端

event Action<bool>? OnNeutralChanged

OnMainActorChanged 仅客户端

event Action<int?>? OnMainActorChanged

OnClientMessage 仅服务端

event Action<int, ReadOnlySpan<byte>>? OnClientMessage

OnConnected 仅服务端

event Action<bool>? OnConnected

Called when the player is connected bool => is Reconnect

OnDisconnected 仅服务端

event Action<int>? OnDisconnected

Called when the player is disconnected int=> disconnect reason

OnAbandonReconnect 仅服务端

event Action? OnAbandonReconnect

OnAfk 仅服务端

event Action? OnAfk

OnAfkEnd 仅服务端

event Action? OnAfkEnd

OnConnectionUnresponsive 仅服务端

event Action? OnConnectionUnresponsive

Called when the player's connection becomes temporarily unresponsive.

OnConnectionRestored 仅服务端

event Action? OnConnectionRestored

Called when a temporarily unresponsive connection becomes responsive again.

OnActivelyQuit 仅服务端

event Action? OnActivelyQuit

OnUnitVisibilityChange 仅服务端

event Action<int, bool>? OnUnitVisibilityChange

IViewScene 双端

命名空间 EngineInterface.GoInterface

public interface IViewScene

属性

Hash 双端

public int Hash { get; }

Size 双端

public Vector2 Size { get; }

ActorRootNodeHandle 双端

public ulong ActorRootNodeHandle { get; }

Cached 仅客户端

public bool Cached { get; }

Loaded 仅服务端

public bool Loaded { get; }

方法

SearchCircle 双端

int[]? SearchCircle(IScenePoint center, float radius)

SearchRectangle 双端

int[]? SearchRectangle(IScenePoint position, float facing, Vector2 size)

Search in a rectangle

• position —
• facing —
• size — X is width, Y is length

返回：

SearchCone 双端

int[]? SearchCone(IScenePoint position, float facing, float radius, float centralAngle)

EnsureStaticMeshColliders 双端

SceneColliderLoadResult EnsureStaticMeshColliders()

SetRenderEnvironment 仅客户端

void SetRenderEnvironment(bool enable)

TryUseSightMaskRenderPath 仅客户端

bool TryUseSightMaskRenderPath()

CacheLoad 仅客户端

bool CacheLoad()

CacheUnload 仅客户端

bool CacheUnload()

GetGroundHeight 仅客户端

float GetGroundHeight(float x, float y, float closestZ = 0f)

GetStaticCollisionMask 双端

StaticCollisionMask GetStaticCollisionMask(float x, float y, bool checkDynamicApplied)

Gets the static collision mask at a 2D scene position.

• x — Scene X coordinate.
• y — Scene Y coordinate.
• checkDynamicApplied — Whether to include runtime dynamic collision changes when supported.

返回： The collision mask at the requested scene position.

备注

Prefer Boolean) or ScenePoint.GetStaticCollisionMask when querying a 3D scene so the point height is preserved.

GetStaticCollisionMask 双端

StaticCollisionMask GetStaticCollisionMask(float x, float y, float z, bool checkDynamicApplied)

Gets the static collision mask at a 3D scene position.

• x — Scene X coordinate.
• y — Scene Y coordinate.
• z — Scene Z coordinate used by 3D navigation queries.
• checkDynamicApplied — Whether to include runtime dynamic collision changes when supported.

返回： The collision mask at the requested scene position.

备注

This overload is the preferred API for 3D scenes. The legacy 2D overload assumes z = 0, which can be wrong for terrain, ramps, walkable decorations, or multi-height navigation.

PathWayPoints 仅服务端

IEnumerable<IScenePoint>? PathWayPoints(IScenePoint start, IScenePoint end)

FindPlacementPoint 仅服务端

ScenePlacementPointResult FindPlacementPoint(IScenePoint center, float collisionRadius, float radius, bool ignoreUnit, out IScenePoint? point)

Load 仅服务端

bool Load()

Unload 仅服务端

bool Unload()

EnsureTerrainCollider 仅服务端

SceneColliderLoadResult EnsureTerrainCollider()

事件

OnLoaded 仅服务端

event Action? OnLoaded

IViewStatusBar 双端

命名空间 EngineInterface.GoInterface

public interface IViewStatusBar : IViewWidgetContainer

属性

LinkHash 仅客户端

public int LinkHash { get; }

事件

OnInitialized 仅客户端

event Action? OnInitialized

OnDestroyed 仅客户端

event Action? OnDestroyed

IViewStatusBarCustom 双端

命名空间 EngineInterface.GoInterface

public interface IViewStatusBarCustom : IViewWidgetContainer

方法

Destroy 仅客户端

void Destroy()

SetUIPosition 仅客户端

void SetUIPosition(Vector2 position2D)

SetWorldPosition 仅客户端

void SetWorldPosition(Vector3 position3D)

IViewTeam 双端

命名空间 EngineInterface.GoInterface

public interface IViewTeam

属性

TeamId 双端

public int TeamId { get; }

IViewTextWidget 双端

命名空间 EngineInterface.GoInterface

public interface IViewTextWidget : IViewWidget

方法

SetText 仅客户端

bool SetText(UTF8String text)

IViewWidget 双端

命名空间 EngineInterface.GoInterface

public interface IViewWidget

属性

IsValid 仅客户端

public bool IsValid { get; }

方法

SetVisible 仅客户端

bool SetVisible(bool visible)

SetColor 仅客户端

bool SetColor(Color color)

IViewWidgetContainer 双端

命名空间 EngineInterface.GoInterface

public interface IViewWidgetContainer

属性

IsValid 仅客户端

public bool IsValid { get; }

WidgetCount 仅客户端

public int WidgetCount { get; }

方法

GetWidgetHashByIndex 仅客户端

int GetWidgetHashByIndex(int index)

HasWidget 仅客户端

bool HasWidget(int widgetHash)

GetWidget 仅客户端

IViewWidget GetWidget(int widgetHash)

GetTextWidget 仅客户端

IViewTextWidget GetTextWidget(int widgetHash)

GetImageWidget 仅客户端

IViewImageWidget GetImageWidget(int widgetHash)

GetBarWidget 仅客户端

IViewBarWidget GetBarWidget(int widgetHash)

SceneColliderLoadResult 双端

命名空间 EngineInterface.GoInterface

public enum SceneColliderLoadResult

枚举值

• Loaded = 0
• AlreadyLoaded = 1
• UnsupportedSceneMode = -1
• SceneNotLoaded = -2
• SceneNotFound = -3
• FileNotFound = -4
• InvalidData = -5
• NativeError = -6

ScenePlacementPointResult 双端

命名空间 EngineInterface.GoInterface

public enum ScenePlacementPointResult

枚举值

• Found = 0
• SceneNotLoaded = -1
• SceneNotFound = -2
• InvalidQuery = -3
• NoWalkablePoint = -4
• NativeError = -5