diff --git a/Assets/Docs.meta b/Assets/Docs.meta deleted file mode 100644 index 9e4d32ee5..000000000 --- a/Assets/Docs.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: a69567c6357539246987285ebd889e38 -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects.meta b/Assets/Docs/objects.meta deleted file mode 100644 index 3193ecdf3..000000000 --- a/Assets/Docs/objects.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: 300045c5ad85b8e438efa7ac571148ab -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Character.md b/Assets/Docs/objects/Character.md deleted file mode 100644 index ccb712884..000000000 --- a/Assets/Docs/objects/Character.md +++ /dev/null @@ -1,105 +0,0 @@ -# Character -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../static/String.md)|False|Character's name.| -|Guild|[String](../static/String.md)|False|Character's guild.| -|Player|[Player](../objects/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../objects/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../objects/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../objects/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../objects/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../objects/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../objects/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../objects/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../objects/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../objects/Vector3.md)|False|The character's target direction.| -|Team|[String](../static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
GetKilled(killer : [String](../static/String.md))noneKills the character. Callable by non-owners.
GetDamaged(killer : [String](../static/String.md),damage : int)noneDamages the character and kills it if its health reaches 0. Callable by non-owners.
Emote(emote : [String](../static/String.md))noneCauses the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.
PlayAnimation(animation : [String](../static/String.md),fade : float = 0.1)noneCauses the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.
GetAnimationLength(animation : [String](../static/String.md))floatGets the length of animation.
PlaySound(sound : [String](../static/String.md))nonePlays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.
StopSound(sound : [String](../static/String.md))noneStops the sound.
LookAt(position : [Vector3](../objects/Vector3.md))noneRotates the character such that it is looking towards a world position.
AddForce(force : [Vector3](../objects/Vector3.md),mode : [String](../static/String.md) = Acceleration)noneAdds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.
Reveal(delay : float)noneReveaal the titan for a set number of seconds.
AddOutline(color : [Color](../objects/Color.md) = ,mode : [String](../static/String.md) = OutlineAll)noneAdds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor
RemoveOutline()noneRemoves the outline effect from the character.
diff --git a/Assets/Docs/objects/Character.md.meta b/Assets/Docs/objects/Character.md.meta deleted file mode 100644 index 8bd942bdb..000000000 --- a/Assets/Docs/objects/Character.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 6a3278747746c814fadec616961f33d3 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Collider.md b/Assets/Docs/objects/Collider.md deleted file mode 100644 index 48b9700b5..000000000 --- a/Assets/Docs/objects/Collider.md +++ /dev/null @@ -1,48 +0,0 @@ -# Collider -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|AttachedArticulationBody|[Transform](../objects/Transform.md)|False|| -|ContactOffset|float|False|| -|Enabled|bool|False|| -|ExludeLayers|int|False|| -|includeLayers|int|False|| -|IsTrigger|bool|False|| -|Center|[Vector3](../objects/Vector3.md)|False|| -|ProvidesContacts|bool|False|| -|MaterialName|[String](../static/String.md)|False|| -|SharedMaterialName|[String](../static/String.md)|False|| -|Transform|[Transform](../objects/Transform.md)|False|| -|GameObjectTransform|[Transform](../objects/Transform.md)|False|| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
ClosestPoint(position : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)
ClosestPointOnBounds(position : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)
Raycast(start : [Vector3](../objects/Vector3.md),end : [Vector3](../objects/Vector3.md),maxDistance : float,collideWith : [String](../static/String.md))[LineCastHitResult](../objects/LineCastHitResult.md)
diff --git a/Assets/Docs/objects/Collider.md.meta b/Assets/Docs/objects/Collider.md.meta deleted file mode 100644 index 59df789dc..000000000 --- a/Assets/Docs/objects/Collider.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 16db6184f4cef6f49a76cd5a7dbf4727 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Collision.md b/Assets/Docs/objects/Collision.md deleted file mode 100644 index 144bc2422..000000000 --- a/Assets/Docs/objects/Collision.md +++ /dev/null @@ -1,34 +0,0 @@ -# Collision -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Collider|[Collider](../objects/Collider.md)|False|| -|Impulse|[Vector3](../objects/Vector3.md)|False|| -|RelativeVelocity|[Vector3](../objects/Vector3.md)|False|| -## Methods - ---- - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
GetContact(index : int)none
GetContacts()none
diff --git a/Assets/Docs/objects/Collision.md.meta b/Assets/Docs/objects/Collision.md.meta deleted file mode 100644 index 5e13f7b58..000000000 --- a/Assets/Docs/objects/Collision.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 6b37bfd12c38cd3408725221b38a81a1 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Color.md b/Assets/Docs/objects/Color.md deleted file mode 100644 index 217e5e10c..000000000 --- a/Assets/Docs/objects/Color.md +++ /dev/null @@ -1,56 +0,0 @@ -# Color -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|R|int|False|Red component of the color| -|G|int|False|Green component of the color| -|B|int|False|Blue component of the color| -|A|int|False|Alpha component of the color| -## Methods - ---- - - - - - - - - - - - - - - -
FunctionReturnsDescription
ToHexString()[String](../static/String.md)Converts the color to a hex string
-## Static Methods - ---- - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Lerp(a : [Color](../objects/Color.md),b : [Color](../objects/Color.md),t : float)[Color](../objects/Color.md)Linearly interpolates between colors a and b by t
Gradient(a : [Color](../objects/Color.md),b : [Color](../objects/Color.md),t : float)[Color](../objects/Color.md)Creates a gradient color from two colors
diff --git a/Assets/Docs/objects/Color.md.meta b/Assets/Docs/objects/Color.md.meta deleted file mode 100644 index 1cb0312cc..000000000 --- a/Assets/Docs/objects/Color.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: bca17e22a2f35c74db74a9439e75c7ae -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Dict.md b/Assets/Docs/objects/Dict.md deleted file mode 100644 index 301395259..000000000 --- a/Assets/Docs/objects/Dict.md +++ /dev/null @@ -1,53 +0,0 @@ -# Dict -Inherits from object -## Initialization -```csharp -example = Dict() -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|False|Number of elements in the dictionary| -|Keys|[List](../objects/List.md)|False|Keys in the dictionary| -|Values|[List](../objects/List.md)|False|Values in the dictionary| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Clear()noneClears the dictionary
Get(key : Object,defaultValue : Object = )ObjectGets a value from the dictionary
Set(key : Object,value : Object)noneSets a value in the dictionary
Remove(key : Object)noneRemoves a value from the dictionary
Contains(key : Object)boolChecks if the dictionary contains a key
diff --git a/Assets/Docs/objects/Dict.md.meta b/Assets/Docs/objects/Dict.md.meta deleted file mode 100644 index 1275757c8..000000000 --- a/Assets/Docs/objects/Dict.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 4313e09b5cbefdd478ce030770190ae9 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Human.md b/Assets/Docs/objects/Human.md deleted file mode 100644 index 2728391a0..000000000 --- a/Assets/Docs/objects/Human.md +++ /dev/null @@ -1,194 +0,0 @@ -# Human -Inherits from [Character](../objects/Character.md) -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../static/String.md)|False|The human's name| -|Guild|[String](../static/String.md)|False|The human's guild| -|Weapon|[String](../static/String.md)|False|The weapon the human is using| -|CurrentSpecial|[String](../static/String.md)|False|The current special the human is using| -|SpecialCooldown|float|False|The cooldown of the special| -|ShifterLiveTime|float|False|The live time of the shifter special| -|SpecialCooldownRatio|float|False|The ratio of the special cooldown| -|CurrentGas|float|False|The current gas of the human| -|MaxGas|float|False|The max gas of the human| -|Acceleration|int|False|The acceleration of the human| -|Speed|int|False|The speed of the human| -|HorseSpeed|float|False|The speed of the horse| -|CurrentBladeDurability|float|False|The current blade durability| -|MaxBladeDurability|float|False|The max blade durability| -|CurrentBlade|int|False|The current blade| -|MaxBlade|int|False|The max number of blades held| -|CurrentAmmoRound|int|False|The current ammo round| -|MaxAmmoRound|int|False|The max ammo round| -|CurrentAmmoLeft|int|False|The current ammo left| -|MaxAmmoTotal|int|False|The max total ammo| -|LeftHookEnabled|bool|False|Whether the left hook is enabled| -|RightHookEnabled|bool|False|Whether the right hook is enabled| -|IsMounted|bool|False|Whether the human is mounted| -|MountedMapObject|[MapObject](../objects/MapObject.md)|False|The map object the human is mounted on| -|MountedTransform|[Transform](../objects/Transform.md)|False|The transform the human is mounted on| -|AutoRefillGas|bool|False|Whether the human auto refills gas| -|State|[String](../static/String.md)|False|The state of the human| -|CanDodge|bool|False|Whether the human can dodge| -|IsInvincible|bool|False|Whether the human is invincible| -|InvincibleTimeLeft|float|False|The time left for invincibility| -|IsCarried|bool|False|If the human is carried.| -|Player|[Player](../objects/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../objects/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../objects/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../objects/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../objects/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../objects/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../objects/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../objects/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../objects/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../objects/Vector3.md)|False|The character's target direction.| -|Team|[String](../static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Refill()boolRefills the gas of the human
RefillImmediate()noneRefills the gas of the human immediately
ClearHooks()noneClears all hooks
ClearLeftHook()noneClears the left hook
ClearRightHook()noneClears the right hook
MountMapObject(mapObject : [MapObject](../objects/MapObject.md),positionOffset : [Vector3](../objects/Vector3.md),rotationOffset : [Vector3](../objects/Vector3.md))noneMounts the human on a map object
MountTransform(transform : [Transform](../objects/Transform.md),positionOffset : [Vector3](../objects/Vector3.md),rotationOffset : [Vector3](../objects/Vector3.md))noneMounts the human on a transform
Unmount()noneUnmounts the human
SetSpecial(special : [String](../static/String.md))noneSets the special of the human
ActivateSpecial()noneActivates the special of the human
SetWeapon(weapon : [String](../static/String.md))noneSets the weapon of the human
DisablePerks()noneDisables all perks of the human
GetKilled(killer : [String](../static/String.md))noneKills the character. Callable by non-owners.
GetDamaged(killer : [String](../static/String.md),damage : int)noneDamages the character and kills it if its health reaches 0. Callable by non-owners.
Emote(emote : [String](../static/String.md))noneCauses the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.
PlayAnimation(animation : [String](../static/String.md),fade : float = 0.1)noneCauses the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.
GetAnimationLength(animation : [String](../static/String.md))floatGets the length of animation.
PlaySound(sound : [String](../static/String.md))nonePlays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.
StopSound(sound : [String](../static/String.md))noneStops the sound.
LookAt(position : [Vector3](../objects/Vector3.md))noneRotates the character such that it is looking towards a world position.
AddForce(force : [Vector3](../objects/Vector3.md),mode : [String](../static/String.md) = Acceleration)noneAdds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.
Reveal(delay : float)noneReveaal the titan for a set number of seconds.
AddOutline(color : [Color](../objects/Color.md) = ,mode : [String](../static/String.md) = OutlineAll)noneAdds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor
RemoveOutline()noneRemoves the outline effect from the character.
diff --git a/Assets/Docs/objects/Human.md.meta b/Assets/Docs/objects/Human.md.meta deleted file mode 100644 index 617ff881f..000000000 --- a/Assets/Docs/objects/Human.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: c057b9d36239b6945adc8451eaec206d -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/LineCastHitResult.md b/Assets/Docs/objects/LineCastHitResult.md deleted file mode 100644 index 940ae9a31..000000000 --- a/Assets/Docs/objects/LineCastHitResult.md +++ /dev/null @@ -1,11 +0,0 @@ -# LineCastHitResult -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsCharacter|bool|True|true if the linecast hit a character| -|IsMapObject|bool|True|true if the linecast hit a map object| -|Distance|float|True|The distance to the hit point| -|Point|[Vector3](../objects/Vector3.md)|True|The point in world space where the linecast hit| -|Normal|[Vector3](../objects/Vector3.md)|True|The normal of the surface the linecast hit| -|Collider|[Collider](../objects/Collider.md)|True|The collider that was hit| diff --git a/Assets/Docs/objects/LineCastHitResult.md.meta b/Assets/Docs/objects/LineCastHitResult.md.meta deleted file mode 100644 index 58a229db3..000000000 --- a/Assets/Docs/objects/LineCastHitResult.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7e5ee69bb1a91d64da1522a52e6dfa7c -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/LineRenderer.md b/Assets/Docs/objects/LineRenderer.md deleted file mode 100644 index 48ca4f345..000000000 --- a/Assets/Docs/objects/LineRenderer.md +++ /dev/null @@ -1,70 +0,0 @@ -# LineRenderer -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|StartWidth|float|False|The width of the line at the start| -|EndWidth|float|False|The width of the line at the end| -|LineColor|[Color](../objects/Color.md)|False|The color of the line| -|PositionCount|int|False|The number of points in the line| -|Enabled|bool|False|Is the line renderer enabled| -|Loop|bool|False|Is the line renderer a loop| -|NumCornerVertices|int|False|The number of corner vertices| -|NumCapVertices|int|False|The number of end cap vertices| -|Alignment|[String](../static/String.md)|False|The alignment of the line renderer| -|TextureMode|[String](../static/String.md)|False|The texture mode of the line renderer| -|UseWorldSpace|bool|False|Is the line renderer in world space| -|ShadowCastingMode|[String](../static/String.md)|False|Does the line renderer cast shadows| -|ReceiveShadows|bool|False|Does the line renderer receive shadows| -|ColorGradient|[List](../objects/List.md)|False|The gradient of the line renderer| -|AlphaGradient|[List](../objects/List.md)|False|The alpha gradient of the line renderer| -|WidthCurve|[List](../objects/List.md)|False|The width curve of the line renderer| -|WidthMultiplier|float|False|The width multiplier of the line renderer| -|ColorGradientMode|[String](../static/String.md)|False|The color gradient mode of the line renderer| -## Methods - ---- - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
GetPosition(index : int)[Vector3](../objects/Vector3.md)Get the position of a point in the line renderer
SetPosition(index : int,position : [Vector3](../objects/Vector3.md))noneSet the position of a point in the line renderer
-## Static Methods - ---- - - - - - - - - - - - - - - -
FunctionReturnsDescription
CreateLineRenderer()[LineRenderer](../objects/LineRenderer.md)[Obselete] Create a new LineRenderer
diff --git a/Assets/Docs/objects/LineRenderer.md.meta b/Assets/Docs/objects/LineRenderer.md.meta deleted file mode 100644 index d8dbc4824..000000000 --- a/Assets/Docs/objects/LineRenderer.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 8f8ac6475280ce24995a1fd86d91be69 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/List.md b/Assets/Docs/objects/List.md deleted file mode 100644 index 6b984f261..000000000 --- a/Assets/Docs/objects/List.md +++ /dev/null @@ -1,102 +0,0 @@ -# List -Inherits from object -## Initialization -```csharp -example = List() -example = List((CustomLogicSetBuiltin)) -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|True|The number of elements in the list| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Clear()noneClear all list elements
Get(index : int)ObjectGet the element at the specified index
Set(index : int,value : Object)noneSet the element at the specified index
Add(value : Object)noneAdd an element to the end of the list
InsertAt(index : int,value : Object)noneInsert an element at the specified index
RemoveAt(index : int)noneRemove the element at the specified index
Remove(value : Object)noneRemove the first occurrence of the specified element
Contains(value : Object)boolCheck if the list contains the specified element
Sort()noneSort the list
SortCustom(method : UserMethod)noneSort the list using a custom method, expects a method with the signature int method(a,b)
Filter(method : UserMethod)[List](../objects/List.md)Filter the list using a custom method, expects a method with the signature bool method(element)
Map(method : UserMethod)[List](../objects/List.md)Map the list using a custom method, expects a method with the signature object method(element)
Reduce(method : UserMethod,initialValue : Object)ObjectReduce the list using a custom method, expects a method with the signature object method(acc, element)
Randomize()noneRandomize the list
ToSet()[Set](../objects/Set.md)Convert the list to a set
diff --git a/Assets/Docs/objects/List.md.meta b/Assets/Docs/objects/List.md.meta deleted file mode 100644 index 98672b481..000000000 --- a/Assets/Docs/objects/List.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: c0032e789e5d3c7499f4d3ac614c6420 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/MapObject.md b/Assets/Docs/objects/MapObject.md deleted file mode 100644 index c0c711c52..000000000 --- a/Assets/Docs/objects/MapObject.md +++ /dev/null @@ -1,165 +0,0 @@ -# MapObject -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Static|bool|False|Object does not move| -|Position|[Vector3](../objects/Vector3.md)|False|The position of the object| -|LocalPosition|[Vector3](../objects/Vector3.md)|False|The local position of the object| -|Rotation|[Vector3](../objects/Vector3.md)|False|The rotation of the object| -|LocalRotation|[Vector3](../objects/Vector3.md)|False|The local rotation of the object| -|QuaternionRotation|[Quaternion](../objects/Quaternion.md)|False|The rotation of the object as a quaternion| -|QuaternionLocalRotation|[Quaternion](../objects/Quaternion.md)|False|The local rotation of the object as a quaternion| -|Forward|[Vector3](../objects/Vector3.md)|False|The forward direction of the object| -|Up|[Vector3](../objects/Vector3.md)|False|The up direction of the object| -|Right|[Vector3](../objects/Vector3.md)|False|The right direction of the object| -|Scale|[Vector3](../objects/Vector3.md)|False|The scale of the object| -|Name|[String](../static/String.md)|False|The name of the object| -|Parent|Object|False|The parent of the object| -|Active|bool|False|Whether the object is active| -|Transform|[Transform](../objects/Transform.md)|False|The transform of the object| -|HasRenderer|bool|False|Whether the object has a renderer| -|Color|[Color](../objects/Color.md)|False|The color of the object| -|TextureTilingX|float|False|The x tiling of the object's texture| -|TextureTilingY|float|False|The y tiling of the object's texture| -|TextureOffsetX|float|False|The x offset of the object's texture| -|TextureOffsetY|float|False|The y offset of the object's texture| -|ID|int|False|The ID of the object| -|Tag|[String](../static/String.md)|False|The tag of the object| -|Layer|int|False|The layer of the object| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
AddComponent(name : [String](../static/String.md))CustomLogicComponentInstanceAdd a component to the object
RemoveComponent(name : [String](../static/String.md))noneRemove a component from the object
GetComponent(name : [String](../static/String.md))CustomLogicComponentInstanceGet a component from the object
SetComponentEnabled(name : [String](../static/String.md),enabled : bool)noneSet whether a component is enabled
SetComponentsEnabled(enabled : bool)noneSet whether all components are enabled
AddSphereCollider(collideMode : [String](../static/String.md),collideWith : [String](../static/String.md),center : [Vector3](../objects/Vector3.md),radius : float)noneAdd a sphere collider to the object
AddBoxCollider(collideMode : [String](../static/String.md),collideWith : [String](../static/String.md),center : [Vector3](../objects/Vector3.md) = ,size : [Vector3](../objects/Vector3.md) = )noneAdd a box collider to the object
AddSphereTarget(team : [String](../static/String.md),center : [Vector3](../objects/Vector3.md),radius : float)[MapTargetable](../objects/MapTargetable.md)Add a sphere target to the object
AddBoxTarget(team : [String](../static/String.md),center : [Vector3](../objects/Vector3.md),size : [Vector3](../objects/Vector3.md))[MapTargetable](../objects/MapTargetable.md)Add a box target to the object
GetChild(name : [String](../static/String.md))[MapObject](../objects/MapObject.md)Get a child object by name
GetChildren()[List](../objects/List.md)Get all child objects
GetTransform(name : [String](../static/String.md))[Transform](../objects/Transform.md)Get a child transform by name
SetColorAll(color : [Color](../objects/Color.md))noneSet the color of all renderers on the object
InBounds(position : [Vector3](../objects/Vector3.md))boolCheck if a position is within the object's bounds
GetBoundsAverageCenter()[Vector3](../objects/Vector3.md)Get the bounds average center
GetBoundsCenter()[Vector3](../objects/Vector3.md)Get the bounds center
GetBoundsSize()[Vector3](../objects/Vector3.md)Get the bounds size
GetBoundsMin()[Vector3](../objects/Vector3.md)Get the bounds min
GetBoundsMax()[Vector3](../objects/Vector3.md)Get the bounds max
GetBoundsExtents()[Vector3](../objects/Vector3.md)Get the bounds extents
GetCorners()[List](../objects/List.md)Get the corners of the bounds
AddBuiltinComponent(parameter0 : Object = ,parameter1 : Object = ,parameter2 : Object = ,parameter3 : Object = ,parameter4 : Object = )none[OBSELETE] Add builtin component
ReadBuiltinComponent(name : [String](../static/String.md),param : [String](../static/String.md))Object[OBSELETE] Read a builtin component
UpdateBuiltinComponent(parameter0 : Object = ,parameter1 : Object = ,parameter2 : Object = ,parameter3 : Object = ,parameter4 : Object = )none[OBSELETE] Update a builtin component
diff --git a/Assets/Docs/objects/MapObject.md.meta b/Assets/Docs/objects/MapObject.md.meta deleted file mode 100644 index 3a712e8d7..000000000 --- a/Assets/Docs/objects/MapObject.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: e3a4854345f298443a242d9af9ac8e9e -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/MapTargetable.md b/Assets/Docs/objects/MapTargetable.md deleted file mode 100644 index e9ee0bf6d..000000000 --- a/Assets/Docs/objects/MapTargetable.md +++ /dev/null @@ -1,8 +0,0 @@ -# MapTargetable -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Team|[String](../static/String.md)|False|The team of the targetable| -|Position|[Vector3](../objects/Vector3.md)|False|The position of the targetable| -|Enabled|bool|False|Is the targetable enabled| diff --git a/Assets/Docs/objects/MapTargetable.md.meta b/Assets/Docs/objects/MapTargetable.md.meta deleted file mode 100644 index 3b0ee27ef..000000000 --- a/Assets/Docs/objects/MapTargetable.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7ccfe181a650e4240a89586f30477bf7 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/NetworkView.md b/Assets/Docs/objects/NetworkView.md deleted file mode 100644 index 294882f69..000000000 --- a/Assets/Docs/objects/NetworkView.md +++ /dev/null @@ -1,52 +0,0 @@ -# NetworkView -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Owner|[Player](../objects/Player.md)|False|The network view's owner.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Transfer(player : [Player](../objects/Player.md))noneOwner only. Transfer ownership of this NetworkView to another player.
SendMessage(target : [Player](../objects/Player.md),msg : [String](../static/String.md))noneSend a message to a target player. This will be received in any of the MapObject attached components through the OnNetworkMessage callback.
SendMessageAll(msg : [String](../static/String.md))noneSend a message to all players including myself.
SendMessageOthers(msg : [String](../static/String.md))noneSend a message to players excluding myself.
SendStream(obj : Object)noneSend an object to the network sync stream. This represents sending data from the object owner to all non-owner observers, and should only be called in the SendNetworkStream callback in the attached component. It only works with some object types: primitives and Vector3.
ReceiveStream()ObjectReceive an object through the network sync stream. This represents receiving data from the object owner as a non-owner observer, and should only be called in the OnNetworkStream callback.
diff --git a/Assets/Docs/objects/NetworkView.md.meta b/Assets/Docs/objects/NetworkView.md.meta deleted file mode 100644 index 03ab175cf..000000000 --- a/Assets/Docs/objects/NetworkView.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 5210f64a30e529c4bba76bd1fe982c68 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Physics.md b/Assets/Docs/objects/Physics.md deleted file mode 100644 index ff78ab0ca..000000000 --- a/Assets/Docs/objects/Physics.md +++ /dev/null @@ -1,28 +0,0 @@ -# Physics -Inherits from object -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
LineCast(start : [Vector3](../objects/Vector3.md),end : [Vector3](../objects/Vector3.md),collideWith : [String](../static/String.md))ObjectPerforms a line cast between two points.
SphereCast(start : [Vector3](../objects/Vector3.md),end : [Vector3](../objects/Vector3.md),radius : float,collideWith : [String](../static/String.md))ObjectPerforms a sphere cast between two points.
diff --git a/Assets/Docs/objects/Physics.md.meta b/Assets/Docs/objects/Physics.md.meta deleted file mode 100644 index 5373b44f1..000000000 --- a/Assets/Docs/objects/Physics.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7232282bfe0c42a49a0611ba9f367e4b -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Player.md b/Assets/Docs/objects/Player.md deleted file mode 100644 index d619b8156..000000000 --- a/Assets/Docs/objects/Player.md +++ /dev/null @@ -1,52 +0,0 @@ -# Player -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Character|[Character](../objects/Character.md)|False|Player's current character, if alive.| -|Connected|bool|False|Player is still connected to the room.| -|ID|int|False|Player unique ID.| -|Name|[String](../static/String.md)|False|Player name.| -|Guild|[String](../static/String.md)|False|Player guild.| -|Team|[String](../static/String.md)|False|Player's chosen team ("None", "Blue", "Red", "Titan", "Human"). Note that this may be different from the character's final team (Character.Team field) if the character's team field is modified.| -|Status|[String](../static/String.md)|False|Player's spawn status ("Alive", "Dead", "Spectating").| -|CharacterType|[String](../static/String.md)|False|Player's chosen character ("Human", "Titan", "Shifter")| -|Loadout|[String](../static/String.md)|False|Player's chosen loadout ("Blades", "AHSS", "APG", "Thunderspears").| -|Kills|int|False|Player's kills.| -|Deaths|int|False|Player's deaths.| -|HighestDamage|int|False|Player's highest damage.| -|TotalDamage|int|False|Player's total damage.| -|Ping|int|False|The player's connection ping.| -|SpectateID|int|False|The player's spectating ID. If not spectating anyone, returns -1.| -|SpawnPoint|[Vector3](../objects/Vector3.md)|False|Player's respawn point. Is initially null and can be set back to null, at which point map spawn points are used.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
GetCustomProperty(property : [String](../static/String.md))ObjectGet a custom property at given key. Must be a primitive type. This is synced to all clients.
SetCustomProperty(property : [String](../static/String.md),value : Object)noneSets a custom property at given key. Must be a primitive type. This is synced to all clients.
ClearKDR()noneClears kills, deaths, highestdamage, and totaldamage properties.
diff --git a/Assets/Docs/objects/Player.md.meta b/Assets/Docs/objects/Player.md.meta deleted file mode 100644 index c38788cbb..000000000 --- a/Assets/Docs/objects/Player.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 36022b2b77991754a9a2a4f125f52f49 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Quaternion.md b/Assets/Docs/objects/Quaternion.md deleted file mode 100644 index f15674e7e..000000000 --- a/Assets/Docs/objects/Quaternion.md +++ /dev/null @@ -1,126 +0,0 @@ -# Quaternion -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|X|float|False|X component of the Quaternion. Don't modify this directly unless you know quaternions inside out.| -|Y|float|False|Y component of the Quaternion. Don't modify this directly unless you know quaternions inside out.| -|Z|float|False|Z component of the Quaternion. Don't modify this directly unless you know quaternions inside out.| -|W|float|False|W component of the Quaternion. Do not directly modify quaternions.| -|Euler|[Vector3](../objects/Vector3.md)|False|Returns or sets the euler angle representation of the rotation.| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Identity|[Quaternion](../objects/Quaternion.md)|False|The identity rotation (Read Only).| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
\_\_Copy\_\_()ObjectOverride to deepcopy object on assignment, used for structs. Ex: copy = original is equivalent to copy = original.\_\_Copy\_\_()
\_\_Add\_\_(self : Object,other : Object)ObjectOverride to implement addition, used for + operator. Ex: a + b is equivalent to a.\_\_Add\_\_(a, b)
\_\_Sub\_\_(self : Object,other : Object)ObjectOverride to implement subtraction, used for - operator. Ex: a - b is equivalent to a.\_\_Sub\_\_(a, b)
\_\_Mul\_\_(self : Object,other : Object)ObjectOverride to implement multiplication, used for * operator. Ex: a * b is equivalent to a.\_\_Mul\_\_(a, b)
\_\_Div\_\_(self : Object,other : Object)ObjectOverride to implement division, used for / operator. Ex: a / b is equivalent to a.\_\_Div\_\_(a, b)
\_\_Eq\_\_(self : Object,other : Object)boolOverride to implement equality comparison, used for == and != operators. Ex: a == b is equivalent to a.\_\_Eq\_\_(a, b)
\_\_Hash\_\_()intOverride to implement hashing, used for GetHashCode - Used for Dictionaries/Sets. Ex: hash = obj.GetHashCode() is equivalent to hash = obj.\_\_Hash\_\_()
-## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Lerp(a : [Quaternion](../objects/Quaternion.md),b : [Quaternion](../objects/Quaternion.md),t : float)[Quaternion](../objects/Quaternion.md)Interpolates between a and b by t and normalizes the result afterwards.
LerpUnclamped(a : [Quaternion](../objects/Quaternion.md),b : [Quaternion](../objects/Quaternion.md),t : float)[Quaternion](../objects/Quaternion.md)Interpolates between a and b by t and normalizes the result afterwards. The parameter t is not clamped.
Slerp(a : [Quaternion](../objects/Quaternion.md),b : [Quaternion](../objects/Quaternion.md),t : float)[Quaternion](../objects/Quaternion.md)Spherically linear interpolates between unit quaternions a and b by a ratio of t.
SlerpUnclamped(a : [Quaternion](../objects/Quaternion.md),b : [Quaternion](../objects/Quaternion.md),t : float)[Quaternion](../objects/Quaternion.md)Spherically linear interpolates between unit quaternions a and b by t.
FromEuler(euler : [Vector3](../objects/Vector3.md))[Quaternion](../objects/Quaternion.md)Returns the Quaternion rotation from the given euler angles.
LookRotation(forward : [Vector3](../objects/Vector3.md),upwards : [Vector3](../objects/Vector3.md) = )[Quaternion](../objects/Quaternion.md)Creates a rotation with the specified forward and upwards directions.
FromToRotation(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Quaternion](../objects/Quaternion.md)Creates a rotation from fromDirection to toDirection.
Inverse(q : [Quaternion](../objects/Quaternion.md))[Quaternion](../objects/Quaternion.md)Returns the Inverse of rotation.
RotateTowards(from : [Quaternion](../objects/Quaternion.md),to : [Quaternion](../objects/Quaternion.md),maxDegreesDelta : float)[Quaternion](../objects/Quaternion.md)Rotates a rotation from towards to.
diff --git a/Assets/Docs/objects/Quaternion.md.meta b/Assets/Docs/objects/Quaternion.md.meta deleted file mode 100644 index cbceea674..000000000 --- a/Assets/Docs/objects/Quaternion.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 9ec4566cf2d450b488b0801c67ca2296 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/README.md b/Assets/Docs/objects/README.md deleted file mode 100644 index db71f7e72..000000000 --- a/Assets/Docs/objects/README.md +++ /dev/null @@ -1 +0,0 @@ -# Objects \ No newline at end of file diff --git a/Assets/Docs/objects/README.md.meta b/Assets/Docs/objects/README.md.meta deleted file mode 100644 index e322b1317..000000000 --- a/Assets/Docs/objects/README.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 4abbeb9d654abf4458052c628f921e05 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Range.md b/Assets/Docs/objects/Range.md deleted file mode 100644 index 9dd537b51..000000000 --- a/Assets/Docs/objects/Range.md +++ /dev/null @@ -1,100 +0,0 @@ -# Range -## Initialization -```csharp -example = Range((Object[])) -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|True|The number of elements in the list| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Clear()noneClear all list elements
Get(index : int)ObjectGet the element at the specified index
Set(index : int,value : Object)noneSet the element at the specified index
Add(value : Object)noneAdd an element to the end of the list
InsertAt(index : int,value : Object)noneInsert an element at the specified index
RemoveAt(index : int)noneRemove the element at the specified index
Remove(value : Object)noneRemove the first occurrence of the specified element
Contains(value : Object)boolCheck if the list contains the specified element
Sort()noneSort the list
SortCustom(method : UserMethod)noneSort the list using a custom method, expects a method with the signature int method(a,b)
Filter(method : UserMethod)[List](../objects/List.md)Filter the list using a custom method, expects a method with the signature bool method(element)
Map(method : UserMethod)[List](../objects/List.md)Map the list using a custom method, expects a method with the signature object method(element)
Reduce(method : UserMethod,initialValue : Object)ObjectReduce the list using a custom method, expects a method with the signature object method(acc, element)
Randomize()noneRandomize the list
ToSet()[Set](../objects/Set.md)Convert the list to a set
diff --git a/Assets/Docs/objects/Range.md.meta b/Assets/Docs/objects/Range.md.meta deleted file mode 100644 index 2951d5aeb..000000000 --- a/Assets/Docs/objects/Range.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 403a4b6334147554c9d9ee83fd5273b0 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Set.md b/Assets/Docs/objects/Set.md deleted file mode 100644 index 60b61bd52..000000000 --- a/Assets/Docs/objects/Set.md +++ /dev/null @@ -1,97 +0,0 @@ -# Set -Inherits from object -## Initialization -```csharp -example = Set() -example = Set((CustomLogicListBuiltin)) -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Count|int|True|The number of elements in the set| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Clear()noneClear all set elements
Contains(value : Object)boolCheck if the set contains the specified element
Add(value : Object)noneAdd an element to the set
Remove(value : Object)noneRemove the element from the set
Union(set : [Set](../objects/Set.md))noneUnion with another set
Intersect(set : [Set](../objects/Set.md))noneIntersect with another set
Difference(set : [Set](../objects/Set.md))noneDifference with another set
IsSubsetOf(set : [Set](../objects/Set.md))boolCheck if the set is a subset of another set
IsSupersetOf(set : [Set](../objects/Set.md))boolCheck if the set is a superset of another set
IsProperSubsetOf(set : [Set](../objects/Set.md))boolCheck if the set is a proper subset of another set
IsProperSupersetOf(set : [Set](../objects/Set.md))boolCheck if the set is a proper superset of another set
Overlaps(set : [Set](../objects/Set.md))boolCheck if the set overlaps with another set
SetEquals(set : [Set](../objects/Set.md))boolCheck if the set has the same elements as another set
ToList()[List](../objects/List.md)Convert the set to a list
diff --git a/Assets/Docs/objects/Set.md.meta b/Assets/Docs/objects/Set.md.meta deleted file mode 100644 index 080516b1a..000000000 --- a/Assets/Docs/objects/Set.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 9abf9500dbc392f4b9fcd13c0d369e7a -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Shifter.md b/Assets/Docs/objects/Shifter.md deleted file mode 100644 index 0efb4b42c..000000000 --- a/Assets/Docs/objects/Shifter.md +++ /dev/null @@ -1,155 +0,0 @@ -# Shifter -Inherits from [Character](../objects/Character.md) -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../static/String.md)|False|Shifter's name.| -|Guild|[String](../static/String.md)|False|Shifter's guild.| -|Size|float|False|Shifter's size.| -|RunSpeedBase|float|False|Shifter's base run speed. Final run speed is RunSpeedBase + Size * RunSpeedPerLevel.| -|WalkSpeedBase|float|False|Shifter's base walk speed. Final walk speed is WalkSpeedBase + Size * WalkSpeedPerLevel.| -|WalkSpeedPerLevel|float|False|Shifter's walk speed added per level.| -|RunSpeedPerLevel|float|False|Shifter's run speed added per level.| -|TurnSpeed|float|False|Shifter's turn speed when running turn animation.| -|RotateSpeed|float|False|Shifter's rotate speed when rotating body.| -|JumpForce|float|False|Shifter's jump force when jumping.| -|ActionPause|float|False|Shifter's pause delay after performing an action.| -|AttackPause|float|False|Shifter's pause delay after performing an attack.| -|TurnPause|float|False|Shifter's pause delay after performing a turn.| -|DetectRange|float|False|(AI) shifter's detect range.| -|FocusRange|float|False|(AI) shifter's focus range.| -|FocusTime|float|False|(AI) shifter's focus time before switching targets.| -|FarAttackCooldown|float|False|(AI) Shifter's cooldown after performing a ranged attack.| -|AttackWait|float|False|(AI) Shifter's wait time between being in range to attack and performing the attack.| -|AttackSpeedMultiplier|float|False|Shifter's attack animation speed.| -|UsePathfinding|bool|False|(AI) Shifter uses pathfinding.| -|NapePosition|[Vector3](../objects/Vector3.md)|False|The shifter's nape position.| -|DeathAnimLength|float|False|The length of the death animation.| -|Player|[Player](../objects/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../objects/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../objects/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../objects/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../objects/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../objects/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../objects/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../objects/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../objects/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../objects/Vector3.md)|False|The character's target direction.| -|Team|[String](../static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
MoveTo(position : [Vector3](../objects/Vector3.md),range : float,ignoreEnemies : bool)noneCauses the (AI) shifter to move towards a position. If ignoreEnemies is true, will not engage enemies along the way.
Target(enemyObj : Object,focus : float)noneCauses the (AI) shifter to target an enemy character or MapTargetable for focusTime seconds. If focusTime is 0 it will use the default focus time.
Idle(time : float)noneCauses the (AI) shifter to idle for time seconds before beginning to wander. During idle the titan will not react or move at all.
Wander()noneCauses the (AI) shifter to cancel any move commands and begin wandering randomly.
Blind()noneCauses the shifter to enter the blind state.
Cripple(time : float)noneCauses the shifter to enter the cripple state.
GetKilled(killer : [String](../static/String.md))noneKills the character. Callable by non-owners.
GetDamaged(killer : [String](../static/String.md),damage : int)noneDamages the character and kills it if its health reaches 0. Callable by non-owners.
Emote(emote : [String](../static/String.md))noneCauses the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.
PlayAnimation(animation : [String](../static/String.md),fade : float = 0.1)noneCauses the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.
GetAnimationLength(animation : [String](../static/String.md))floatGets the length of animation.
PlaySound(sound : [String](../static/String.md))nonePlays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.
StopSound(sound : [String](../static/String.md))noneStops the sound.
LookAt(position : [Vector3](../objects/Vector3.md))noneRotates the character such that it is looking towards a world position.
AddForce(force : [Vector3](../objects/Vector3.md),mode : [String](../static/String.md) = Acceleration)noneAdds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.
Reveal(delay : float)noneReveaal the titan for a set number of seconds.
AddOutline(color : [Color](../objects/Color.md) = ,mode : [String](../static/String.md) = OutlineAll)noneAdds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor
RemoveOutline()noneRemoves the outline effect from the character.
diff --git a/Assets/Docs/objects/Shifter.md.meta b/Assets/Docs/objects/Shifter.md.meta deleted file mode 100644 index 82d9e04f4..000000000 --- a/Assets/Docs/objects/Shifter.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 021567c0c7945da478e83e6ca79f06a8 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Titan.md b/Assets/Docs/objects/Titan.md deleted file mode 100644 index d5ee2add0..000000000 --- a/Assets/Docs/objects/Titan.md +++ /dev/null @@ -1,160 +0,0 @@ -# Titan -Inherits from [Character](../objects/Character.md) -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Name|[String](../static/String.md)|False|Titans's name.| -|Guild|[String](../static/String.md)|False|Titans's guild.| -|Size|float|False|Titan's size.| -|RunSpeedBase|float|False|Titan's base run speed. Final run speed is RunSpeedBase + Size * RunSpeedPerLevel.| -|WalkSpeedBase|float|False|Titan's base walk speed. Final walk speed is WalkSpeedBase + Size * WalkSpeedPerLevel.| -|WalkSpeedPerLevel|float|False|Titan's walk speed added per size.| -|RunSpeedPerLevel|float|False|Titan's run speed added per size.| -|TurnSpeed|float|False|Titan's turn animation speed.| -|RotateSpeed|float|False|Titan's rotate speed.| -|JumpForce|float|False|Titan's jump force.| -|ActionPause|float|False|Titan's pause delay after performing an action.| -|AttackPause|float|False|Titan's pause delay after performing an attack.| -|TurnPause|float|False|Titan's pause delay after performing a turn.| -|Stamina|float|False|PT stamina.| -|MaxStamina|float|False|PT max stamina.| -|NapePosition|[Vector3](../objects/Vector3.md)|False|The titan's nape position.| -|IsCrawler|bool|False|Is titan a crawler.| -|DetectRange|float|False|(AI) titan's detect range.| -|FocusRange|float|False|(AI) titan's focus range.| -|FocusTime|float|False|(AI) titan's focus time.| -|FarAttackCooldown|float|False|(AI) Titan's cooldown after performing a ranged attack.| -|AttackWait|float|False|(AI) Titan's wait time between being in range and performing an attack.| -|CanRun|bool|False|(AI) Titan can run or only walk.| -|AttackSpeedMultiplier|float|False|Titan's attack animation speed.| -|UsePathfinding|bool|False|Determines whether the (AI) titan uses pathfinding. (Smart Movement in titan settings)| -|HeadMount|[Transform](../objects/Transform.md)|False|Titan's head transform.| -|NeckMount|[Transform](../objects/Transform.md)|False|Titan's neck transform.| -|Player|[Player](../objects/Player.md)|False|Player who owns this character.| -|IsAI|bool|False|Is this character AI?| -|ViewID|int|False|Network view ID of the character.| -|IsMine|bool|False|Is this character mine?| -|IsMainCharacter|bool|False|| -|Transform|[Transform](../objects/Transform.md)|False|Unity transform of the character.| -|Position|[Vector3](../objects/Vector3.md)|False|Position of the character.| -|Rotation|[Vector3](../objects/Vector3.md)|False|Rotation of the character.| -|QuaternionRotation|[Quaternion](../objects/Quaternion.md)|False|Quaternion rotation of the character.| -|Velocity|[Vector3](../objects/Vector3.md)|False|Velocity of the character.| -|Forward|[Vector3](../objects/Vector3.md)|False|Forward direction of the character.| -|Right|[Vector3](../objects/Vector3.md)|False|Right direction of the character.| -|Up|[Vector3](../objects/Vector3.md)|False|Up direction of the character.| -|HasTargetDirection|bool|False|If the character has a target direction it is turning towards.| -|TargetDirection|[Vector3](../objects/Vector3.md)|False|The character's target direction.| -|Team|[String](../static/String.md)|False|Team character belongs to.| -|Health|float|False|Character's current health.| -|MaxHealth|float|False|Character's maximum health.| -|CustomDamageEnabled|bool|False|Is custom damage dealing enabled.| -|CustomDamage|int|False|Amount of custom damage to deal per attack.| -|CurrentAnimation|[String](../static/String.md)|False|Character's current playing animation.| -|Grounded|bool|False|Character's grounded status.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
MoveTo(position : [Vector3](../objects/Vector3.md),range : float,ignoreEnemies : bool)noneCauses the (AI) titan to move towards a position and stopping when within specified range. If ignoreEnemies is true, will not engage enemies along the way.
Target(enemyObj : Object,focus : float)noneCauses the (AI) titan to target an enemy character or MapTargetable for focusTime seconds. If focusTime is 0 it will use the default focus time
Idle(time : float)noneCauses the (AI) titan to idle for time seconds before beginning to wander. During idle the titan will not react or move at all.
Wander()noneCauses the (AI) titan to cancel any move commands and begin wandering randomly.
Blind()noneCauses the titan to enter the blind state.
Cripple(time : float)noneCauses the titan to enter the cripple state for time seconds. Using 0 will use the default cripple time.
GetKilled(killer : [String](../static/String.md))noneKills the character. Callable by non-owners.
GetDamaged(killer : [String](../static/String.md),damage : int)noneDamages the character and kills it if its health reaches 0. Callable by non-owners.
Emote(emote : [String](../static/String.md))noneCauses the character to emote. The list of available emotes is the same as those shown in the in-game emote menu.
PlayAnimation(animation : [String](../static/String.md),fade : float = 0.1)noneCauses the character to play an animation. If the fade parameter is provided, will crossfade the animation by this timestep. Available animations can be found here: Human, Titan, Annie, Eren. Use the right-hand string value for the animation.
GetAnimationLength(animation : [String](../static/String.md))floatGets the length of animation.
PlaySound(sound : [String](../static/String.md))nonePlays a sound if present in the character. Available sound names can be found here: Humans, Shifters, Titans. Note that shifters also have all titan sounds.
StopSound(sound : [String](../static/String.md))noneStops the sound.
LookAt(position : [Vector3](../objects/Vector3.md))noneRotates the character such that it is looking towards a world position.
AddForce(force : [Vector3](../objects/Vector3.md),mode : [String](../static/String.md) = Acceleration)noneAdds a force to the character with given force vector and optional mode. Valid modes are Force, Acceleration, Impulse, VelocityChange with default being Acceleration.
Reveal(delay : float)noneReveaal the titan for a set number of seconds.
AddOutline(color : [Color](../objects/Color.md) = ,mode : [String](../static/String.md) = OutlineAll)noneAdds an outline effect with the given color and mode. Valid modes are: OutlineAll, OutlineVisible, OutlineHidden, OutlineAndSilhouette, SilhouetteOnly, OutlineAndLightenColor
RemoveOutline()noneRemoves the outline effect from the character.
diff --git a/Assets/Docs/objects/Titan.md.meta b/Assets/Docs/objects/Titan.md.meta deleted file mode 100644 index 4fe7f9fec..000000000 --- a/Assets/Docs/objects/Titan.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 10c9a3e11d53e4a45895267b60ac41aa -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Transform.md b/Assets/Docs/objects/Transform.md deleted file mode 100644 index 31591edd8..000000000 --- a/Assets/Docs/objects/Transform.md +++ /dev/null @@ -1,109 +0,0 @@ -# Transform -Inherits from object -## Initialization -```csharp -``` -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Position|[Vector3](../objects/Vector3.md)|False|Gets or sets the position of the transform.| -|LocalPosition|[Vector3](../objects/Vector3.md)|False|Gets or sets the local position of the transform.| -|Rotation|[Vector3](../objects/Vector3.md)|False|Gets or sets the rotation of the transform.| -|LocalRotation|[Vector3](../objects/Vector3.md)|False|Gets or sets the local rotation of the transform.| -|QuaternionRotation|[Quaternion](../objects/Quaternion.md)|False|Gets or sets the quaternion rotation of the transform.| -|QuaternionLocalRotation|[Quaternion](../objects/Quaternion.md)|False|Gets or sets the quaternion local rotation of the transform.| -|Scale|[Vector3](../objects/Vector3.md)|False|Gets or sets the scale of the transform.| -|Forward|[Vector3](../objects/Vector3.md)|False|Gets the forward vector of the transform.| -|Up|[Vector3](../objects/Vector3.md)|False|Gets the up vector of the transform.| -|Right|[Vector3](../objects/Vector3.md)|False|Gets the right vector of the transform.| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
GetTransform(name : [String](../static/String.md))[Transform](../objects/Transform.md)Gets the transform of the specified child.
GetTransforms()[List](../objects/List.md)Gets all child transforms.
PlayAnimation(anim : [String](../static/String.md),fade : float = 0.1)nonePlays the specified animation.
GetAnimationLength(anim : [String](../static/String.md))floatGets the length of the specified animation.
PlaySound()nonePlays the sound.
StopSound()noneStops the sound.
ToggleParticle(enabled : bool)noneToggles the particle system.
InverseTransformDirection(direction : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Transforms a direction from world space to local space. The opposite of Transform.TransformDirection.
InverseTransformPoint(point : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Transforms position from world space to local space.
TransformDirection(direction : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Transforms direction from local space to world space.
TransformPoint(point : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Transforms position from local space to world space.
Rotate(rotation : [Vector3](../objects/Vector3.md))noneApplies a rotation of eulerAngles.z degrees around the z-axis, eulerAngles.x degrees around the x-axis, and eulerAngles.y degrees around the y-axis (in that order).
RotateAround(point : [Vector3](../objects/Vector3.md),axis : [Vector3](../objects/Vector3.md),angle : float)noneRotates the transform about axis passing through point in world coordinates by angle degrees.
LookAt(target : [Vector3](../objects/Vector3.md))noneRotates the transform so the forward vector points at worldPosition.
SetRenderersEnabled(enabled : bool)noneSets the enabled state of all child renderers.
diff --git a/Assets/Docs/objects/Transform.md.meta b/Assets/Docs/objects/Transform.md.meta deleted file mode 100644 index f34167c7e..000000000 --- a/Assets/Docs/objects/Transform.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: e6f444199675f834cac8937bac0152fe -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Vector2.md b/Assets/Docs/objects/Vector2.md deleted file mode 100644 index 2fb15871b..000000000 --- a/Assets/Docs/objects/Vector2.md +++ /dev/null @@ -1,158 +0,0 @@ -# Vector2 -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|X|float|False|X component of the vector.| -|Y|float|False|Y component of the vector.| -|Normalized|[Vector2](../objects/Vector2.md)|False|Returns this vector with a magnitude of 1 (Read Only).| -|Magnitude|float|False|Returns the length of this vector (Read Only).| -|SqrMagnitude|float|False|Returns the squared length of this vector (Read Only).| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Zero|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(0, 0).| -|One|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(1, 1).| -|Up|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(0, 1).| -|Down|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(0, -1).| -|Left|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(-1, 0).| -|Right|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(1, 0).| -|NegativeInfinity|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(float.PositiveInfinity, float.PositiveInfinity).| -|PositiveInfinity|[Vector2](../objects/Vector2.md)|False|Shorthand for writing Vector2(float.PositiveInfinity, float.PositiveInfinity).| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Set(x : float,y : float)noneSet x and y components of an existing Vector2.
Normalize()noneMakes this vector have a magnitude of 1.
\_\_Copy\_\_()ObjectOverride to deepcopy object on assignment, used for structs. Ex: copy = original is equivalent to copy = original.\_\_Copy\_\_()
\_\_Add\_\_(self : Object,other : Object)ObjectOverride to implement addition, used for + operator. Ex: a + b is equivalent to a.\_\_Add\_\_(a, b)
\_\_Sub\_\_(self : Object,other : Object)ObjectOverride to implement subtraction, used for - operator. Ex: a - b is equivalent to a.\_\_Sub\_\_(a, b)
\_\_Mul\_\_(self : Object,other : Object)ObjectOverride to implement multiplication, used for * operator. Ex: a * b is equivalent to a.\_\_Mul\_\_(a, b)
\_\_Div\_\_(self : Object,other : Object)ObjectOverride to implement division, used for / operator. Ex: a / b is equivalent to a.\_\_Div\_\_(a, b)
\_\_Eq\_\_(self : Object,other : Object)boolOverride to implement equality comparison, used for == and != operators. Ex: a == b is equivalent to a.\_\_Eq\_\_(a, b)
\_\_Hash\_\_()intOverride to implement hashing, used for GetHashCode - Used for Dictionaries/Sets. Ex: hash = obj.GetHashCode() is equivalent to hash = obj.\_\_Hash\_\_()
-## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Angle(from : [Vector2](../objects/Vector2.md),to : [Vector2](../objects/Vector2.md))floatGets the unsigned angle in degrees between from and to.
ClampMagnitude(vector : [Vector2](../objects/Vector2.md),maxLength : float)[Vector2](../objects/Vector2.md)Returns a copy of vector with its magnitude clamped to maxLength.
Distance(a : [Vector2](../objects/Vector2.md),b : [Vector2](../objects/Vector2.md))floatReturns the distance between a and b.
Dot(a : [Vector2](../objects/Vector2.md),b : [Vector2](../objects/Vector2.md))floatDot Product of two vectors.
Lerp(a : [Vector2](../objects/Vector2.md),b : [Vector2](../objects/Vector2.md),t : float)[Vector2](../objects/Vector2.md)Linearly interpolates between vectors a and b by t.
LerpUnclamped(a : [Vector2](../objects/Vector2.md),b : [Vector2](../objects/Vector2.md),t : float)[Vector2](../objects/Vector2.md)Linearly interpolates between vectors a and b by t.
Max(a : [Vector2](../objects/Vector2.md),b : [Vector2](../objects/Vector2.md))[Vector2](../objects/Vector2.md)Returns a vector that is made from the largest components of two vectors.
Min(a : [Vector2](../objects/Vector2.md),b : [Vector2](../objects/Vector2.md))[Vector2](../objects/Vector2.md)Returns a vector that is made from the smallest components of two vectors.
MoveTowards(current : [Vector2](../objects/Vector2.md),target : [Vector2](../objects/Vector2.md),maxDistanceDelta : float)[Vector2](../objects/Vector2.md)Moves a point current towards target.
Reflect(inDirection : [Vector2](../objects/Vector2.md),inNormal : [Vector2](../objects/Vector2.md))[Vector2](../objects/Vector2.md)Reflects a vector off the vector defined by a normal.
SignedAngle(from : [Vector2](../objects/Vector2.md),to : [Vector2](../objects/Vector2.md))floatGets the signed angle in degrees between from and to.
SmoothDamp(current : [Vector2](../objects/Vector2.md),target : [Vector2](../objects/Vector2.md),currentVelocity : [Vector2](../objects/Vector2.md),smoothTime : float,maxSpeed : float)[Vector2](../objects/Vector2.md)
diff --git a/Assets/Docs/objects/Vector2.md.meta b/Assets/Docs/objects/Vector2.md.meta deleted file mode 100644 index 041b4c1a7..000000000 --- a/Assets/Docs/objects/Vector2.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: be70e158aba1f194692f967ec2d19055 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/objects/Vector3.md b/Assets/Docs/objects/Vector3.md deleted file mode 100644 index 78c88198d..000000000 --- a/Assets/Docs/objects/Vector3.md +++ /dev/null @@ -1,216 +0,0 @@ -# Vector3 -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|X|float|False|X component of the vector.| -|Y|float|False|Y component of the vector.| -|Z|float|False|Z component of the vector.| -|Normalized|[Vector3](../objects/Vector3.md)|False|Returns this vector with a magnitude of 1 (Read Only).| -|Magnitude|float|False|Returns the length of this vector (Read Only).| -|SqrMagnitude|float|False|Returns the squared length of this vector (Read Only).| -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Zero|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(0, 0, 0).| -|One|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(1, 1, 1).| -|Up|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(0, 1, 0).| -|Down|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(0, -1, 0).| -|Left|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(-1, 0, 0).| -|Right|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(1, 0, 0).| -|Forward|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(0, 0, 1).| -|Back|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(0, 0, -1).| -|NegativeInfinity|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity).| -|PositiveInfinity|[Vector3](../objects/Vector3.md)|False|Shorthand for writing Vector3(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity).| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Set(x : float,y : float,z : float)noneSet x, y and z components of an existing Vector3.
Scale(scale : Object)[Vector3](../objects/Vector3.md)Returns the Vector3 multiplied by scale.
Multiply(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Returns the multiplication of two Vector3s.
Divide(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Returns the division of two Vector3s.
GetRotationDirection(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Gets the relational Vector3 "b" using "a" as a reference. This is equivalent to setting MapObject.Forward to Vector "a", and finding the relative "b" vector.
\_\_Copy\_\_()ObjectOverride to deepcopy object on assignment, used for structs. Ex: copy = original is equivalent to copy = original.\_\_Copy\_\_()
\_\_Add\_\_(self : Object,other : Object)ObjectOverride to implement addition, used for + operator. Ex: a + b is equivalent to a.\_\_Add\_\_(a, b)
\_\_Sub\_\_(self : Object,other : Object)ObjectOverride to implement subtraction, used for - operator. Ex: a - b is equivalent to a.\_\_Sub\_\_(a, b)
\_\_Mul\_\_(self : Object,other : Object)ObjectOverride to implement multiplication, used for * operator. Ex: a * b is equivalent to a.\_\_Mul\_\_(a, b)
\_\_Div\_\_(self : Object,other : Object)ObjectOverride to implement division, used for / operator. Ex: a / b is equivalent to a.\_\_Div\_\_(a, b)
\_\_Eq\_\_(self : Object,other : Object)boolOverride to implement equality comparison, used for == and != operators. Ex: a == b is equivalent to a.\_\_Eq\_\_(a, b)
\_\_Hash\_\_()intOverride to implement hashing, used for GetHashCode - Used for Dictionaries/Sets. Ex: hash = obj.GetHashCode() is equivalent to hash = obj.\_\_Hash\_\_()
-## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Angle(from : [Vector3](../objects/Vector3.md),to : [Vector3](../objects/Vector3.md))floatCalculates the angle between vectors from and.
ClampMagnitude(vector : [Vector3](../objects/Vector3.md),maxLength : float)[Vector3](../objects/Vector3.md)Returns a copy of vector with its magnitude clamped to maxLength.
Cross(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Cross Product of two vectors.
Distance(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))floatReturns the distance between a and b.
Dot(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))floatDot Product of two vectors.
Lerp(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md),t : float)[Vector3](../objects/Vector3.md)Linearly interpolates between two points.
LerpUnclamped(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md),t : float)[Vector3](../objects/Vector3.md)Linearly interpolates between two vectors.
Max(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Returns a vector that is made from the largest components of two vectors.
Min(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Returns a vector that is made from the smallest components of two vectors.
MoveTowards(current : [Vector3](../objects/Vector3.md),target : [Vector3](../objects/Vector3.md),maxDistanceDelta : float)[Vector3](../objects/Vector3.md)Calculate a position between the points specified by current and target, moving no farther than the distance specified by maxDistanceDelta.
Normalize(value : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Makes this vector have a magnitude of 1.
OrthoNormalize(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))none
Project(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Projects a vector onto another vector.
ProjectOnPlane(vector : [Vector3](../objects/Vector3.md),plane : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Projects a vector onto a plane defined by a normal orthogonal to the plane.
Reflect(inDirection : [Vector3](../objects/Vector3.md),inNormal : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Reflects a vector off the plane defined by a normal.
RotateTowards(current : [Vector3](../objects/Vector3.md),target : [Vector3](../objects/Vector3.md),maxRadiansDelta : float,maxMagnitudeDelta : float)[Vector3](../objects/Vector3.md)Rotates a vector current towards target.
SignedAngle(from : [Vector3](../objects/Vector3.md),to : [Vector3](../objects/Vector3.md),axis : [Vector3](../objects/Vector3.md))floatCalculates the signed angle between vectors from and to in relation to axis.
Slerp(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md),t : float)[Vector3](../objects/Vector3.md)Spherically interpolates between two vectors.
SlerpUnclamped(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md),t : float)[Vector3](../objects/Vector3.md)Spherically interpolates between two vectors.
SmoothDamp(current : [Vector3](../objects/Vector3.md),target : [Vector3](../objects/Vector3.md),currentVelocity : [Vector3](../objects/Vector3.md),smoothTime : float,maxSpeed : float)[Vector3](../objects/Vector3.md)
diff --git a/Assets/Docs/objects/Vector3.md.meta b/Assets/Docs/objects/Vector3.md.meta deleted file mode 100644 index 51dc93388..000000000 --- a/Assets/Docs/objects/Vector3.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: dc05bc094dfcbde408f3a0a9624a5603 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static.meta b/Assets/Docs/static.meta deleted file mode 100644 index 698d4b0f6..000000000 --- a/Assets/Docs/static.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: 6194475bea13abf4da1256a58415af1d -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Camera.md b/Assets/Docs/static/Camera.md deleted file mode 100644 index 5146f657a..000000000 --- a/Assets/Docs/static/Camera.md +++ /dev/null @@ -1,76 +0,0 @@ -# Camera -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsManual|bool|False|Is camera in manual mode.| -|Position|[Vector3](../objects/Vector3.md)|False|Position of the camera.| -|Rotation|[Vector3](../objects/Vector3.md)|False|Rotation of the camera.| -|Velocity|[Vector3](../objects/Vector3.md)|False|Velocity of the camera.| -|FOV|float|False|Field of view of the camera.| -|CameraMode|[String](../static/String.md)|False|Current camera mode.| -|Forward|[Vector3](../objects/Vector3.md)|False|Forward vector of the camera.| -|Right|[Vector3](../objects/Vector3.md)|False|Right vector of the camera.| -|Up|[Vector3](../objects/Vector3.md)|False|Up vector of the camera.| -|FollowDistance|float|False|Distance from the camera to the character.| -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
SetManual(manual : bool)noneSets the camera manual mode. If true, camera will only be controlled by custom logic. If false, camera will follow the spawned or spectated player and read input.
SetPosition(position : [Vector3](../objects/Vector3.md))noneSets camera position.
SetRotation(rotation : [Vector3](../objects/Vector3.md))noneSets camera rotation.
SetVelocity(velocity : [Vector3](../objects/Vector3.md))noneSets camera velocity.
LookAt(position : [Vector3](../objects/Vector3.md))noneSets the camera forward direction such that it is looking at a world position.
SetFOV(fov : float)noneSets the camera field of view. Use 0 to use the default field of view.
SetCameraMode(mode : [String](../static/String.md))noneForces the player to use a certain camera mode, taking priority over their camera setting. Accepted values are TPS, Original, FPS.
ResetDistance()noneResets the follow distance to player's settings.
ResetCameraMode()noneResets the camera mode to player's settings.
diff --git a/Assets/Docs/static/Camera.md.meta b/Assets/Docs/static/Camera.md.meta deleted file mode 100644 index 33582db36..000000000 --- a/Assets/Docs/static/Camera.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 9b0a821a3702dbc4b95a0194d9f1d18e -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Convert.md b/Assets/Docs/static/Convert.md deleted file mode 100644 index 1e302a314..000000000 --- a/Assets/Docs/static/Convert.md +++ /dev/null @@ -1,93 +0,0 @@ -# Convert -Inherits from object -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
ToFloat(value : Object)floatConverts a value to a float
ToInt(value : Object)intConverts a value to an int
ToBool(value : Object)boolConverts a value to a bool
ToString(value : Object)[String](../static/String.md)Converts a value to a string
IsFloat(value : Object)boolChecks if the value is a float
IsInt(value : Object)boolChecks if the value is an int
IsBool(value : Object)boolChecks if the value is a bool
IsString(value : Object)boolChecks if the value is a string
IsObject(value : Object)boolChecks if the value is an object
IsList(value : Object)boolChecks if the value is a list
IsDict(value : Object)boolChecks if the value is a dictionary
HasVariable(cInstance : CustomLogicClassInstance,variableName : [String](../static/String.md))boolChecks if the class instance has a variable
DefineVariable(cInstance : CustomLogicClassInstance,variableName : [String](../static/String.md),value : Object)noneDefines a variable for the class instance
RemoveVariable(cInstance : CustomLogicClassInstance,variableName : [String](../static/String.md))noneRemoves a variable from the class instance
GetType(cInstance : CustomLogicClassInstance)[String](../static/String.md)Gets the type of the class instance
diff --git a/Assets/Docs/static/Convert.md.meta b/Assets/Docs/static/Convert.md.meta deleted file mode 100644 index 039d4c9f2..000000000 --- a/Assets/Docs/static/Convert.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b435cd0cd75560c45860c58b9062d60a -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Cutscene.md b/Assets/Docs/static/Cutscene.md deleted file mode 100644 index c235503e0..000000000 --- a/Assets/Docs/static/Cutscene.md +++ /dev/null @@ -1,38 +0,0 @@ -# Cutscene -Inherits from object -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Start(name : [String](../static/String.md),full : bool)noneStart a cutscene
ShowDialogue(icon : [String](../static/String.md),title : [String](../static/String.md),content : [String](../static/String.md))noneShow a dialogue box
ShowDialogueForTime(icon : [String](../static/String.md),title : [String](../static/String.md),content : [String](../static/String.md),time : float)noneShow a dialogue box for a certain amount of time
HideDialogue()noneHide the dialogue box
diff --git a/Assets/Docs/static/Cutscene.md.meta b/Assets/Docs/static/Cutscene.md.meta deleted file mode 100644 index d2dba34cc..000000000 --- a/Assets/Docs/static/Cutscene.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 071a2ae3c1eaf024cb77aa683ce0b498 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Game.md b/Assets/Docs/static/Game.md deleted file mode 100644 index dab66dd4b..000000000 --- a/Assets/Docs/static/Game.md +++ /dev/null @@ -1,185 +0,0 @@ -# Game -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsEnding|bool|False|Is the game ending?| -|EndTimeLeft|float|False|Time left until the game ends| -|Titans|[List](../objects/List.md)|False|List of all titans| -|AITitans|[List](../objects/List.md)|False|List of all AI titans| -|PlayerTitans|[List](../objects/List.md)|False|List of all player titans| -|Shifters|[List](../objects/List.md)|False|List of all shifters| -|AIShifters|[List](../objects/List.md)|False|List of all AI shifters| -|PlayerShifters|[List](../objects/List.md)|False|List of all player shifters| -|Humans|[List](../objects/List.md)|False|List of all humans| -|AIHumans|[List](../objects/List.md)|False|List of all AI humans| -|PlayerHumans|[List](../objects/List.md)|False|List of all player humans| -|Loadouts|[List](../objects/List.md)|False|List of all loadouts| -|DefaultShowKillScore|bool|False|Is the kill score shown by default?| -|DefaultHideKillScore|bool|False|Is the kill feed shown by default?| -|DefaultAddKillScore|bool|False|Is the kill score added by default?| -|ShowScoreboardLoadout|bool|False|Is the loadout shown in the scoreboard?| -|ShowScoreboardStatus|bool|False|Is the status shown in the scoreboard?| -|ForcedCharacterType|[String](../static/String.md)|False|Forced character type| -|ForcedLoadout|[String](../static/String.md)|False|Forced loadout| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Debug(message : Object)nonePrint a debug statement to the console
Print(message : Object)nonePrint a message to the chat
PrintAll(message : Object)nonePrint a message to all players
GetGeneralSetting(settingName : [String](../static/String.md))ObjectGet a general setting
GetTitanSetting(settingName : [String](../static/String.md))ObjectGet a titan setting
GetMiscSetting(settingName : [String](../static/String.md))ObjectGet a misc setting
End(delay : float)noneEnd the game
FindCharacterByViewID(viewID : int)[Character](../objects/Character.md)Find a character by view ID
SpawnTitan(type : [String](../static/String.md))[Titan](../objects/Titan.md)Spawn a titan
SpawnTitanAt(type : [String](../static/String.md),position : [Vector3](../objects/Vector3.md),rotationY : float = 0)[Titan](../objects/Titan.md)Spawn a titan at a position
SpawnTitans(type : [String](../static/String.md),count : int)[List](../objects/List.md)Spawn titans
SpawnTitansAsync(type : [String](../static/String.md),count : int)noneSpawn titans asynchronously
SpawnTitansAt(type : [String](../static/String.md),count : int,position : [Vector3](../objects/Vector3.md),rotationY : float = 0)[List](../objects/List.md)Spawn titans at a position
SpawnTitansAtAsync(type : [String](../static/String.md),count : int,position : [Vector3](../objects/Vector3.md),rotationY : float = 0)noneSpawn titans at a position asynchronously
SpawnShifter(type : [String](../static/String.md))[Shifter](../objects/Shifter.md)Spawn a shifter
SpawnShifterAt(type : [String](../static/String.md),position : [Vector3](../objects/Vector3.md),rotationY : float = 0)[Shifter](../objects/Shifter.md)Spawn a shifter at a position
SpawnProjectile(parameters : Object[])noneSpawn a projectile
SpawnProjectileWithOwner(parameters : Object[])noneSpawn a projectile with an owner
SpawnEffect(parameters : Object[])noneSpawn an effect
SpawnPlayer(player : [Player](../objects/Player.md),force : bool)noneSpawn a player
SpawnPlayerAll(force : bool)noneSpawn a player for all players
SpawnPlayerAt(player : [Player](../objects/Player.md),force : bool,position : [Vector3](../objects/Vector3.md),rotationY : float = 0)noneSpawn a player at a position
SpawnPlayerAtAll(force : bool,position : [Vector3](../objects/Vector3.md),rotationY : float = 0)noneSpawn a player at a position for all players
SetPlaylist(playlist : [String](../static/String.md))noneSet the music playlist
SetSong(song : [String](../static/String.md))noneSet the music song
DrawRay(start : [Vector3](../objects/Vector3.md),dir : [Vector3](../objects/Vector3.md),color : [Color](../objects/Color.md),duration : float)noneDraw a ray
ShowKillScore(damage : int)noneShow the kill score
ShowKillFeed(killer : [String](../static/String.md),victim : [String](../static/String.md),score : int,weapon : [String](../static/String.md))noneShow the kill feed
ShowKillFeedAll(killer : [String](../static/String.md),victim : [String](../static/String.md),score : int,weapon : [String](../static/String.md))noneShow the kill feed for all players
diff --git a/Assets/Docs/static/Game.md.meta b/Assets/Docs/static/Game.md.meta deleted file mode 100644 index 8c2e493b3..000000000 --- a/Assets/Docs/static/Game.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: fcf2dbe3662c0364e8ccef7b48ddab18 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Input.md b/Assets/Docs/static/Input.md deleted file mode 100644 index ca344da19..000000000 --- a/Assets/Docs/static/Input.md +++ /dev/null @@ -1,73 +0,0 @@ -# Input -Inherits from object -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
GetKeyName(key : [String](../static/String.md))[String](../static/String.md)Gets the key name the player assigned to the key setting
GetKeyHold(key : [String](../static/String.md))boolReturns true if the key is being held down
GetKeyDown(key : [String](../static/String.md))boolReturns true if the key was pressed down this frame
GetKeyUp(key : [String](../static/String.md))boolReturns true if the key was released this frame
GetMouseAim()[Vector3](../objects/Vector3.md)Returns the position the player is aiming at
GetCursorAimDirection()[Vector3](../objects/Vector3.md)Returns the ray the player is aiming at
GetMouseSpeed()[Vector3](../objects/Vector3.md)Returns the speed of the mouse
GetMousePosition()[Vector3](../objects/Vector3.md)Returns the position of the mouse
GetScreenDimensions()[Vector3](../objects/Vector3.md)Returns the dimensions of the screen
SetKeyDefaultEnabled(key : [String](../static/String.md),enabled : bool)noneSets whether the key is enabled by default
SetKeyHold(key : [String](../static/String.md),enabled : bool)noneSets whether the key is being held down
diff --git a/Assets/Docs/static/Input.md.meta b/Assets/Docs/static/Input.md.meta deleted file mode 100644 index 1f83e3ca2..000000000 --- a/Assets/Docs/static/Input.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: d60bd27d07f9bb149b74e65e2c0fa1a4 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Json.md b/Assets/Docs/static/Json.md deleted file mode 100644 index d0398a071..000000000 --- a/Assets/Docs/static/Json.md +++ /dev/null @@ -1,28 +0,0 @@ -# Json -Inherits from object -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
LoadFromString(json : [String](../static/String.md))ObjectLoads a json string into a custom logic object
SaveToString(obj : Object)[String](../static/String.md)Saves a custom logic object into a json string
diff --git a/Assets/Docs/static/Json.md.meta b/Assets/Docs/static/Json.md.meta deleted file mode 100644 index 604bd7521..000000000 --- a/Assets/Docs/static/Json.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7767b6f84e6225547a5319b11f266636 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Map.md b/Assets/Docs/static/Map.md deleted file mode 100644 index 960c87906..000000000 --- a/Assets/Docs/static/Map.md +++ /dev/null @@ -1,88 +0,0 @@ -# Map -Inherits from object -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
FindAllMapObjects()[List](../objects/List.md)Find all map objects
FindMapObjectByName(objectName : [String](../static/String.md))[MapObject](../objects/MapObject.md)Find a map object by name
FindMapObjectsByName(objectName : [String](../static/String.md))[List](../objects/List.md)Find all map objects by name
FindMapObjectByComponent(className : [String](../static/String.md))[MapObject](../objects/MapObject.md)Find all map objects by component
FindMapObjectsByComponent(className : [String](../static/String.md))[List](../objects/List.md)Find all map objects by component
FindMapObjectByID(id : int)[MapObject](../objects/MapObject.md)Find a map object by ID
FindMapObjectByTag(tag : [String](../static/String.md))[MapObject](../objects/MapObject.md)Find a map object by tag
FindMapObjectsByTag(tag : [String](../static/String.md))[List](../objects/List.md)Find all map objects by tag
CreateMapObjectRaw(prefab : [String](../static/String.md))[MapObject](../objects/MapObject.md)Create a new map object
DestroyMapObject(mapObject : [MapObject](../objects/MapObject.md),includeChildren : bool)noneDestroy a map object
CopyMapObject(mapObject : [MapObject](../objects/MapObject.md),includeChildren : bool)[MapObject](../objects/MapObject.md)Copy a map object
DestroyMapTargetable(targetable : [MapTargetable](../objects/MapTargetable.md))noneDestroy a map targetable
UpdateNavMesh()noneUpdate the nav mesh
UpdateNavMeshAsync()noneUpdate the nav mesh asynchronously
diff --git a/Assets/Docs/static/Map.md.meta b/Assets/Docs/static/Map.md.meta deleted file mode 100644 index c5cdaca7e..000000000 --- a/Assets/Docs/static/Map.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 7866b2133c935a94a876afd395426d64 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Math.md b/Assets/Docs/static/Math.md deleted file mode 100644 index 10f222037..000000000 --- a/Assets/Docs/static/Math.md +++ /dev/null @@ -1,217 +0,0 @@ -# Math -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|PI|float|False|The value of PI| -|Infinity|float|False|The value of Infinity| -|NegativeInfinity|float|False|The value of Negative Infinity| -|Rad2DegConstant|float|False|The value of Rad2Deg constant| -|Deg2RadConstant|float|False|The value of Deg2Rad constant| -|Epsilon|float|False|The value of Epsilon| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
Clamp(value : Object,min : Object,max : Object)ObjectClamp a value between a minimum and maximum value
Max(a : Object,b : Object)ObjectGet the maximum of two values
Min(a : Object,b : Object)ObjectGet the minimum of two values
Pow(a : Object,b : Object)ObjectRaise a value to the power of another value
Abs(value : Object)ObjectGet the absolute value of a number
Sqrt(value : Object)ObjectGet the square root of a number
Mod(a : Object,b : Object)ObjectGet the remainder of a division operation
Sin(angle : Object)ObjectGet the sine of an angle in degrees
Cos(angle : Object)ObjectGet the cosine of an angle in degrees
Tan(angle : Object)ObjectGet the tangent of an angle in degrees
Asin(value : Object)ObjectGet the arcsine of a value in degrees
Acos(value : Object)ObjectGet the arccosine of a value in degrees
Atan(value : Object)ObjectGet the arctangent of a value in degrees
Atan2(a : Object,b : Object)ObjectGet the arctangent of a value in degrees
Ceil(value : Object)ObjectGet the smallest integer greater than or equal to a value
Floor(value : Object)ObjectGet the largest integer less than or equal to a value
Round(value : Object)ObjectRound a value to the nearest integer
Deg2Rad(angle : Object)ObjectConvert an angle from degrees to radians
Rad2Deg(angle : Object)ObjectConvert an angle from radians to degrees
Lerp(a : Object,b : Object,t : Object)ObjectLinearly interpolate between two values
LerpUnclamped(a : Object,b : Object,t : Object)ObjectLinearly interpolate between two values without clamping
Sign(value : Object)ObjectGet the sign of a value
InverseLerp(a : Object,b : Object,value : Object)ObjectGet the inverse lerp of two values
LerpAngle(a : Object,b : Object,t : Object)ObjectLinearly interpolate between two angles
Log(value : Object)ObjectGet the natural logarithm of a value
MoveTowards(current : Object,target : Object,maxDelta : Object)ObjectMove a value towards a target value
MoveTowardsAngle(current : Object,target : Object,maxDelta : Object)ObjectMove an angle towards a target angle
PingPong(t : Object,length : Object)ObjectGet the ping pong value of a time value
SmoothDamp(current : Object,target : Object,currentVelocity : Object,smoothTime : Object,maxSpeed : Object,deltaTime : Object)ObjectSmoothly damp a value towards a target value
Exp(value : Object)ObjectGet the exponential value of a number
SmoothDampAngle(current : Object,target : Object,currentVelocity : Object,smoothTime : Object,maxSpeed : Object,deltaTime : Object)ObjectSmoothly damp an angle towards a target angle
SmoothStep(a : Object,b : Object,t : Object)ObjectSmoothly step between two values
BitwiseAnd(a : Object,b : Object)ObjectPerform a bitwise AND operation
BitwiseOr(a : Object,b : Object)ObjectPerform a bitwise OR operation
BitwiseXor(a : Object,b : Object)ObjectPerform a bitwise XOR operation
BitwiseNot(value : Object)ObjectPerform a bitwise NOT operation
BitwiseLeftShift(value : Object,shift : Object)ObjectShift bits to the left
BitwiseRightShift(value : Object,shift : Object)ObjectShift bits to the right
diff --git a/Assets/Docs/static/Math.md.meta b/Assets/Docs/static/Math.md.meta deleted file mode 100644 index 99ebb0cd9..000000000 --- a/Assets/Docs/static/Math.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 2e6c4c5837bc96448a07828ae0c6359c -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Network.md b/Assets/Docs/static/Network.md deleted file mode 100644 index b82578a17..000000000 --- a/Assets/Docs/static/Network.md +++ /dev/null @@ -1,52 +0,0 @@ -# Network -Inherits from object -## Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|IsMasterClient|bool|False|Is the player the master client| -|Players|[List](../objects/List.md)|False|The list of players in the room| -|MasterClient|[Player](../objects/Player.md)|False|The master client| -|MyPlayer|[Player](../objects/Player.md)|False|The local player| -|NetworkTime|double|False|The network time| -|Ping|int|False|The local player's ping| -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
SendMessage(player : [Player](../objects/Player.md),message : [String](../static/String.md))noneSend a message to a player
SendMessageAll(message : [String](../static/String.md))noneSend a message to all players
SendMessageOthers(message : [String](../static/String.md))noneSend a message to all players except the sender
GetTimestampDifference(timestamp1 : double,timestamp2 : double)doubleGet the difference between two photon timestamps
KickPlayer(target : Object,reason : [String](../static/String.md) = .)noneKick the given player by id or player reference.
diff --git a/Assets/Docs/static/Network.md.meta b/Assets/Docs/static/Network.md.meta deleted file mode 100644 index 5b5475846..000000000 --- a/Assets/Docs/static/Network.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 37dc7beaa31705f43815ab92667b2ed8 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/PersistentData.md b/Assets/Docs/static/PersistentData.md deleted file mode 100644 index c5120a2b8..000000000 --- a/Assets/Docs/static/PersistentData.md +++ /dev/null @@ -1,53 +0,0 @@ -# PersistentData -Inherits from object -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
SetProperty(property : [String](../static/String.md),value : Object)noneSets the property with given name to the object value. Valid value types are float, string, bool, and int.
GetProperty(property : [String](../static/String.md),defaultValue : Object)ObjectGets the property with given name. If property does not exist, returns defaultValue.
LoadFromFile(fileName : [String](../static/String.md),encrypted : bool)noneLoads persistent data from given file name. If encrypted is true, will treat the file as having been saved as encrypted.
SaveToFile(fileName : [String](../static/String.md),encrypted : bool)noneSaves current persistent data to given file name. If encrypted is true, will also encrypt the file instead of using plaintext.
Clear()noneClears current persistent data.
IsValidFileName(fileName : [String](../static/String.md))boolDetermines whether or not the given fileName will be allowed for use when saving/loading a file.
FileExists(fileName : [String](../static/String.md))boolDetermines whether the file given already exists. Throws an error if given an invalid file name.
diff --git a/Assets/Docs/static/PersistentData.md.meta b/Assets/Docs/static/PersistentData.md.meta deleted file mode 100644 index 0cb48c44d..000000000 --- a/Assets/Docs/static/PersistentData.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 62c9002128c5f9e4ca20d82630ea2006 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/README.md b/Assets/Docs/static/README.md deleted file mode 100644 index 1a09b9e94..000000000 --- a/Assets/Docs/static/README.md +++ /dev/null @@ -1 +0,0 @@ -# Static \ No newline at end of file diff --git a/Assets/Docs/static/README.md.meta b/Assets/Docs/static/README.md.meta deleted file mode 100644 index 08cf3add4..000000000 --- a/Assets/Docs/static/README.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 62cf625ee331c1c48a8913c362d7d85b -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Random.md b/Assets/Docs/static/Random.md deleted file mode 100644 index 941fd8544..000000000 --- a/Assets/Docs/static/Random.md +++ /dev/null @@ -1,53 +0,0 @@ -# Random -Inherits from object -## Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
RandomInt(min : int,max : int)intGenerates a random integer between the specified range.
RandomFloat(min : float,max : float)floatGenerates a random float between the specified range.
RandomBool()boolReturns random boolean.
RandomVector3(a : [Vector3](../objects/Vector3.md),b : [Vector3](../objects/Vector3.md))[Vector3](../objects/Vector3.md)Generates a random Vector3 between the specified ranges.
RandomDirection(flat : bool = False)[Vector3](../objects/Vector3.md)Generates a random normalized direction vector. If flat is true, the y component will be zero.
RandomSign()intGenerates a random sign, either 1 or -1.
PerlinNoise(x : float,y : float)floatReturns a point sampled from generated 2d perlin noise. (see Unity Mathf.PerlinNoise for more information)
diff --git a/Assets/Docs/static/Random.md.meta b/Assets/Docs/static/Random.md.meta deleted file mode 100644 index 8d1c274bc..000000000 --- a/Assets/Docs/static/Random.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 3029902b259029c479682165353b9e35 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/RoomData.md b/Assets/Docs/static/RoomData.md deleted file mode 100644 index a4360fea5..000000000 --- a/Assets/Docs/static/RoomData.md +++ /dev/null @@ -1,33 +0,0 @@ -# RoomData -Inherits from object -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
SetProperty(property : [String](../static/String.md),value : Object)noneSets the property with given name to the object value. Valid value types are float, string, bool, and int.
GetProperty(property : [String](../static/String.md),defaultValue : Object)ObjectGets the property with given name. If property does not exist, returns defaultValue.
Clear()noneClears all room data.
diff --git a/Assets/Docs/static/RoomData.md.meta b/Assets/Docs/static/RoomData.md.meta deleted file mode 100644 index 8b2044d0e..000000000 --- a/Assets/Docs/static/RoomData.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: c72e78ebaecf7804c85a5bc8bfe16a76 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/String.md b/Assets/Docs/static/String.md deleted file mode 100644 index 564f7780b..000000000 --- a/Assets/Docs/static/String.md +++ /dev/null @@ -1,107 +0,0 @@ -# String -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|Newline|[String](../static/String.md)|False|Returns the newline character.| -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
FormatFloat(val : float,decimals : int)[String](../static/String.md)Formats a float to a string with the specified number of decimal places.
FormatFromList(str : [String](../static/String.md),list : [List](../objects/List.md))[String](../static/String.md)Equivalent to C# string.format(string, List).
Split(toSplit : [String](../static/String.md),splitter : Object,removeEmptyEntries : bool = False)[List](../objects/List.md)Split the string into a list. Can pass in either a string to split on or a list of strings to split on, the last optional param can remove all empty entries.
Join(list : [List](../objects/List.md),separator : [String](../static/String.md))[String](../static/String.md)Joins a list of strings into a single string with the specified separator.
Substring(str : [String](../static/String.md),startIndex : int)[String](../static/String.md)Returns a substring starting from the specified index.
SubstringWithLength(str : [String](../static/String.md),startIndex : int,length : int)[String](../static/String.md)Returns a substring of the specified length starting from the specified start index.
Length(str : [String](../static/String.md))intLength of the string.
Replace(str : [String](../static/String.md),replace : [String](../static/String.md),with : [String](../static/String.md))[String](../static/String.md)Replaces all occurrences of a substring with another substring.
Contains(str : [String](../static/String.md),match : [String](../static/String.md))boolChecks if the string contains the specified substring.
StartsWith(str : [String](../static/String.md),match : [String](../static/String.md))boolChecks if the string starts with the specified substring.
EndsWith(str : [String](../static/String.md),match : [String](../static/String.md))boolChecks if the string ends with the specified substring.
Trim(str : [String](../static/String.md))[String](../static/String.md)Trims whitespace from the start and end of the string.
Insert(str : [String](../static/String.md),insert : [String](../static/String.md),index : int)[String](../static/String.md)Inserts a substring at the specified index.
Capitalize(str : [String](../static/String.md))[String](../static/String.md)Capitalizes the first letter of the string.
ToUpper(str : [String](../static/String.md))[String](../static/String.md)Converts the string to uppercase.
ToLower(str : [String](../static/String.md))[String](../static/String.md)Converts the string to lowercase.
IndexOf(str : [String](../static/String.md),substring : [String](../static/String.md))intReturns the index of the given string.
diff --git a/Assets/Docs/static/String.md.meta b/Assets/Docs/static/String.md.meta deleted file mode 100644 index 081065c8e..000000000 --- a/Assets/Docs/static/String.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: 5f663793e088e85419f66dfa770fc035 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/Time.md b/Assets/Docs/static/Time.md deleted file mode 100644 index 764e9a19c..000000000 --- a/Assets/Docs/static/Time.md +++ /dev/null @@ -1,9 +0,0 @@ -# Time -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|TickTime|float|False|Time between each tick (0.02 seconds)| -|FrameTime|float|False|Time between each frame.| -|GameTime|float|False|Time since start of the round.| -|TimeScale|float|False|Changes the timescale of the game.| diff --git a/Assets/Docs/static/Time.md.meta b/Assets/Docs/static/Time.md.meta deleted file mode 100644 index 54e1f53cf..000000000 --- a/Assets/Docs/static/Time.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: b5c0cb264e5ab4d42bb118d66da8bfef -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Docs/static/UI.md b/Assets/Docs/static/UI.md deleted file mode 100644 index 66f16c4c8..000000000 --- a/Assets/Docs/static/UI.md +++ /dev/null @@ -1,131 +0,0 @@ -# UI -Inherits from object -## Static Fields -|Field|Type|Readonly|Description| -|---|---|---|---| -|TopCenter|[String](../static/String.md)|False|"TopCenter" constant| -|TopLeft|[String](../static/String.md)|False|"TopLeft" constant| -|TopRight|[String](../static/String.md)|False|"TopRight" constant| -|MiddleCenter|[String](../static/String.md)|False|"MiddleCenter" constant| -|MiddleLeft|[String](../static/String.md)|False|"MiddleLeft" constant| -|MiddleRight|[String](../static/String.md)|False|"MiddleRight" constant| -|BottomCenter|[String](../static/String.md)|False|"BottomCenter" constant| -|BottomLeft|[String](../static/String.md)|False|"BottomLeft" constant| -|BottomRight|[String](../static/String.md)|False|"BottomRight" constant| -|Popups|[List](../objects/List.md)|False|Returns a list of all popups| -## Static Methods - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FunctionReturnsDescription
SetLabel(label : [String](../static/String.md),message : [String](../static/String.md))noneSets the label at a certain location. Valid types: "TopCenter", "TopLeft", "TopRight", "MiddleCenter", "MiddleLeft", "MiddleRight", "BottomLeft", "BottomRight", "BottomCenter".
SetLabelForTime(label : [String](../static/String.md),message : [String](../static/String.md),time : float)noneSets the label for a certain time, after which it will be cleared.
SetLabelAll(label : [String](../static/String.md),message : [String](../static/String.md))noneSets the label for all players. Master client only. Be careful not to call this often.
SetLabelForTimeAll(label : [String](../static/String.md),message : [String](../static/String.md),time : float)noneSets the label for all players for a certain time. Master client only.
CreatePopup(popupName : [String](../static/String.md),title : [String](../static/String.md),width : int,height : int)[String](../static/String.md)Creates a new popup. This popup is hidden until shown.
ShowPopup(popupName : [String](../static/String.md))noneShows the popup with given name.
HidePopup(popupName : [String](../static/String.md))noneHides the popup with given name.
ClearPopup(popupName : [String](../static/String.md))noneClears all elements in popup with given name.
AddPopupLabel(popupName : [String](../static/String.md),label : [String](../static/String.md))noneAdds a text row to the popup with label as content.
AddPopupButton(popupName : [String](../static/String.md),label : [String](../static/String.md),callback : [String](../static/String.md))noneAdds a button row to the popup with given button name and display text. When button is pressed, OnButtonClick is called in Main with buttonName parameter.
AddPopupBottomButton(popupName : [String](../static/String.md),label : [String](../static/String.md),callback : [String](../static/String.md))noneAdds a button to the bottom bar of the popup.
AddPopupButtons(popupName : [String](../static/String.md),labels : [List](../objects/List.md),callbacks : [List](../objects/List.md))noneAdds a list of buttons in a row to the popup.
WrapStyleTag(text : [String](../static/String.md),style : [String](../static/String.md),arg : [String](../static/String.md) = )[String](../static/String.md)Returns a wrapped string given style and args.
GetLocale(cat : [String](../static/String.md),sub : [String](../static/String.md),key : [String](../static/String.md))[String](../static/String.md)Gets translated locale from the current Language.json file with given category, subcategory, and key pattern.
GetLanguage()[String](../static/String.md)Returns the current language (e.g. "English" or "简体中文").
ShowChangeCharacterMenu()noneShows the change character menu if main character is Human.
SetScoreboardHeader(header : [String](../static/String.md))noneSets the display of the scoreboard header (default "Kills / Deaths...")
SetScoreboardProperty(property : [String](../static/String.md))noneSets which Player custom property to read from to display on the scoreboard. If set to empty string, will use the default "Kills / Deaths..." display.
GetThemeColor(panel : [String](../static/String.md),category : [String](../static/String.md),item : [String](../static/String.md))[Color](../objects/Color.md)Gets the color of the specified item. See theme json for reference.
IsPopupActive(popupName : [String](../static/String.md))boolReturns if the given popup is active
diff --git a/Assets/Docs/static/UI.md.meta b/Assets/Docs/static/UI.md.meta deleted file mode 100644 index 61f746d42..000000000 --- a/Assets/Docs/static/UI.md.meta +++ /dev/null @@ -1,7 +0,0 @@ -fileFormatVersion: 2 -guid: fa675e87b83b40441b54332833e890f1 -TextScriptImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Assets/Scripts/Editor/GenerateCLDocs.cs b/Assets/Scripts/Editor/GenerateCLDocs.cs index eeb14a17e..e827ff041 100644 --- a/Assets/Scripts/Editor/GenerateCLDocs.cs +++ b/Assets/Scripts/Editor/GenerateCLDocs.cs @@ -57,7 +57,7 @@ public void OnGUI() if (GUILayout.Button("Generate Docs")) { // Generate docs in the project folder/Docs - GenerateDocs("Assets/Docs"); + GenerateDocs("Docs/"); } }