Skip to content

Commit c4bf7fb

Browse files
Add page describing marks.clone. (#580)
* Added marks.clone page. * Added reference in marks system guide page. * Correcting marks.clone page title. How's about we use the correct title this time? :D Co-authored-by: matr1x <[email protected]> --------- Co-authored-by: matr1x <[email protected]>
1 parent 5895040 commit c4bf7fb

File tree

2 files changed

+105
-0
lines changed

2 files changed

+105
-0
lines changed

docs/guides/new_players/marks.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,4 @@ Documentation for ((%Qmark%))-related Trust scripts are available below:
5959
- [[marks.protocol:((marks.protocol))]]
6060
- [[marks.available:((marks.available))]]
6161
- [[marks.sync:((marks.sync))]]
62+
- [[marks.clone:((marks.clone))]]
Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: marks.clone
3+
description: "Get marks between users."
4+
---
5+
6+
((marks.clone)) allows you to acquire a mark you've gotten on another user, without needing to meet mark criteria.
7+
8+
### Security Level
9+
10+
NULLSEC
11+
12+
## Syntax
13+
14+
### CLI
15+
16+
```
17+
marks.cone {name:"init"}
18+
```
19+
20+
### Script
21+
22+
```
23+
#ns.marks.clone({name:"init"})
24+
```
25+
26+
### Parameters
27+
28+
#### name (required)
29+
30+
The ((%Nname%)) parameter is the name of the mark you want to clone to the current user.
31+
32+
### Return
33+
34+
Returns a script response object, with varying messages on failure.
35+
36+
#### CLI
37+
38+
##### Normal mark
39+
40+
```
41+
>>marks.clone {name:"example_mark"}
42+
Success
43+
44+
Mark :::example_mark:: earned.
45+
46+
view further training with marks.available
47+
view completed mark with marks.protocol { name: "example_mark" }
48+
```
49+
50+
##### Hidden mark
51+
52+
```
53+
>>marks.clone {name:"example_mark"}
54+
Success
55+
56+
mark :::example_mark:: has been hidden
57+
58+
view further training with marks.available
59+
view completed mark with marks.protocol { name: "example_mark" }
60+
```
61+
62+
##### Unobtained mark
63+
64+
```
65+
>>marks.clone {name:"example_mark"}
66+
Failure
67+
this mark has not been earned on any of your users
68+
```
69+
70+
##### Already present mark
71+
72+
```
73+
>>marks.clone {name:"example_mark"}
74+
Failure
75+
you have already earned this mark on this user
76+
```
77+
78+
#### Script
79+
80+
##### Success
81+
82+
```
83+
{
84+
ok: true
85+
}
86+
```
87+
88+
##### Unobtained
89+
90+
```
91+
{
92+
ok: false,
93+
msg: "this mark has not been earned on any of your users"
94+
}
95+
```
96+
97+
##### Already present
98+
99+
```
100+
{
101+
ok: false,
102+
msg: "you have already earned this mark on this user"
103+
}
104+
```

0 commit comments

Comments
 (0)